chrislit/abydos

View on GitHub
abydos/distance/_needleman_wunsch.py

Summary

Maintainability
A
3 hrs
Test Coverage

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

    @staticmethod
    def sim_matrix(
        src: str,
        tar: str,
        mat: Optional[Dict[Tuple[str, str], int]] = None,
Severity: Minor
Found in abydos/distance/_needleman_wunsch.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 sim_matrix has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.
Open

    def sim_matrix(
        src: str,
        tar: str,
        mat: Optional[Dict[Tuple[str, str], int]] = None,
        mismatch_cost: float = 0,
Severity: Minor
Found in abydos/distance/_needleman_wunsch.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 class NeedlemanWunsch. (6)
Open

class NeedlemanWunsch(_Distance):
    """Needleman-Wunsch score.

    The Needleman-Wunsch score :cite:`Needleman:1970` is a standard edit
    distance measure.
Severity: Minor
Found in abydos/distance/_needleman_wunsch.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 sim_matrix has 6 arguments (exceeds 4 allowed). Consider refactoring.
Open

    def sim_matrix(
Severity: Minor
Found in abydos/distance/_needleman_wunsch.py - About 45 mins to fix

    Avoid too many return statements within this function.
    Open

            return mismatch_cost
    Severity: Major
    Found in abydos/distance/_needleman_wunsch.py - About 30 mins to fix

      Refactor this function to reduce its Cognitive Complexity from 19 to the 15 allowed.
      Open

          def sim_matrix(

      Cognitive Complexity is a measure of how hard the control flow of a function is to understand. Functions with high Cognitive Complexity will be difficult to maintain.

      See

      Too many arguments (7/5)
      Open

          def sim_matrix(

      Used when a function or method takes too many arguments.

      Unnecessary elif after return
      Open

              if mat and (src, tar) in mat:

      Used in order to highlight an unnecessary block of code following an if containing a return statement. As such, it will warn when it encounters an else following a chain of ifs, all of them containing a return statement.

      Unable to import 'numpy'
      Open

      from numpy import float_ as np_float
      Severity: Critical
      Found in abydos/distance/_needleman_wunsch.py by pylint

      Used when pylint has been unable to import a module.

      Unable to import 'numpy'
      Open

      from numpy import zeros as np_zeros
      Severity: Critical
      Found in abydos/distance/_needleman_wunsch.py by pylint

      Used when pylint has been unable to import a module.

      Wrong hanging indentation before block (add 4 spaces).
      Open

              alphabet: Optional[str] = None,

      TODO alphabet: Optional[str] = None, ^ |

      Wrong hanging indentation before block (add 4 spaces).
      Open

              mismatch_cost: float = 0,

      TODO mismatch_cost: float = 0, ^ |

      Wrong hanging indentation before block (add 4 spaces).
      Open

              sim_func: Optional[Callable[[str, str], float]] = None,

      TODO sim_func: Optional[Callable[[str, str], float]] = None, ^ |

      Wrong hanging indentation before block (add 4 spaces).
      Open

              tar: str,

      TODO tar: str, ^ |

      Wrong hanging indentation before block (add 4 spaces).
      Open

              gap_cost: float = 1,

      TODO gap_cost: float = 1, ^ |

      Wrong hanging indentation before block (add 4 spaces).
      Open

              **kwargs: Any

      TODO **kwargs: Any ^ |

      Wrong hanging indentation before block (add 4 spaces).
      Open

              self,

      TODO self, ^ |

      Wrong hanging indentation before block (add 4 spaces).
      Open

              src: str,

      TODO src: str, ^ |

      Wrong hanging indentation before block (add 4 spaces).
      Open

              mat: Optional[Dict[Tuple[str, str], int]] = None,

      TODO mat: Optional[Dict[Tuple[str, str], int]] = None, ^ |

      Wrong hanging indentation before block (add 4 spaces).
      Open

              symmetric: bool = True,

      TODO symmetric: bool = True, ^ |

      Wrong hanging indentation before block (add 4 spaces).
      Open

              match_cost: float = 1,

      TODO match_cost: float = 1, ^ |

      There are no issues that match your filters.

      Category
      Status