Function dist_abs
has a Cognitive Complexity of 53 (exceeds 5 allowed). Consider refactoring. Open
def dist_abs(self, src: str, tar: str) -> float:
"""Return the "common" Sift4 distance between two terms.
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. (25) Open
def dist_abs(self, src: str, tar: str) -> float:
"""Return the "common" Sift4 distance between two terms.
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 Sift4. (9) Open
class Sift4(_Distance):
"""Sift4 Common version.
This is an approximation of edit distance, described in
:cite:`Zackwehdex:2014`.
- 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
if is_trans:
trans += 1
elif not ofs['trans']:
ofs['trans'] = True
trans += 1
Refactor this function to reduce its Cognitive Complexity from 53 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
Unnecessary elif
after break
Open
if src_cur <= ofs['src_cur'] or tar_cur <= ofs['tar_cur']:
- Read upRead up
- Exclude checks
Used in order to highlight an unnecessary block of code following an if containing a break statement. As such, it will warn when it encounters an else following a chain of ifs, all of them containing a break statement.
Too many statements (54/50) Open
def dist_abs(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 branches (19/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.
Wrong hanging indentation before block (add 4 spaces). Open
self, max_offset: int = 5, max_distance: int = 0, **kwargs: Any
- Read upRead up
- Exclude checks
TODO self, maxoffset: int = 5, maxdistance: int = 0, **kwargs: Any ^ |
Wrong hanging indentation before block (add 4 spaces). Open
src[src_cur] == tar[tar_cur + i]
- Read upRead up
- Exclude checks
TODO src[srccur] == tar[tarcur + i] ^ |
Wrong hanging indentation before block (add 4 spaces). Open
(src_cur + i < src_len) or (tar_cur + i < tar_len)
- Read upRead up
- Exclude checks
TODO (srccur + i < srclen) or (tarcur + i < tarlen) ^ |
Wrong hanging indentation before block (add 4 spaces). Open
src[src_cur + i] == tar[tar_cur]
- Read upRead up
- Exclude checks
TODO src[srccur + i] == tar[tarcur] ^ |