Godley/MuseParse

View on GitHub
MuseParse/classes/ObjectHierarchy/TreeClasses/BaseTree.py

Summary

Maintainability
F
4 days
Test Coverage

Function BackwardSearch has a Cognitive Complexity of 33 (exceeds 5 allowed). Consider refactoring.
Open

def BackwardSearch(cls_type, node, index, depth=0, start_index=0):
    '''
    Helper method which backwards-recursively searches for objects
    :param cls_type: class type of the object we are in search of
    :param node: object instance to start at
Severity: Minor
Found in MuseParse/classes/ObjectHierarchy/TreeClasses/BaseTree.py - About 4 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

Function Search has a Cognitive Complexity of 33 (exceeds 5 allowed). Consider refactoring.
Open

def Search(cls_type, node, index, depth=0, start_index=0):
    '''
    recursive method that goes through finding the "index"th object of cls_type. outside of piecetree
    so that it can be used by any node
    :param cls_type: class type of the object we are in search of
Severity: Minor
Found in MuseParse/classes/ObjectHierarchy/TreeClasses/BaseTree.py - About 4 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

Function FindPosition has a Cognitive Complexity of 27 (exceeds 5 allowed). Consider refactoring.
Open

def FindPosition(node, addition, index=0):
    '''
    Method to search for children according to their position in list. Similar functionality to above method,
    except this is for adding items to the tree according to the nodes limits on children or types of children they can have
    :param node: current node being searched
Severity: Minor
Found in MuseParse/classes/ObjectHierarchy/TreeClasses/BaseTree.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

Cyclomatic complexity is too high in function FindPosition. (13)
Open

def FindPosition(node, addition, index=0):
    '''
    Method to search for children according to their position in list. Similar functionality to above method,
    except this is for adding items to the tree according to the nodes limits on children or types of children they can have
    :param node: current node being searched

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 BaseTree.py has 291 lines of code (exceeds 250 allowed). Consider refactoring.
Open

class CannotAddToTreeException(BaseException):

    '''error in tree addition!'''


Severity: Minor
Found in MuseParse/classes/ObjectHierarchy/TreeClasses/BaseTree.py - About 3 hrs to fix

    Cyclomatic complexity is too high in function Search. (12)
    Open

    def Search(cls_type, node, index, depth=0, start_index=0):
        '''
        recursive method that goes through finding the "index"th object of cls_type. outside of piecetree
        so that it can be used by any node
        :param cls_type: class type of the object we are in search of

    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 function BackwardSearch. (12)
    Open

    def BackwardSearch(cls_type, node, index, depth=0, start_index=0):
        '''
        Helper method which backwards-recursively searches for objects
        :param cls_type: class type of the object we are in search of
        :param node: object instance to start at

    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 FindByIndex has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.
    Open

    def FindByIndex(node, index):
        '''
        Method which finds child according to index. Applies only to nodes whose children are sorted into a dict,
        so if the current node's children are in a list it will recursively search - similarly if the index is not found
        in the current node's dictionary indexes.
    Severity: Minor
    Found in MuseParse/classes/ObjectHierarchy/TreeClasses/BaseTree.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

    Cyclomatic complexity is too high in function FindByIndex. (9)
    Open

    def FindByIndex(node, index):
        '''
        Method which finds child according to index. Applies only to nodes whose children are sorted into a dict,
        so if the current node's children are in a list it will recursively search - similarly if the index is not found
        in the current node's dictionary indexes.

    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

    Avoid deeply nested control flow statements.
    Open

                        if counter == index:
                            return node.GetChild(child)
                    if isinstance(result, cls_type):
    Severity: Major
    Found in MuseParse/classes/ObjectHierarchy/TreeClasses/BaseTree.py - About 45 mins to fix

      Avoid deeply nested control flow statements.
      Open

                          if counter == index:
                              return node.GetChild(child)
                      if isinstance(result, cls_type):
      Severity: Major
      Found in MuseParse/classes/ObjectHierarchy/TreeClasses/BaseTree.py - About 45 mins to fix

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

        def BackwardSearch(cls_type, node, index, depth=0, start_index=0):
        Severity: Minor
        Found in MuseParse/classes/ObjectHierarchy/TreeClasses/BaseTree.py - About 35 mins to fix

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

          def Search(cls_type, node, index, depth=0, start_index=0):
          Severity: Minor
          Found in MuseParse/classes/ObjectHierarchy/TreeClasses/BaseTree.py - About 35 mins to fix

            Avoid too many return statements within this function.
            Open

                    return result
            Severity: Major
            Found in MuseParse/classes/ObjectHierarchy/TreeClasses/BaseTree.py - About 30 mins to fix

              Avoid too many return statements within this function.
              Open

                                  return node
              Severity: Major
              Found in MuseParse/classes/ObjectHierarchy/TreeClasses/BaseTree.py - About 30 mins to fix

                Avoid too many return statements within this function.
                Open

                                    return counter
                Severity: Major
                Found in MuseParse/classes/ObjectHierarchy/TreeClasses/BaseTree.py - About 30 mins to fix

                  Avoid too many return statements within this function.
                  Open

                                      return node
                  Severity: Major
                  Found in MuseParse/classes/ObjectHierarchy/TreeClasses/BaseTree.py - About 30 mins to fix

                    Avoid too many return statements within this function.
                    Open

                                        return counter
                    Severity: Major
                    Found in MuseParse/classes/ObjectHierarchy/TreeClasses/BaseTree.py - About 30 mins to fix

                      Avoid too many return statements within this function.
                      Open

                                          return result
                      Severity: Major
                      Found in MuseParse/classes/ObjectHierarchy/TreeClasses/BaseTree.py - About 30 mins to fix

                        Avoid too many return statements within this function.
                        Open

                                    return None
                        Severity: Major
                        Found in MuseParse/classes/ObjectHierarchy/TreeClasses/BaseTree.py - About 30 mins to fix

                          Avoid too many return statements within this function.
                          Open

                                              return result
                          Severity: Major
                          Found in MuseParse/classes/ObjectHierarchy/TreeClasses/BaseTree.py - About 30 mins to fix

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

                                        for child in children:
                                            result = Search(
                                                cls_type,
                                                node.GetChild(child),
                                                index,
                            Severity: Major
                            Found in MuseParse/classes/ObjectHierarchy/TreeClasses/BaseTree.py and 1 other location - About 3 hrs to fix
                            MuseParse/classes/ObjectHierarchy/TreeClasses/BaseTree.py on lines 78..89

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

                            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

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

                                        for child in children:
                                            result = Search(
                                                cls_type,
                                                node.GetChild(child),
                                                index,
                            Severity: Major
                            Found in MuseParse/classes/ObjectHierarchy/TreeClasses/BaseTree.py and 1 other location - About 3 hrs to fix
                            MuseParse/classes/ObjectHierarchy/TreeClasses/BaseTree.py on lines 36..47

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

                            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

                            Line too long (101 > 79 characters)
                            Open

                                recursive method that goes through finding the "index"th object of cls_type. outside of piecetree

                            Limit all lines to a maximum of 79 characters.

                            There are still many devices around that are limited to 80 character
                            lines; plus, limiting windows to 80 characters makes it possible to
                            have several windows side-by-side.  The default wrapping on such
                            devices looks ugly.  Therefore, please limit all lines to a maximum
                            of 79 characters. For flowing long blocks of text (docstrings or
                            comments), limiting the length to 72 characters is recommended.
                            
                            Reports error E501.

                            Line too long (109 > 79 characters)
                            Open

                                Method which finds child according to index. Applies only to nodes whose children are sorted into a dict,

                            Limit all lines to a maximum of 79 characters.

                            There are still many devices around that are limited to 80 character
                            lines; plus, limiting windows to 80 characters makes it possible to
                            have several windows side-by-side.  The default wrapping on such
                            devices looks ugly.  Therefore, please limit all lines to a maximum
                            of 79 characters. For flowing long blocks of text (docstrings or
                            comments), limiting the length to 72 characters is recommended.
                            
                            Reports error E501.

                            Line too long (124 > 79 characters)
                            Open

                                except this is for adding items to the tree according to the nodes limits on children or types of children they can have

                            Limit all lines to a maximum of 79 characters.

                            There are still many devices around that are limited to 80 character
                            lines; plus, limiting windows to 80 characters makes it possible to
                            have several windows side-by-side.  The default wrapping on such
                            devices looks ugly.  Therefore, please limit all lines to a maximum
                            of 79 characters. For flowing long blocks of text (docstrings or
                            comments), limiting the length to 72 characters is recommended.
                            
                            Reports error E501.

                            Line too long (83 > 79 characters)
                            Open

                                    - limit: the maximum amount of children before castcading to the next level

                            Limit all lines to a maximum of 79 characters.

                            There are still many devices around that are limited to 80 character
                            lines; plus, limiting windows to 80 characters makes it possible to
                            have several windows side-by-side.  The default wrapping on such
                            devices looks ugly.  Therefore, please limit all lines to a maximum
                            of 79 characters. For flowing long blocks of text (docstrings or
                            comments), limiting the length to 72 characters is recommended.
                            
                            Reports error E501.

                            Line too long (138 > 79 characters)
                            Open

                                """This is a class used to represent gaps in note representation - i.e where we want to jump forward in the measure and then come back

                            Limit all lines to a maximum of 79 characters.

                            There are still many devices around that are limited to 80 character
                            lines; plus, limiting windows to 80 characters makes it possible to
                            have several windows side-by-side.  The default wrapping on such
                            devices looks ugly.  Therefore, please limit all lines to a maximum
                            of 79 characters. For flowing long blocks of text (docstrings or
                            comments), limiting the length to 72 characters is recommended.
                            
                            Reports error E501.

                            Line too long (100 > 79 characters)
                            Open

                                """Your basic generic tree structure, but with a few improvements to handle automatic ruling."""

                            Limit all lines to a maximum of 79 characters.

                            There are still many devices around that are limited to 80 character
                            lines; plus, limiting windows to 80 characters makes it possible to
                            have several windows side-by-side.  The default wrapping on such
                            devices looks ugly.  Therefore, please limit all lines to a maximum
                            of 79 characters. For flowing long blocks of text (docstrings or
                            comments), limiting the length to 72 characters is recommended.
                            
                            Reports error E501.

                            Line too long (116 > 79 characters)
                            Open

                                so if the current node's children are in a list it will recursively search - similarly if the index is not found

                            Limit all lines to a maximum of 79 characters.

                            There are still many devices around that are limited to 80 character
                            lines; plus, limiting windows to 80 characters makes it possible to
                            have several windows side-by-side.  The default wrapping on such
                            devices looks ugly.  Therefore, please limit all lines to a maximum
                            of 79 characters. For flowing long blocks of text (docstrings or
                            comments), limiting the length to 72 characters is recommended.
                            
                            Reports error E501.

                            Line too long (126 > 79 characters)
                            Open

                                """same as node, except the children section have their own indexes. to be used in nodes like Piece and Part, as both have

                            Limit all lines to a maximum of 79 characters.

                            There are still many devices around that are limited to 80 character
                            lines; plus, limiting windows to 80 characters makes it possible to
                            have several windows side-by-side.  The default wrapping on such
                            devices looks ugly.  Therefore, please limit all lines to a maximum
                            of 79 characters. For flowing long blocks of text (docstrings or
                            comments), limiting the length to 72 characters is recommended.
                            
                            Reports error E501.

                            Line too long (109 > 79 characters)
                            Open

                                Method to search for children according to their position in list. Similar functionality to above method,

                            Limit all lines to a maximum of 79 characters.

                            There are still many devices around that are limited to 80 character
                            lines; plus, limiting windows to 80 characters makes it possible to
                            have several windows side-by-side.  The default wrapping on such
                            devices looks ugly.  Therefore, please limit all lines to a maximum
                            of 79 characters. For flowing long blocks of text (docstrings or
                            comments), limiting the length to 72 characters is recommended.
                            
                            Reports error E501.

                            Line too long (125 > 79 characters)
                            Open

                                and fill the gap in later on. Used mostly in voices where we maybe want to fill in an extra voice at a specific moment"""

                            Limit all lines to a maximum of 79 characters.

                            There are still many devices around that are limited to 80 character
                            lines; plus, limiting windows to 80 characters makes it possible to
                            have several windows side-by-side.  The default wrapping on such
                            devices looks ugly.  Therefore, please limit all lines to a maximum
                            of 79 characters. For flowing long blocks of text (docstrings or
                            comments), limiting the length to 72 characters is recommended.
                            
                            Reports error E501.

                            Line too long (116 > 79 characters)
                            Open

                                    Method to remove child at <key> and replace it with <item>, then put the child back onto the end of the list

                            Limit all lines to a maximum of 79 characters.

                            There are still many devices around that are limited to 80 character
                            lines; plus, limiting windows to 80 characters makes it possible to
                            have several windows side-by-side.  The default wrapping on such
                            devices looks ugly.  Therefore, please limit all lines to a maximum
                            of 79 characters. For flowing long blocks of text (docstrings or
                            comments), limiting the length to 72 characters is recommended.
                            
                            Reports error E501.

                            Line too long (110 > 79 characters)
                            Open

                                    """adds the child to the list - index is included as an optional param but doesn't do anything because

                            Limit all lines to a maximum of 79 characters.

                            There are still many devices around that are limited to 80 character
                            lines; plus, limiting windows to 80 characters makes it possible to
                            have several windows side-by-side.  The default wrapping on such
                            devices looks ugly.  Therefore, please limit all lines to a maximum
                            of 79 characters. For flowing long blocks of text (docstrings or
                            comments), limiting the length to 72 characters is recommended.
                            
                            Reports error E501.

                            There are no issues that match your filters.

                            Category
                            Status