Function encode has a Cognitive Complexity of 108 (exceeds 5 allowed). Consider refactoring. Open
def encode(self, word: str) -> str:
"""Return the Metaphone code for a word.
Based on Lawrence Philips' Pick BASIC code from 1990
:cite:`Philips:1990`, as described in :cite:`Philips:1990b`.- 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 encode. (81) Open
def encode(self, word: str) -> str:
"""Return the Metaphone code for a word.
Based on Lawrence Philips' Pick BASIC code from 1990
:cite:`Philips:1990`, as described in :cite:`Philips:1990b`.- 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 Metaphone. (42) Open
class Metaphone(_Phonetic):
"""Metaphone.
Based on Lawrence Philips' Pick BASIC code from 1990 :cite:`Philips:1990`,
as described in :cite:`Philips:1990b`.- 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. |
Consider simplifying this complex logical expression. Open
if ename[i + 1 : i + 2] == 'H' and not (
i + 1 == elen or ename[i + 2 : i + 3] not in self._uc_v_set
):
continue
elif i > 0 and (Avoid deeply nested control flow statements. Open
if (
i == 0
and i + 1 < elen
and ename[i + 2 : i + 3] not in self._uc_v_set
):Refactor this function to reduce its Cognitive Complexity from 113 to the 15 allowed. Open
def encode(self, word: str) -> str:- 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 (57/12) Open
def encode(self, word: str) -> str:- Read upRead up
- Exclude checks
Used when a function or method has too many branches, making it hard to follow.
Too many statements (101/50) Open
def encode(self, word: str) -> str:- Read upRead up
- Exclude checks
Used when a function or method has too many statements. You should then split it in smaller functions / methods.
Unnecessary elif after continue Open
if ename[i + 1 : i + 2] == 'H' and not (- Read upRead up
- Exclude checks
Used in order to highlight an unnecessary block of code following an if containing a continue statement. As such, it will warn when it encounters an else following a chain of ifs, all of them containing a continue statement.
Unnecessary else after continue Open
if i > 0 and ename[i - 1] == 'C':- Read upRead up
- Exclude checks
Used in order to highlight an unnecessary block of code following an if containing a continue statement. As such, it will warn when it encounters an else following a chain of ifs, all of them containing a continue statement.
Unnecessary elif after continue Open
if (- Read upRead up
- Exclude checks
Used in order to highlight an unnecessary block of code following an if containing a continue statement. As such, it will warn when it encounters an else following a chain of ifs, all of them containing a continue statement.
Either merge this branch with the identical one on line "226" or change one of the implementations. Open
metaph += 'X'- Read upRead up
- Exclude checks
Having two branches in the same if structure with the same implementation is at best duplicate code, and at worst a coding error. If
the same logic is truly needed for both instances, then they should be combined.
Noncompliant Code Example
if 0 <= a < 10:
do_the_thing()
elif 10 <= a < 20:
do_the_other_thing()
elif 20 <= a < 50:
do_the_thing() # Noncompliant; duplicates first condition
else:
do_the_rest()
b = 4 if a > 12 else 4
Compliant Solution
if (0 <= a < 10) or (20 <= a < 50):
do_the_thing()
elif 10 <= a < 20:
do_the_other_thing()
else:
do_the_rest()
b = 4
or
if 0 <= a < 10:
do_the_thing()
elif 10 <= a < 20:
do_the_other_thing()
elif 20 <= a < 50:
do_the_third_thing()
else:
do_the_rest()
b = 8 if a > 12 else 4
Either merge this branch with the identical one on line "166" or change one of the implementations. Open
continue- Read upRead up
- Exclude checks
Having two branches in the same if structure with the same implementation is at best duplicate code, and at worst a coding error. If
the same logic is truly needed for both instances, then they should be combined.
Noncompliant Code Example
if 0 <= a < 10:
do_the_thing()
elif 10 <= a < 20:
do_the_other_thing()
elif 20 <= a < 50:
do_the_thing() # Noncompliant; duplicates first condition
else:
do_the_rest()
b = 4 if a > 12 else 4
Compliant Solution
if (0 <= a < 10) or (20 <= a < 50):
do_the_thing()
elif 10 <= a < 20:
do_the_other_thing()
else:
do_the_rest()
b = 4
or
if 0 <= a < 10:
do_the_thing()
elif 10 <= a < 20:
do_the_other_thing()
elif 20 <= a < 50:
do_the_third_thing()
else:
do_the_rest()
b = 8 if a > 12 else 4
Either merge this branch with the identical one on line "166" or change one of the implementations. Open
continue- Read upRead up
- Exclude checks
Having two branches in the same if structure with the same implementation is at best duplicate code, and at worst a coding error. If
the same logic is truly needed for both instances, then they should be combined.
Noncompliant Code Example
if 0 <= a < 10:
do_the_thing()
elif 10 <= a < 20:
do_the_other_thing()
elif 20 <= a < 50:
do_the_thing() # Noncompliant; duplicates first condition
else:
do_the_rest()
b = 4 if a > 12 else 4
Compliant Solution
if (0 <= a < 10) or (20 <= a < 50):
do_the_thing()
elif 10 <= a < 20:
do_the_other_thing()
else:
do_the_rest()
b = 4
or
if 0 <= a < 10:
do_the_thing()
elif 10 <= a < 20:
do_the_other_thing()
elif 20 <= a < 50:
do_the_third_thing()
else:
do_the_rest()
b = 8 if a > 12 else 4
Either merge this branch with the identical one on line "166" or change one of the implementations. Open
continue- Read upRead up
- Exclude checks
Having two branches in the same if structure with the same implementation is at best duplicate code, and at worst a coding error. If
the same logic is truly needed for both instances, then they should be combined.
Noncompliant Code Example
if 0 <= a < 10:
do_the_thing()
elif 10 <= a < 20:
do_the_other_thing()
elif 20 <= a < 50:
do_the_thing() # Noncompliant; duplicates first condition
else:
do_the_rest()
b = 4 if a > 12 else 4
Compliant Solution
if (0 <= a < 10) or (20 <= a < 50):
do_the_thing()
elif 10 <= a < 20:
do_the_other_thing()
else:
do_the_rest()
b = 4
or
if 0 <= a < 10:
do_the_thing()
elif 10 <= a < 20:
do_the_other_thing()
elif 20 <= a < 50:
do_the_third_thing()
else:
do_the_rest()
b = 8 if a > 12 else 4
Either merge this branch with the identical one on line "195" or change one of the implementations. Open
continue- Read upRead up
- Exclude checks
Having two branches in the same if structure with the same implementation is at best duplicate code, and at worst a coding error. If
the same logic is truly needed for both instances, then they should be combined.
Noncompliant Code Example
if 0 <= a < 10:
do_the_thing()
elif 10 <= a < 20:
do_the_other_thing()
elif 20 <= a < 50:
do_the_thing() # Noncompliant; duplicates first condition
else:
do_the_rest()
b = 4 if a > 12 else 4
Compliant Solution
if (0 <= a < 10) or (20 <= a < 50):
do_the_thing()
elif 10 <= a < 20:
do_the_other_thing()
else:
do_the_rest()
b = 4
or
if 0 <= a < 10:
do_the_thing()
elif 10 <= a < 20:
do_the_other_thing()
elif 20 <= a < 50:
do_the_third_thing()
else:
do_the_rest()
b = 8 if a > 12 else 4
Either merge this branch with the identical one on line "140" or change one of the implementations. Open
metaph += 'K'- Read upRead up
- Exclude checks
Having two branches in the same if structure with the same implementation is at best duplicate code, and at worst a coding error. If
the same logic is truly needed for both instances, then they should be combined.
Noncompliant Code Example
if 0 <= a < 10:
do_the_thing()
elif 10 <= a < 20:
do_the_other_thing()
elif 20 <= a < 50:
do_the_thing() # Noncompliant; duplicates first condition
else:
do_the_rest()
b = 4 if a > 12 else 4
Compliant Solution
if (0 <= a < 10) or (20 <= a < 50):
do_the_thing()
elif 10 <= a < 20:
do_the_other_thing()
else:
do_the_rest()
b = 4
or
if 0 <= a < 10:
do_the_thing()
elif 10 <= a < 20:
do_the_other_thing()
elif 20 <= a < 50:
do_the_third_thing()
else:
do_the_rest()
b = 8 if a > 12 else 4
Merge this if statement with the enclosing one. Open
if ename[i - 1 : i] != 'T':- Read upRead up
- Exclude checks
Merging collapsible if statements increases the code's readability.
Noncompliant Code Example
if condition1:
if condition2:
# ...
Compliant Solution
if condition1 and condition2:
# ...
Wrong hanging indentation before block (add 4 spaces). Open
i > 0- Read upRead up
- Exclude checks
TODO i > 0 ^ |
Wrong hanging indentation before block (add 4 spaces). Open
i > 0- Read upRead up
- Exclude checks
TODO i > 0 ^ |
Wrong hanging indentation before block (add 4 spaces). Open
and ename[i - 1] == 'S'- Read upRead up
- Exclude checks
TODO and ename[i - 1] == 'S' ^ |
Wrong hanging indentation before block (add 4 spaces). Open
and ename[i + 1 : i + 2] in self._frontv- Read upRead up
- Exclude checks
TODO and ename[i + 1 : i + 2] in self._frontv ^ |
Wrong hanging indentation before block (add 4 spaces). Open
i - 1 > 0- Read upRead up
- Exclude checks
TODO i - 1 > 0 ^ |
Wrong hanging indentation before block (add 4 spaces). Open
and ename[i - 1] in self._uc_v_set- Read upRead up
- Exclude checks
TODO and ename[i - 1] in self.ucv_set ^ |
Wrong hanging indentation before block (add 4 spaces). Open
and ename[i + 1] == 'I'- Read upRead up
- Exclude checks
TODO and ename[i + 1] == 'I' ^ |
Wrong hanging indentation before block (add 4 spaces). Open
ename[i + 1 : i + 2] == 'G'- Read upRead up
- Exclude checks
TODO ename[i + 1 : i + 2] == 'G' ^ |
Wrong hanging indentation before block (add 4 spaces). Open
and ename[i + 2] in 'OA'- Read upRead up
- Exclude checks
TODO and ename[i + 2] in 'OA' ^ |
Wrong hanging indentation before block (add 4 spaces). Open
and i + 1 <= elen- Read upRead up
- Exclude checks
TODO and i + 1 <= elen ^ |
Wrong hanging indentation before block (add 4 spaces). Open
and i + 2 <= elen- Read upRead up
- Exclude checks
TODO and i + 2 <= elen ^ |
Wrong hanging indentation before block (add 4 spaces). Open
and ename[i + 2] in {'A', 'O'}- Read upRead up
- Exclude checks
TODO and ename[i + 2] in {'A', 'O'} ^ |
Wrong hanging indentation before block (add 4 spaces). Open
and i + 1 < elen- Read upRead up
- Exclude checks
TODO and i + 1 < elen ^ |
Wrong hanging indentation before block (add 4 spaces). Open
and ename[i + 2 : i + 3] not in self._uc_v_set- Read upRead up
- Exclude checks
TODO and ename[i + 2 : i + 3] not in self.ucv_set ^ |
Wrong hanging indentation before block (add 4 spaces). Open
and i + 2 <= elen- Read upRead up
- Exclude checks
TODO and i + 2 <= elen ^ |
Wrong hanging indentation before block (add 4 spaces). Open
and ename[i - 1] == ename[i]- Read upRead up
- Exclude checks
TODO and ename[i - 1] == ename[i] ^ |
Wrong hanging indentation before block (add 4 spaces). Open
i > 0- Read upRead up
- Exclude checks
TODO i > 0 ^ |
Consider using enumerate instead of iterating with range and len Open
for i in range(len(ename)):- 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
and ename[i + 2 : i + 3] in self._frontv- Read upRead up
- Exclude checks
TODO and ename[i + 2 : i + 3] in self._frontv ^ |
Wrong hanging indentation before block (add 4 spaces). Open
and ename[i - 1] == 'D'- Read upRead up
- Exclude checks
TODO and ename[i - 1] == 'D' ^ |
Wrong hanging indentation before block (add 4 spaces). Open
and ename[i + 1] == 'I'- Read upRead up
- Exclude checks
TODO and ename[i + 1] == 'I' ^ |
Wrong hanging indentation before block (add 4 spaces). Open
and ename[i + 1] in self._frontv- Read upRead up
- Exclude checks
TODO and ename[i + 1] in self._frontv ^ |
Wrong hanging indentation before block (add 4 spaces). Open
and i > 0- Read upRead up
- Exclude checks
TODO and i > 0 ^ |
Wrong hanging indentation before block (add 4 spaces). Open
i + 1 == elen or ename[i + 2 : i + 3] not in self._uc_v_set- Read upRead up
- Exclude checks
TODO i + 1 == elen or ename[i + 2 : i + 3] not in self.ucv_set ^ |
Wrong hanging indentation before block (add 4 spaces). Open
(i + 1 == elen and ename[i + 1] == 'N')- Read upRead up
- Exclude checks
TODO (i + 1 == elen and ename[i + 1] == 'N') ^ |
Wrong hanging indentation before block (add 4 spaces). Open
or (i + 3 == elen and ename[i + 1 : i + 4] == 'NED')- Read upRead up
- Exclude checks
TODO or (i + 3 == elen and ename[i + 1 : i + 4] == 'NED') ^ |
Wrong hanging indentation before block (add 4 spaces). Open
ename[i] not in {'G', 'T'}- Read upRead up
- Exclude checks
TODO ename[i] not in {'G', 'T'} ^ |
Wrong hanging indentation before block (add 4 spaces). Open
i > 0- Read upRead up
- Exclude checks
TODO i > 0 ^ |
Wrong hanging indentation before block (add 4 spaces). Open
i == 0- Read upRead up
- Exclude checks
TODO i == 0 ^ |
Wrong hanging indentation before block (add 4 spaces). Open
and ename[i + 1 : i + 2] not in self._uc_v_set- Read upRead up
- Exclude checks
TODO and ename[i + 1 : i + 2] not in self.ucv_set ^ |