fossasia/knittingpattern

View on GitHub
knittingpattern/convert/SVGBuilder.py

Summary

Maintainability
A
2 hrs
Test Coverage
A
96%

Cyclomatic complexity is too high in method insert_defs. (7)
Open

    def insert_defs(self, defs):
        """Adds the defs to the SVG structure.

        :param defs: a list of SVG dictionaries, which contain the defs,
          which should be added to the SVG structure.
Severity: Minor
Found in knittingpattern/convert/SVGBuilder.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 insert_defs has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
Open

    def insert_defs(self, defs):
        """Adds the defs to the SVG structure.

        :param defs: a list of SVG dictionaries, which contain the defs,
          which should be added to the SVG structure.
Severity: Minor
Found in knittingpattern/convert/SVGBuilder.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

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

    def place_svg_use_coords(self, x, y, symbol_id, layer_id, group=None):
Severity: Minor
Found in knittingpattern/convert/SVGBuilder.py - About 35 mins to fix

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

        def place_svg_dict(self, x, y, svg_dict, layer_id, group=None):
    Severity: Minor
    Found in knittingpattern/convert/SVGBuilder.py - About 35 mins to fix

      There are no issues that match your filters.

      Category
      Status