chrislit/abydos

View on GitHub
abydos/tokenizer/_tokenizer.py

Summary

Maintainability
A
1 hr
Test Coverage

Cyclomatic complexity is too high in method _scale_and_counterize. (12)
Open

    def _scale_and_counterize(self) -> None:
        """Scale the tokens and store them in a defaultdict.

        .. versionadded:: 0.6.0

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

    def _scale_and_counterize(self) -> None:
        """Scale the tokens and store them in a defaultdict.

        .. versionadded:: 0.6.0

Severity: Minor
Found in abydos/tokenizer/_tokenizer.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

Unnecessary elif after return
Open

        if self._scaler == 'set':
Severity: Info
Found in abydos/tokenizer/_tokenizer.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.

Unused argument 'args'
Open

        self,
Severity: Minor
Found in abydos/tokenizer/_tokenizer.py by pylint

Used when a function or method argument is not used.

Keyword argument before variable positional arguments list in the definition of __init__ function
Open

    def __init__(
Severity: Minor
Found in abydos/tokenizer/_tokenizer.py by pylint

When defining a keyword argument before variable positional arguments, one can end up in having multiple values passed for the aforementioned parameter in case the method is called with keyword arguments.

Unused argument 'kwargs'
Open

        self,
Severity: Minor
Found in abydos/tokenizer/_tokenizer.py by pylint

Used when a function or method argument is not used.

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

        *args: Any,
Severity: Info
Found in abydos/tokenizer/_tokenizer.py by pylint

TODO *args: Any, ^ |

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

                self._ordered_tokens, self._ordered_weights
Severity: Info
Found in abydos/tokenizer/_tokenizer.py by pylint

TODO self.orderedtokens, self.orderedweights ^ |

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

        self,
Severity: Info
Found in abydos/tokenizer/_tokenizer.py by pylint

TODO self, ^ |

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

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

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

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

            n = len(self._ordered_tokens)
Severity: Info
Found in abydos/tokenizer/_tokenizer.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/tokenizer/_tokenizer.py by pylint

TODO **kwargs: Any ^ |

There are no issues that match your filters.

Category
Status