Sign upLogin

errbotio/errbot

View on GitHub
Star
errbot/core_plugins/help.py

Summary

Maintainability
D
1 day
Test Coverage

Function help has a Cognitive Complexity of 56 (exceeds 5 allowed). Consider refactoring.
Open

    def help(self, msg, args):
        """Returns a help string listing available options.
        Automatically assigned to the "help" command."""

        def may_access_command(m, cmd):
Severity: Minor
Found in errbot/core_plugins/help.py - About 1 day 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

Function apropos has a Cognitive Complexity of 19 (exceeds 5 allowed). Consider refactoring.
Open

    def apropos(self, msg, args):
        """Returns a help string listing available options.

        Automatically assigned to the "help" command."""
        if not args:
Severity: Minor
Found in errbot/core_plugins/help.py - About 2 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

Avoid deeply nested control flow statements.
Open

                        if not may_access_command(msg, name):
                            continue
                    pairs.append((name, command))
Severity: Major
Found in errbot/core_plugins/help.py - About 45 mins to fix

    Avoid deeply nested control flow statements.
    Open

                            if command._err_command_hidden:
                            continue
    Severity: Major
    Found in errbot/core_plugins/help.py - About 45 mins to fix

      Function _cmd_help_line has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
      Open

          def _cmd_help_line(self, name, command, show_doc=False):
        """
        Returns:
            str. a single line indicating the help representation of a command.
        """
      Severity: Minor
      Found in errbot/core_plugins/help.py - About 35 mins 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

      There are no issues that match your filters.

      Category
      Status