Cyclomatic complexity is too high in method encode. (38) Open
def encode(self, lname: str) -> str:
"""Calculate the PSHP Soundex/Viewex Coding of a last name.
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. |
Function encode has a Cognitive Complexity of 40 (exceeds 5 allowed). Consider refactoring. Open
def encode(self, lname: str) -> str:
"""Calculate the PSHP Soundex/Viewex Coding of a last name.
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 class PSHPSoundexLast. (14) Open
class PSHPSoundexLast(_Phonetic):
"""PSHP Soundex/Viewex Coding of a last name.
This coding is based on :cite:`Hershberg:1976`.
- 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 encode has 29 lines of code (exceeds 25 allowed). Consider refactoring. Open
def encode(self, lname: str) -> str:
"""Calculate the PSHP Soundex/Viewex Coding of a last name.
Parameters
----------Refactor this function to reduce its Cognitive Complexity from 42 to the 15 allowed. Open
def encode(self, lname: 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 statements (79/50) Open
def encode(self, lname: 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.
Too many branches (32/12) Open
def encode(self, lname: str) -> str:- Read upRead up
- Exclude checks
Used when a function or method has too many branches, making it hard to follow.
Either merge this branch with the identical one on line "162" or change one of the implementations. Open
lname = 'K' + lname[1:]- 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
Parameters differ from overridden 'encode_alpha' method Open
def encode_alpha(self, lname: str) -> str:- Read upRead up
- Exclude checks
Used when a method has a different number of arguments than in the implemented interface or in an overridden method.
Parameters differ from overridden 'encode' method Open
def encode(self, lname: str) -> str:- Read upRead up
- Exclude checks
Used when a method has a different number of arguments than in the implemented interface or in an overridden method.