Function dist_abs has a Cognitive Complexity of 34 (exceeds 5 allowed). Consider refactoring. Open
def dist_abs(self, src: str, tar: str) -> float:
"""Return the typo distance between two strings.
Parameters
----------- Read upRead up
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. (16) Open
def dist_abs(self, src: str, tar: str) -> float:
"""Return the typo distance between two strings.
Parameters
----------- Read upRead up
- Exclude checks
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. |
File _typo.py has 312 lines of code (exceeds 250 allowed). Consider refactoring. Open
# Copyright 2018-2020 by Christopher C. Little.
# This file is part of Abydos.
#
# Abydos is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published byCyclomatic complexity is too high in class Typo. (6) Open
class Typo(_Distance):
"""Typo distance.
This is inspired by Typo-Distance :cite:`Song:2011`, and a fair bit of
this was copied from that module. Compared to the original, this supports- Read upRead up
- Exclude checks
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. |
Function __init__ has 5 arguments (exceeds 4 allowed). Consider refactoring. Open
def __init__(Refactor this function to reduce its Cognitive Complexity from 34 to the 15 allowed. Open
def dist_abs(self, src: str, tar: str) -> float:- Read upRead up
- Exclude checks
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 branches (13/12) Open
def dist_abs(self, src: str, tar: str) -> float:- Read upRead up
- Exclude checks
Used when a function or method has too many branches, making it hard to follow.
Too many local variables (24/15) Open
def dist_abs(self, src: str, tar: str) -> float:- Read upRead up
- Exclude checks
Used when a function or method has too many local variables.
Using possibly undefined loop variable 'row' Open
return kb_array.index(row), row.index(char)- Read upRead up
- Exclude checks
Used when a loop variable (i.e. defined by a for loop or a list comprehension or a generator expression) is used outside the loop.
Unable to import 'numpy' Open
from numpy import zeros as np_zeros- Read upRead up
- Exclude checks
Used when pylint has been unable to import a module.
Unable to import 'numpy' Open
from numpy import float_ as np_float- Read upRead up
- Exclude checks
Used when pylint has been unable to import a module.
Using possibly undefined loop variable 'row' Open
return kb_array.index(row), row.index(char)- Read upRead up
- Exclude checks
Used when a loop variable (i.e. defined by a for loop or a list comprehension or a generator expression) is used outside the loop.
Consider using enumerate instead of iterating with range and len Open
for j in range(len(tar)):- Read upRead up
- Exclude checks
Emitted when code that iterates with range and len is encountered. Such code can be simplified by using the enumerate builtin.
Unnecessary parens after 'not' keyword Open
if not (letters - keys):- Read upRead up
- Exclude checks
Used when a single item in parentheses follows an if, for, or other keyword.
Variable name kb doesn't conform to snake_case naming style Open
for kb in ['QWERTY', 'QWERTZ', 'AZERTY']:- Read upRead up
- Exclude checks
Used when the name doesn't conform to naming rules associated to its type (constant, variable, class...).
Consider using enumerate instead of iterating with range and len Open
for i in range(len(src)):- Read upRead up
- Exclude checks
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
layout: str = 'QWERTY',- Read upRead up
- Exclude checks
TODO layout: str = 'QWERTY', ^ |
Wrong hanging indentation before block (add 4 spaces). Open
failsafe: bool = False,- Read upRead up
- Exclude checks
TODO failsafe: bool = False, ^ |
Wrong hanging indentation before block (add 4 spaces). Open
**kwargs: Any- Read upRead up
- Exclude checks
TODO **kwargs: Any ^ |
Wrong hanging indentation before block (add 4 spaces). Open
metric: str = 'euclidean',- Read upRead up
- Exclude checks
TODO metric: str = 'euclidean', ^ |
Wrong hanging indentation before block (add 4 spaces). Open
cost: Tuple[float, float, float, float] = (1.0, 1.0, 0.5, 0.5),- Read upRead up
- Exclude checks
TODO cost: Tuple[float, float, float, float] = (1.0, 1.0, 0.5, 0.5), ^ |
Wrong hanging indentation before block (add 4 spaces). Open
char: str, kb_array: Tuple[Tuple[str, ...], ...]- Read upRead up
- Exclude checks
TODO char: str, kb_array: Tuple[Tuple[str, ...], ...] ^ |
Wrong hanging indentation before block (add 4 spaces). Open
self,- Read upRead up
- Exclude checks
TODO self, ^ |