Function sim has a Cognitive Complexity of 47 (exceeds 5 allowed). Consider refactoring. Open
def sim(self, src: str, tar: str) -> float:
"""Return the Jaro or Jaro-Winkler similarity 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 sim. (31) Open
def sim(self, src: str, tar: str) -> float:
"""Return the Jaro or Jaro-Winkler similarity 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 JaroWinkler. (16) Open
class JaroWinkler(_Distance):
"""Jaro-Winkler distance.
Jaro(-Winkler) distance is a string edit distance initially proposed by
Jaro and extended by Winkler :cite:`Jaro:1989,Winkler:1990`.- 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 6 arguments (exceeds 4 allowed). Consider refactoring. Open
def __init__(Refactor this function to reduce its Cognitive Complexity from 47 to the 15 allowed. Open
def sim(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 (19/12) Open
def sim(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 (21/15) Open
def sim(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 sim(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.
Too many arguments (6/5) Open
def __init__(- Read upRead up
- Exclude checks
Used when a function or method takes too many arguments.
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
mode: str = 'winkler',- Read upRead up
- Exclude checks
TODO mode: str = 'winkler', ^ |
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
boost_threshold: float = 0.7,- Read upRead up
- Exclude checks
TODO boost_threshold: float = 0.7, ^ |
Wrong hanging indentation before block (add 4 spaces). Open
and (2 * num_com >= minv + i)- Read upRead up
- Exclude checks
TODO and (2 * num_com >= minv + i) ^ |
Wrong hanging indentation before block (add 4 spaces). Open
self._long_strings- Read upRead up
- Exclude checks
TODO self.longstrings ^ |
Wrong hanging indentation before block (add 4 spaces). Open
and (num_com > i + 1)- Read upRead up
- Exclude checks
TODO and (num_com > i + 1) ^ |
Wrong hanging indentation before block (add 4 spaces). Open
and (minv > 4)- Read upRead up
- Exclude checks
TODO and (minv > 4) ^ |
Wrong hanging indentation before block (add 4 spaces). Open
qval: int = 1,- Read upRead up
- Exclude checks
TODO qval: int = 1, ^ |
Wrong hanging indentation before block (add 4 spaces). Open
long_strings: bool = False,- Read upRead up
- Exclude checks
TODO long_strings: bool = False, ^ |
Wrong hanging indentation before block (add 4 spaces). Open
scaling_factor: float = 0.1,- Read upRead up
- Exclude checks
TODO scaling_factor: float = 0.1, ^ |