chrislit/abydos

View on GitHub
abydos/distance/_flexmetric.py

Summary

Maintainability
B
6 hrs
Test Coverage

Cyclomatic complexity is too high in method _cost. (17)
Open

    def _cost(self, src: str, s_pos: int, tar: str, t_pos: int) -> float:
        if s_pos == -1:
            if t_pos > 0 and tar[t_pos - 1] == tar[t_pos]:
                return 0.0
            for letter_set in self._indel_costs:
Severity: Minor
Found in abydos/distance/_flexmetric.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 _cost has a Cognitive Complexity of 23 (exceeds 5 allowed). Consider refactoring.
Open

    def _cost(self, src: str, s_pos: int, tar: str, t_pos: int) -> float:
        if s_pos == -1:
            if t_pos > 0 and tar[t_pos - 1] == tar[t_pos]:
                return 0.0
            for letter_set in self._indel_costs:
Severity: Minor
Found in abydos/distance/_flexmetric.py - About 3 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. (11)
Open

    def dist_abs(self, src: str, tar: str) -> float:
        """Return the FlexMetric distance of two strings.

        Parameters
        ----------
Severity: Minor
Found in abydos/distance/_flexmetric.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 FlexMetric. (8)
Open

class FlexMetric(_Distance):
    r"""FlexMetric distance.

    FlexMetric distance :cite:`Kempken:2005`

Severity: Minor
Found in abydos/distance/_flexmetric.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 dist_abs has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
Open

    def dist_abs(self, src: str, tar: str) -> float:
        """Return the FlexMetric distance of two strings.

        Parameters
        ----------
Severity: Minor
Found in abydos/distance/_flexmetric.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

Avoid too many return statements within this function.
Open

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

    Avoid too many return statements within this function.
    Open

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

      Avoid too many return statements within this function.
      Open

                          return letter_set[1]
      Severity: Major
      Found in abydos/distance/_flexmetric.py - About 30 mins to fix

        Avoid too many return statements within this function.
        Open

                        return letter_set[1]
        Severity: Major
        Found in abydos/distance/_flexmetric.py - About 30 mins to fix

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

              def _cost(self, src: str, s_pos: int, tar: str, t_pos: int) -> float:
          Severity: Critical
          Found in abydos/distance/_flexmetric.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 return statements (8/6)
          Open

              def _cost(self, src: str, s_pos: int, tar: str, t_pos: int) -> float:
          Severity: Info
          Found in abydos/distance/_flexmetric.py by pylint

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

          Too many branches (13/12)
          Open

              def _cost(self, src: str, s_pos: int, tar: str, t_pos: int) -> float:
          Severity: Info
          Found in abydos/distance/_flexmetric.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 float_ as np_float
          Severity: Critical
          Found in abydos/distance/_flexmetric.py by pylint

          Used when pylint has been unable to import a module.

          Else clause on loop without a break statement
          Open

                      else:
          Severity: Minor
          Found in abydos/distance/_flexmetric.py by pylint

          Loops should only have an else clause if they can exit early with a break statement, otherwise the statements under else should be on the same scope as the loop itself.

          Else clause on loop without a break statement
          Open

                      else:
          Severity: Minor
          Found in abydos/distance/_flexmetric.py by pylint

          Loops should only have an else clause if they can exit early with a break statement, otherwise the statements under else should be on the same scope as the loop itself.

          Else clause on loop without a break statement
          Open

                  else:
          Severity: Minor
          Found in abydos/distance/_flexmetric.py by pylint

          Loops should only have an else clause if they can exit early with a break statement, otherwise the statements under else should be on the same scope as the loop itself.

          Unable to import 'numpy'
          Open

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

          Used when pylint has been unable to import a module.

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

                      s: Tuple[Union[Sequence[str], Set[str], FrozenSet[str]], float]
          Severity: Info
          Found in abydos/distance/_flexmetric.py by pylint

          TODO s: Tuple[Union[Sequence[str], Set[str], FrozenSet[str]], float] ^ |

          Line too long (103/100)
          Open

                      ]  # type: List[Tuple[Union[Sequence[str], Set[str], FrozenSet[str]], float]]  # noqa: E501
          Severity: Info
          Found in abydos/distance/_flexmetric.py by pylint

          Used when a line is longer than a given number of characters.

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

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

          TODO self, ^ |

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

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

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

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

                  indel_costs: Optional[
          Severity: Info
          Found in abydos/distance/_flexmetric.py by pylint

          TODO indel_costs: Optional[ ^ |

          Line too long (103/100)
          Open

                      ]  # type: List[Tuple[Union[Sequence[str], Set[str], FrozenSet[str]], float]]  # noqa: E501
          Severity: Info
          Found in abydos/distance/_flexmetric.py by pylint

          Used when a line is longer than a given number of characters.

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

                  def _get_second(
          Severity: Info
          Found in abydos/distance/_flexmetric.py by pylint

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

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

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

          TODO **kwargs: Any ^ |

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

                  subst_costs: Optional[
          Severity: Info
          Found in abydos/distance/_flexmetric.py by pylint

          TODO subst_costs: Optional[ ^ |

          There are no issues that match your filters.

          Category
          Status