chrislit/abydos

View on GitHub
abydos/distance/_saps.py

Summary

Maintainability
A
1 hr
Test Coverage

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

    def sim_score(self, src: str, tar: str) -> float:
        """Return the SAPS similarity between two strings.

        Parameters
        ----------
Severity: Minor
Found in abydos/distance/_saps.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 method _s. (6)
Open

    def _s(self, src: str, tar: str) -> int:
        if src.isupper():
            if tar.isupper():
                return self._s4 if src == tar else self._s5
            else:
Severity: Minor
Found in abydos/distance/_saps.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 _s has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
Open

    def _s(self, src: str, tar: str) -> int:
        if src.isupper():
            if tar.isupper():
                return self._s4 if src == tar else self._s5
            else:
Severity: Minor
Found in abydos/distance/_saps.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

Too many instance attributes (9/7)
Open

class SAPS(_Distance):
Severity: Info
Found in abydos/distance/_saps.py by pylint

Used when class has too many instance attributes, try to reduce this to get a simpler (and so easier to use) class.

Unnecessary else after return
Open

            if tar.isupper():
Severity: Info
Found in abydos/distance/_saps.py by pylint

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.

Unnecessary else after return
Open

            if tar.islower():
Severity: Info
Found in abydos/distance/_saps.py by pylint

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.

Unnecessary else after return
Open

        if ch.isupper():
Severity: Info
Found in abydos/distance/_saps.py by pylint

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 zeros as np_zeros
Severity: Critical
Found in abydos/distance/_saps.py by pylint

Used when pylint has been unable to import a module.

Unable to import 'numpy'
Open

from numpy import int_ as np_int
Severity: Critical
Found in abydos/distance/_saps.py by pylint

Used when pylint has been unable to import a module.

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

        normalizer: Callable[[List[float]], float] = max,
Severity: Info
Found in abydos/distance/_saps.py by pylint

TODO normalizer: Callable[[List[float]], float] = max, ^ |

Consider using enumerate instead of iterating with range and len
Open

        for j in range(len(tar)):
Severity: Info
Found in abydos/distance/_saps.py by pylint

Emitted when code that iterates with range and len is encountered. Such code can be simplified by using the enumerate builtin.

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

        **kwargs: Any
Severity: Info
Found in abydos/distance/_saps.py by pylint

TODO **kwargs: Any ^ |

Consider using enumerate instead of iterating with range and len
Open

        for i in range(len(src)):
Severity: Info
Found in abydos/distance/_saps.py by pylint

Emitted when code that iterates with range and len is encountered. Such code can be simplified by using the enumerate builtin.

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

        tokenizer: Optional[_Tokenizer] = None,
Severity: Info
Found in abydos/distance/_saps.py by pylint

TODO tokenizer: Optional[_Tokenizer] = None, ^ |

Consider using enumerate instead of iterating with range and len
Open

        for i in range(len(src)):
Severity: Info
Found in abydos/distance/_saps.py by pylint

Emitted when code that iterates with range and len is encountered. Such code can be simplified by using the enumerate builtin.

Consider using enumerate instead of iterating with range and len
Open

            for j in range(len(tar)):
Severity: Info
Found in abydos/distance/_saps.py by pylint

Emitted when code that iterates with range and len is encountered. Such code can be simplified by using the enumerate builtin.

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

        cost: Tuple[int, int, int, int, int, int, int] = (
Severity: Info
Found in abydos/distance/_saps.py by pylint

TODO cost: Tuple[int, int, int, int, int, int, int] = ( ^ |

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

        self,
Severity: Info
Found in abydos/distance/_saps.py by pylint

TODO self, ^ |

Argument name ch doesn't conform to snake_case naming style
Open

    def _g(self, ch: str) -> int:
Severity: Info
Found in abydos/distance/_saps.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