Godley/MuseParse

View on GitHub
MuseParse/classes/ObjectHierarchy/ItemClasses/Ornaments.py

Summary

Maintainability
A
2 hrs
Test Coverage

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

    def toLily(self):
        return_val = "\\repeat tremolo "
        num = ""
        if hasattr(self, "value"):
            options = {1: 2, 2: 4, 3: 8}

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 class Tremolo. (6)
Open

class Tremolo(BaseClass.Base):

    """
    Tremolo class.

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

    def toLily(self):
        return_val = "\\repeat tremolo "
        num = ""
        if hasattr(self, "value"):
            options = {1: 2, 2: 4, 3: 8}
Severity: Minor
Found in MuseParse/classes/ObjectHierarchy/ItemClasses/Ornaments.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 __init__ has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
Open

    def __init__(self, **kwargs):
        self.preNote = True
        BaseClass.Base.__init__(self)
        if "type" in kwargs:
            if kwargs["type"] is not None:
Severity: Minor
Found in MuseParse/classes/ObjectHierarchy/ItemClasses/Ornaments.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

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

        if "type" in kwargs:
            if kwargs["type"] is not None:
                self.type = kwargs["type"]
Severity: Major
Found in MuseParse/classes/ObjectHierarchy/ItemClasses/Ornaments.py and 28 other locations - About 55 mins to fix
MuseParse/classes/ObjectHierarchy/ItemClasses/Directions.py on lines 127..129
MuseParse/classes/ObjectHierarchy/ItemClasses/Directions.py on lines 130..132
MuseParse/classes/ObjectHierarchy/ItemClasses/Directions.py on lines 133..135
MuseParse/classes/ObjectHierarchy/ItemClasses/Directions.py on lines 136..138
MuseParse/classes/ObjectHierarchy/ItemClasses/Directions.py on lines 139..141
MuseParse/classes/ObjectHierarchy/ItemClasses/Directions.py on lines 142..144
MuseParse/classes/ObjectHierarchy/ItemClasses/Directions.py on lines 209..211
MuseParse/classes/ObjectHierarchy/ItemClasses/Directions.py on lines 316..318
MuseParse/classes/ObjectHierarchy/ItemClasses/Directions.py on lines 358..360
MuseParse/classes/ObjectHierarchy/ItemClasses/Directions.py on lines 389..391
MuseParse/classes/ObjectHierarchy/ItemClasses/Directions.py on lines 468..470
MuseParse/classes/ObjectHierarchy/ItemClasses/Directions.py on lines 518..520
MuseParse/classes/ObjectHierarchy/ItemClasses/Directions.py on lines 521..523
MuseParse/classes/ObjectHierarchy/ItemClasses/Directions.py on lines 524..526
MuseParse/classes/ObjectHierarchy/ItemClasses/Directions.py on lines 527..529
MuseParse/classes/ObjectHierarchy/ItemClasses/Directions.py on lines 785..787
MuseParse/classes/ObjectHierarchy/ItemClasses/Harmony.py on lines 23..25
MuseParse/classes/ObjectHierarchy/ItemClasses/Harmony.py on lines 26..28
MuseParse/classes/ObjectHierarchy/ItemClasses/Harmony.py on lines 29..31
MuseParse/classes/ObjectHierarchy/ItemClasses/Harmony.py on lines 89..91
MuseParse/classes/ObjectHierarchy/ItemClasses/Harmony.py on lines 166..168
MuseParse/classes/ObjectHierarchy/ItemClasses/Harmony.py on lines 169..171
MuseParse/classes/ObjectHierarchy/ItemClasses/Harmony.py on lines 172..174
MuseParse/classes/ObjectHierarchy/ItemClasses/Harmony.py on lines 175..177
MuseParse/classes/ObjectHierarchy/ItemClasses/Meta.py on lines 21..23
MuseParse/classes/ObjectHierarchy/ItemClasses/Meta.py on lines 24..26
MuseParse/classes/ObjectHierarchy/ItemClasses/Meta.py on lines 27..29
MuseParse/classes/ObjectHierarchy/TreeClasses/MeasureNode.py on lines 41..43

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

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 (110 > 79 characters)
Open

The following classes really are just stubs for ornament notations that could probably be merged into 1 class.

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.

Invalid escape sequence '\p'
Open

        return "\prall"

Invalid escape sequences are deprecated in Python 3.6.

Okay: regex = r'\.png$'
W605: regex = '\.png$'

Invalid escape sequence '\m'
Open

        return "\mordent"

Invalid escape sequences are deprecated in Python 3.6.

Okay: regex = r'\.png$'
W605: regex = '\.png$'

There are no issues that match your filters.

Category
Status