Sign upLogin

django/django

View on GitHub
Star
docs/_ext/djangodocs.py

Summary

Maintainability
D
2 days
Test Coverage

Function run has a Cognitive Complexity of 42 (exceeds 5 allowed). Consider refactoring.
Open

    def run(self):
        def args_to_win(cmdline):
            changed = False
            out = []
            for token in cmdline.split():
Severity: Minor
Found in docs/_ext/djangodocs.py - About 6 hrs to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

File djangodocs.py has 322 lines of code (exceeds 250 allowed). Consider refactoring.
Open

"""
Sphinx plugins for Django documentation.
"""

import json
Severity: Minor
Found in docs/_ext/djangodocs.py - About 3 hrs to fix

    Function default_role_error has 7 arguments (exceeds 4 allowed). Consider refactoring.
    Open

    def default_role_error(
    Severity: Major
    Found in docs/_ext/djangodocs.py - About 50 mins to fix

      Function html_page_context_hook has 5 arguments (exceeds 4 allowed). Consider refactoring.
      Open

      def html_page_context_hook(app, pagename, templatename, context, doctree):
      Severity: Minor
      Found in docs/_ext/djangodocs.py - About 35 mins to fix

        Avoid too many return statements within this function.
        Open

                        return args_to_win(line[2:])
        Severity: Major
        Found in docs/_ext/djangodocs.py - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

                          return args_to_win(line[4:])
          Severity: Major
          Found in docs/_ext/djangodocs.py - About 30 mins to fix

            Avoid too many return statements within this function.
            Open

                            return "py " + args_to_win(line[8:])
            Severity: Major
            Found in docs/_ext/djangodocs.py - About 30 mins to fix

              Avoid too many return statements within this function.
              Open

                          return None
              Severity: Major
              Found in docs/_ext/djangodocs.py - About 30 mins to fix

                Avoid too many return statements within this function.
                Open

                                return "py " + args_to_win(line[9:])
                Severity: Major
                Found in docs/_ext/djangodocs.py - About 30 mins to fix

                  Avoid too many return statements within this function.
                  Open

                                  return "runtests.py " + args_to_win(line[15:])
                  Severity: Major
                  Found in docs/_ext/djangodocs.py - About 30 mins to fix

                    Similar blocks of code found in 2 locations. Consider refactoring.
                    Open

                                    n
                for ((t, n), (k, a)) in xrefs.items()
                if t == "templatefilter" and k == "ref/templates/builtins"
                    Severity: Major
                    Found in docs/_ext/djangodocs.py and 1 other location - About 1 hr to fix
                    docs/_ext/djangodocs.py on lines 207..209

                    Duplicated Code

                    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

                    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

                    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

                    Tuning

                    This issue has a mass of 41.

                    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

                    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

                    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

                    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

                    Refactorings

                    Further Reading

                    Similar blocks of code found in 2 locations. Consider refactoring.
                    Open

                                    n
                for ((t, n), (k, a)) in xrefs.items()
                if t == "templatetag" and k == "ref/templates/builtins"
                    Severity: Major
                    Found in docs/_ext/djangodocs.py and 1 other location - About 1 hr to fix
                    docs/_ext/djangodocs.py on lines 212..214

                    Duplicated Code

                    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

                    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

                    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

                    Tuning

                    This issue has a mass of 41.

                    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

                    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

                    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

                    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

                    Refactorings

                    Further Reading

                    There are no issues that match your filters.

                    Category
                    Status