chrislit/abydos

View on GitHub
abydos/tokenizer/_saps.py

Summary

Maintainability
A
2 hrs
Test Coverage

Cyclomatic complexity is too high in method tokenize. (10)
Open

    def tokenize(self, string: str) -> 'SAPSTokenizer':
        """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/_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 class SAPSTokenizer. (6)
Open

class SAPSTokenizer(_Tokenizer):
    """Syllable Alignment Pattern Searching tokenizer.

    This is the syllabifier described on p. 917 of :cite:`Ruibin:2005`.

Severity: Minor
Found in abydos/tokenizer/_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 tokenize has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
Open

    def tokenize(self, string: str) -> 'SAPSTokenizer':
        """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/_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

Consider simplifying this complex logical expression.
Open

                if syll[-1] in _vowels and (
                    (
                        len(w[i:]) > 1
                        and w[i : i + 1] not in _vowels
                        and w[i + 1 : i + 2] not in _vowels
Severity: Major
Found in abydos/tokenizer/_saps.py - About 40 mins to fix

    Too many boolean expressions in if statement (6/5)
    Open

                    if syll[-1] in _vowels and (
    Severity: Info
    Found in abydos/tokenizer/_saps.py by pylint

    Used when an if statement contains too many boolean expressions.

    Useless super delegation in method '__init__'
    Open

        def __init__(
    Severity: Minor
    Found in abydos/tokenizer/_saps.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 w doesn't conform to snake_case naming style
    Open

            for w in words:
    Severity: Info
    Found in abydos/tokenizer/_saps.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

                        (
    Severity: Info
    Found in abydos/tokenizer/_saps.py by pylint

    TODO ( ^ |

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

            self, scaler: Optional[Union[str, Callable[[float], float]]] = None,
    Severity: Info
    Found in abydos/tokenizer/_saps.py by pylint

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

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

                        or (len(w[i:]) == 1 and w[i : i + 1] not in _vowels)
    Severity: Info
    Found in abydos/tokenizer/_saps.py by pylint

    TODO or (len(w[i:]) == 1 and w[i : i + 1] not in _vowels) ^ |

    There are no issues that match your filters.

    Category
    Status