chrislit/abydos

View on GitHub
abydos/tokenizer/_c_or_v_cluster.py

Summary

Maintainability
B
5 hrs
Test Coverage

Function tokenize has a Cognitive Complexity of 26 (exceeds 5 allowed). Consider refactoring.
Open

    def tokenize(self, string: str) -> 'COrVClusterTokenizer':
        """Tokenize the term and store it.

        The tokenized term is stored as an ordered list and as a Counter
        object.
Severity: Minor
Found in abydos/tokenizer/_c_or_v_cluster.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 tokenize. (10)
Open

    def tokenize(self, string: str) -> 'COrVClusterTokenizer':
        """Tokenize the term and store it.

        The tokenized term is stored as an ordered list and as a Counter
        object.
Severity: Minor
Found in abydos/tokenizer/_c_or_v_cluster.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 COrVClusterTokenizer. (7)
Open

class COrVClusterTokenizer(_Tokenizer):
    """A C- or V-cluster tokenizer.

    .. versionadded:: 0.4.0
    """
Severity: Minor
Found in abydos/tokenizer/_c_or_v_cluster.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

Avoid deeply nested control flow statements.
Open

                        if mode == 2:
                            self._ordered_tokens.append(new_token)
                            new_token = char
                        else:
                            new_token += char
Severity: Major
Found in abydos/tokenizer/_c_or_v_cluster.py - About 45 mins to fix

    Avoid deeply nested control flow statements.
    Open

                            if mode == 1:
                                self._ordered_tokens.append(new_token)
                                new_token = char
                            else:
                                new_token += char
    Severity: Major
    Found in abydos/tokenizer/_c_or_v_cluster.py - About 45 mins to fix

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

          def tokenize(self, string: str) -> 'COrVClusterTokenizer':

      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

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

              vowels: Optional[Set[str]] = None,

      TODO vowels: Optional[Set[str]] = None, ^ |

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

              scaler: Optional[Union[str, Callable[[float], float]]] = None,

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

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

              consonants: Optional[Set[str]] = None,

      TODO consonants: Optional[Set[str]] = None, ^ |

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

                      token[0] not in self._consonants

      TODO token[0] not in self._consonants ^ |

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

                      and token[0] not in self._vowels

      TODO and token[0] not in self._vowels ^ |

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

              self,

      TODO self, ^ |

      There are no issues that match your filters.

      Category
      Status