the-allanc/machinerry

View on GitHub

Showing 10 of 10 total issues

File machinerry.py has 524 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import cherrypy
import threading


import datetime
Severity: Major
Found in machinerry.py - About 1 day to fix

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

        def run(self):
            """Continuously run self.execute(). Errors are trapped and logged."""
            try:
                try:
                    get_ident = threading.get_ident
    Severity: Minor
    Found in machinerry.py - About 3 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

    BoneMachine has 26 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class BoneMachine(object):
    
        """Internal subclass which provides the bulk of the machine framework.
    
        You should use the Machine class directly."""
    Severity: Minor
    Found in machinerry.py - About 3 hrs to fix

      Cyclomatic complexity is too high in method run. (14)
      Open

          def run(self):
              """Continuously run self.execute(). Errors are trapped and logged."""
              try:
                  try:
                      get_ident = threading.get_ident
      Severity: Minor
      Found in machinerry.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

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

          def subscribe(self):
              e = cherrypy.engine
              e.subscribe('start', self.start)
              e.subscribe('stop', self.stop)
      Severity: Minor
      Found in machinerry.py and 1 other location - About 55 mins to fix
      machinerry.py on lines 790..793

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

      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

          def unsubscribe(self):
              e = cherrypy.engine
              e.unsubscribe('start', self.start)
              e.unsubscribe('stop', self.stop)
      Severity: Minor
      Found in machinerry.py and 1 other location - About 55 mins to fix
      machinerry.py on lines 785..788

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

      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

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

          def _become_paused(self, paused, set_state=True):
              if self.machine_state != self.PAUSED and paused:
                  assert self.paused, (
                      'cannot set machine into paused state without pause flag '
                      'also being set'
      Severity: Minor
      Found in machinerry.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

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

          def pause_time_text(self):
              pause_secs = max((self.now() - self.pause_time).seconds, 1)
              mins, secs = divmod(pause_secs, 60)
              hours, mins = divmod(mins, 60)
      
      
      Severity: Minor
      Found in machinerry.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

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

          def _reschedule(self, on_error):
      
              # Run times might be set by subclasses, so don't override
              # anything explicit.
              if self.run_time_next is not None:
      Severity: Minor
      Found in machinerry.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

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

          def run_once(self):
              """Run self.execute() once. Errors are trapped.
      
              This is the equivalent of performing a single run immediately in
              the context of the machine (with regard to all the prep work which
      Severity: Minor
      Found in machinerry.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

      Severity
      Category
      Status
      Source
      Language