Sign upLogin

saltstack/salt

View on GitHub
Star
salt/beacons/napalm_beacon.py

Summary

Maintainability
F
3 days
Test Coverage

Function _compare has a Cognitive Complexity of 80 (exceeds 5 allowed). Consider refactoring.
Open

def _compare(cur_cmp, cur_struct):
    '''
    Compares two objects and return a boolean value
    when there's a match.
    '''
Severity: Minor
Found in salt/beacons/napalm_beacon.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

Cyclomatic complexity is too high in function _compare. (32)
Open

def _compare(cur_cmp, cur_struct):
    '''
    Compares two objects and return a boolean value
    when there's a match.
    '''
Severity: Minor
Found in salt/beacons/napalm_beacon.py by radon

Cyclomatic Complexity

Cyclomatic Complexity corresponds to the number of decisions a block of code contains plus 1. This number (also called McCabe number) is equal to the number of linearly independent paths through the code. This number can be used as a guide when testing conditional logic in blocks.

Radon analyzes the AST tree of a Python program to compute Cyclomatic Complexity. Statements have the following effects on Cyclomatic Complexity:

Construct Effect on CC Reasoning
if +1 An if statement is a single decision.
elif +1 The elif statement adds another decision.
else +0 The else statement does not cause a new decision. The decision is at the if.
for +1 There is a decision at the start of the loop.
while +1 There is a decision at the while statement.
except +1 Each except branch adds a new conditional path of execution.
finally +0 The finally block is unconditionally executed.
with +1 The with statement roughly corresponds to a try/except block (see PEP 343 for details).
assert +1 The assert statement internally roughly equals a conditional statement.
Comprehension +1 A list/set/dict comprehension of generator expression is equivalent to a for loop.
Boolean Operator +1 Every boolean operator (and, or) adds a decision point.

Source: http://radon.readthedocs.org/en/latest/intro.html

File napalm_beacon.py has 285 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# -*- coding: utf-8 -*-
'''
Watch NAPALM functions and fire events on specific triggers
===========================================================
Severity: Minor
Found in salt/beacons/napalm_beacon.py - About 2 hrs to fix

    Consider simplifying this complex logical expression.
    Open

        if isinstance(cur_cmp, dict) and isinstance(cur_struct, dict):
        log.debug('Comparing dict to dict')
        for cmp_key, cmp_value in six.iteritems(cur_cmp):
            if cmp_key == '*':
                # matches any key from the source dictionary
    Severity: Critical
    Found in salt/beacons/napalm_beacon.py - About 1 hr to fix

      Function beacon has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
      Open

      def beacon(config):
    '''
    Watch napalm function and fire events.
    '''
    log.debug('Executing napalm beacon with config:')
      Severity: Minor
      Found in salt/beacons/napalm_beacon.py - About 55 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

      Avoid deeply nested control flow statements.
      Open

                          for _, cur_struct_val in six.iteritems(cur_struct):
                        found |= _compare(cmp_value, cur_struct_val)
                    return found
      Severity: Major
      Found in salt/beacons/napalm_beacon.py - About 45 mins to fix

        Avoid deeply nested control flow statements.
        Open

                            if isinstance(cur_struct, (list, tuple)):
                        for cur_ele in cur_struct:
                            found |= _compare(cmp_value, cur_ele)
                    elif isinstance(cur_struct, dict):
                        for _, cur_ele in six.iteritems(cur_struct):
        Severity: Major
        Found in salt/beacons/napalm_beacon.py - About 45 mins to fix

          Avoid deeply nested control flow statements.
          Open

                              for _, cur_struct_val in six.iteritems(cur_struct):
                        found |= _compare(cmp_value, cur_struct_val)
                    return found
          Severity: Major
          Found in salt/beacons/napalm_beacon.py - About 45 mins to fix

            Avoid deeply nested control flow statements.
            Open

                                if cmp_key not in cur_struct:
                        return False
                    return _compare(cmp_value, cur_struct[cmp_key])
            Severity: Major
            Found in salt/beacons/napalm_beacon.py - About 45 mins to fix

              Avoid too many return statements within this function.
              Open

                      return False
              Severity: Major
              Found in salt/beacons/napalm_beacon.py - About 30 mins to fix

                Avoid too many return statements within this function.
                Open

                                    return found
                Severity: Major
                Found in salt/beacons/napalm_beacon.py - About 30 mins to fix

                  Avoid too many return statements within this function.
                  Open

                      return False
                  Severity: Major
                  Found in salt/beacons/napalm_beacon.py - About 30 mins to fix

                    Avoid too many return statements within this function.
                    Open

                                        return _compare(cmp_value, cur_struct[cmp_key])
                    Severity: Major
                    Found in salt/beacons/napalm_beacon.py - About 30 mins to fix

                      Avoid too many return statements within this function.
                      Open

                                  return getattr(float(cur_struct), _numeric_operand[numeric_compare.group(1)])(float(compare_value))
                      Severity: Major
                      Found in salt/beacons/napalm_beacon.py - About 30 mins to fix

                        Avoid too many return statements within this function.
                        Open

                                return cur_cmp == cur_struct
                        Severity: Major
                        Found in salt/beacons/napalm_beacon.py - About 30 mins to fix

                          Avoid too many return statements within this function.
                          Open

                                  return found
                          Severity: Major
                          Found in salt/beacons/napalm_beacon.py - About 30 mins to fix

                            Avoid too many return statements within this function.
                            Open

                                    return False
                            Severity: Major
                            Found in salt/beacons/napalm_beacon.py - About 30 mins to fix

                              Avoid too many return statements within this function.
                              Open

                                      return cur_cmp == cur_struct
                              Severity: Major
                              Found in salt/beacons/napalm_beacon.py - About 30 mins to fix

                                Avoid too many return statements within this function.
                                Open

                                        return found
                                Severity: Major
                                Found in salt/beacons/napalm_beacon.py - About 30 mins to fix

                                  Avoid too many return statements within this function.
                                  Open

                                              return True
                                  Severity: Major
                                  Found in salt/beacons/napalm_beacon.py - About 30 mins to fix

                                    Function validate has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                                    Open

                                    def validate(config):
    '''
    Validate the beacon configuration.
    '''
    # Must be a list of dicts.
                                    Severity: Minor
                                    Found in salt/beacons/napalm_beacon.py - About 25 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