Function corr has a Cognitive Complexity of 40 (exceeds 5 allowed). Consider refactoring. Open
def corr(self, src: str, tar: str) -> float:
"""Return the Iterative-SubString correlation of 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 corr. (21) Open
def corr(self, src: str, tar: str) -> float:
"""Return the Iterative-SubString correlation of 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. |
Cyclomatic complexity is too high in class IterativeSubString. (8) Open
class IterativeSubString(_Distance):
r"""Iterative-SubString correlation.
Iterative-SubString (I-Sub) correlation :cite:`Stoilos:2005`
- 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. |
Avoid deeply nested control flow statements. Open
while j < lt and k < ls and src[k] == tar[j]:
j += 1
k += 1
if k - i > best:Avoid deeply nested control flow statements. Open
if k - i > best:
best = k - i
start_src = i
end_src = k
start_tar = pRefactor this function to reduce its Cognitive Complexity from 43 to the 15 allowed. Open
def corr(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 corr(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 (27/15) Open
def corr(self, src: str, tar: str) -> float:- Read upRead up
- Exclude checks
Used when a function or method has too many local variables.
Too many statements (52/50) Open
def corr(self, src: str, tar: str) -> float:- Read upRead up
- Exclude checks
Used when a function or method has too many statements. You should then split it in smaller functions / methods.
Wrong hanging indentation before block (add 4 spaces). Open
normalize_strings: bool = False,- Read upRead up
- Exclude checks
TODO normalize_strings: bool = False, ^ |
Variable name p doesn't conform to snake_case naming style Open
p = j- Read upRead up
- Exclude checks
Used when the name doesn't conform to naming rules associated to its type (constant, variable, class...).
Variable name ch doesn't conform to snake_case naming style Open
for ch in '._ ':- Read upRead up
- Exclude checks
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
self,- Read upRead up
- Exclude checks
TODO self, ^ |
Wrong hanging indentation before block (add 4 spaces). Open
src: str, tar: str, commonality: float- Read upRead up
- Exclude checks
TODO src: str, tar: str, commonality: float ^ |
Variable name lt doesn't conform to snake_case naming style Open
lt = len(tar)- Read upRead up
- Exclude checks
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- Read upRead up
- Exclude checks
TODO **kwargs: Any ^ |
Variable name ls doesn't conform to snake_case naming style Open
ls = len(src)- Read upRead up
- Exclude checks
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
hamacher: float = 0.6,- Read upRead up
- Exclude checks
TODO hamacher: float = 0.6, ^ |