sitch-io/sensor

View on GitHub
sitch/sitchlib/arfcn_correlator.py

Summary

Maintainability
C
7 hrs
Test Coverage

Cyclomatic complexity is too high in method manage_arfcn_lists. (6)
Open

    def manage_arfcn_lists(self, direction, arfcn, aspect):
        """Manage the instance variable lists of ARFCNs.

        This is necessary to maintain an accurate state over time, and reduce
        unnecessary noise.
Severity: Minor
Found in sitch/sitchlib/arfcn_correlator.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

Cyclomatic complexity is too high in method arfcn_from_scan. (6)
Open

    @classmethod
    def arfcn_from_scan(cls, scan_type, scan_doc):
        """Pull the ARFCN from different scan types.

        Args:
Severity: Minor
Found in sitch/sitchlib/arfcn_correlator.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

Function manage_arfcn_lists has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
Open

    def manage_arfcn_lists(self, direction, arfcn, aspect):
        """Manage the instance variable lists of ARFCNs.

        This is necessary to maintain an accurate state over time, and reduce
        unnecessary noise.
Severity: Minor
Found in sitch/sitchlib/arfcn_correlator.py - About 1 hr 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 too many return statements within this function.
Open

            return None
Severity: Major
Found in sitch/sitchlib/arfcn_correlator.py - About 30 mins to fix

    Avoid too many return statements within this function.
    Open

                return None
    Severity: Major
    Found in sitch/sitchlib/arfcn_correlator.py - About 30 mins to fix

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

          def arfcn_from_scan(cls, scan_type, scan_doc):
              """Pull the ARFCN from different scan types.
      
              Args:
                  scan_type (str): "kal_channel", "gsm_modem_channel", or "gps".
      Severity: Minor
      Found in sitch/sitchlib/arfcn_correlator.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

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

          def correlate(self, scan_bolus):
              """Entrypoint for correlation, wraps individual checks.
      
              Args:
                  scan_bolus (tuple): Position 0 contains a string defining scan
      Severity: Minor
      Found in sitch/sitchlib/arfcn_correlator.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

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

              for feed_alert in feed_alerts:
                  feed_alert[1]["site_name"] = scan["site_name"]
                  feed_alert[1]["sensor_name"] = scan["sensor_name"]
                  feed_alert[1]["sensor_id"] = scan["sensor_id"]
                  retval.append(feed_alert)
      Severity: Major
      Found in sitch/sitchlib/arfcn_correlator.py and 1 other location - About 4 hrs to fix
      sitch/sitchlib/cgi_correlator.py on lines 324..328

      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 79.

      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