Sign upLogin

chrislit/abydos

View on GitHub
Star
abydos/distance/_higuera_mico.py

Summary

Maintainability
B
4 hrs
Test Coverage

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

    def dist_abs(self, src: str, tar: str) -> float:
        """Return the Higuera-Micó distance between two strings.

        This is a straightforward implementation of Higuera & Micó pseudocode
        from :cite:`Higuera:2008`, ported to Numpy.
Severity: Minor
Found in abydos/distance/_higuera_mico.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

Cyclomatic complexity is too high in method dist_abs. (15)
Open

    def dist_abs(self, src: str, tar: str) -> float:
        """Return the Higuera-Micó distance between two strings.

        This is a straightforward implementation of Higuera & Micó pseudocode
        from :cite:`Higuera:2008`, ported to Numpy.
Severity: Minor
Found in abydos/distance/_higuera_mico.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

Cyclomatic complexity is too high in class HigueraMico. (6)
Open

class HigueraMico(_Distance):
    """The Higuera-Micó contextual normalized edit distance.

    This is presented in :cite:`Higuera:2008`.
Severity: Minor
Found in abydos/distance/_higuera_mico.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

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

    def dist_abs(self, src: str, tar: str) -> float:
Severity: Critical
Found in abydos/distance/_higuera_mico.py by sonar-python

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 branches (15/12)
Open

    def dist_abs(self, src: str, tar: str) -> float:
Severity: Info
Found in abydos/distance/_higuera_mico.py by pylint

Used when a function or method has too many branches, making it hard to follow.

Unable to import 'numpy'
Open

from numpy import full as np_full
Severity: Critical
Found in abydos/distance/_higuera_mico.py by pylint

Used when pylint has been unable to import a module.

Useless super delegation in method '__init__'
Open

    def __init__(self, **kwargs: Any) -> None:
Severity: Minor
Found in abydos/distance/_higuera_mico.py by pylint

Used whenever we can detect that an overridden method is useless, relying on super() delegation to do the same thing as another method from the MRO.

Variable name mx doesn't conform to snake_case naming style
Open

        mx = np_full(
Severity: Info
Found in abydos/distance/_higuera_mico.py by pylint

Used when the name doesn't conform to naming rules associated to its type (constant, variable, class...).

There are no issues that match your filters.

Category
Status