Function stem has a Cognitive Complexity of 73 (exceeds 5 allowed). Consider refactoring. Open
def stem(self, word: str) -> str:
"""Return Snowball Dutch stem.
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 stem. (63) Open
def stem(self, word: str) -> str:
"""Return Snowball Dutch stem.
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 SnowballDutch. (34) Open
class SnowballDutch(_Snowball):
"""Snowball Dutch stemmer.
The Snowball Dutch stemmer is defined at:
http://snowball.tartarus.org/algorithms/dutch/stemmer.html- 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 (
len(word) >= 4
and word[-3] == word[-2]
and word[-2] in {'a', 'e', 'o', 'u'}
and word[-4] not in self._vowelsConsider simplifying this complex logical expression. Open
if i == 0 and word[0] == 'y':
word = 'Y' + word[1:]
elif word[i] == 'y' and word[i - 1] in self._vowels:
word = word[:i] + 'Y' + word[i + 1 :]
elif (Refactor this function to reduce its Cognitive Complexity from 82 to the 15 allowed. Open
def stem(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 few public methods (1/2) Open
class SnowballDutch(_Snowball):- Read upRead up
- Exclude checks
Used when class has too few public methods, so be sure it's really worth it.
Method could be a function Open
def _undouble(self, word: str) -> str:- Read upRead up
- Exclude checks
Used when a method doesn't use its bound instance, and so could be written as a function.
Too many boolean expressions in if statement (6/5) Open
len(word) >= 4- Read upRead up
- Exclude checks
Used when an if statement contains too many boolean expressions.
Too many branches (38/12) Open
def stem(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 (65/50) Open
def stem(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.
Merge this if statement with the enclosing one. Open
if (- 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:
# ...
Merge this if statement with the enclosing one. Open
if len(word[r1_start:]) >= 2 and (- 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:
# ...
Merge this if statement with the enclosing one. Open
if len(word[r2_start:]) >= 2 and word[-3] != 'e':- 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:
# ...
Merge this if statement with the enclosing one. Open
if len(word[r1_start:]) >= 1 and word[-2] not in self._vowels:- 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:
# ...
Merge this if statement with the enclosing one. Open
if len(word[r2_start:]) >= 4 and word[-5] != 'c':- 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:
# ...
Merge this if statement with the enclosing one. Open
if (- 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
and word[-3] not in self._not_s_endings- Read upRead up
- Exclude checks
TODO and word[-3] not in self.nots_endings ^ |
Wrong hanging indentation before block (add 4 spaces). Open
and word[-2] in {'a', 'e', 'o', 'u'}- Read upRead up
- Exclude checks
TODO and word[-2] in {'a', 'e', 'o', 'u'} ^ |
Wrong hanging indentation before block (add 4 spaces). Open
and i + 1 < len(word)- Read upRead up
- Exclude checks
TODO and i + 1 < len(word) ^ |
Consider using enumerate instead of iterating with range and len Open
for i in range(len(word)):- 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 word[-3] != 'e'- Read upRead up
- Exclude checks
TODO and word[-3] != 'e' ^ |
Wrong hanging indentation before block (add 4 spaces). Open
word[i] == 'i'- Read upRead up
- Exclude checks
TODO word[i] == 'i' ^ |
Wrong hanging indentation before block (add 4 spaces). Open
word[-3] not in self._vowels and word[-5:-2] != 'gem'- Read upRead up
- Exclude checks
TODO word[-3] not in self._vowels and word[-5:-2] != 'gem' ^ |
Wrong hanging indentation before block (add 4 spaces). Open
and word[-1] == word[-2]- Read upRead up
- Exclude checks
TODO and word[-1] == word[-2] ^ |
Wrong hanging indentation before block (add 4 spaces). Open
and word[i - 1] in self._vowels- Read upRead up
- Exclude checks
TODO and word[i - 1] in self._vowels ^ |
Wrong hanging indentation before block (add 4 spaces). Open
and word[-3] == word[-2]- Read upRead up
- Exclude checks
TODO and word[-3] == word[-2] ^ |
Wrong hanging indentation before block (add 4 spaces). Open
and word[-4] not in self._vowels- Read upRead up
- Exclude checks
TODO and word[-4] not in self._vowels ^ |
Wrong hanging indentation before block (add 4 spaces). Open
word[-3] not in self._vowels and word[-5:-2] != 'gem'- Read upRead up
- Exclude checks
TODO word[-3] not in self._vowels and word[-5:-2] != 'gem' ^ |
Wrong hanging indentation before block (add 4 spaces). Open
and word[-2] not in self._not_s_endings- Read upRead up
- Exclude checks
TODO and word[-2] not in self.nots_endings ^ |
Wrong hanging indentation before block (add 4 spaces). Open
len(word[r1_start:]) >= 1- Read upRead up
- Exclude checks
TODO len(word[r1_start:]) >= 1 ^ |
Consider using enumerate instead of iterating with range and len Open
for i in range(0, len(word)):- 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 word[-1] in {'d', 'k', 't'}- Read upRead up
- Exclude checks
TODO and word[-1] in {'d', 'k', 't'} ^ |
Wrong hanging indentation before block (add 4 spaces). Open
word[-4] not in self._vowels and word[-6:-3] != 'gem'- Read upRead up
- Exclude checks
TODO word[-4] not in self._vowels and word[-6:-3] != 'gem' ^ |
Wrong hanging indentation before block (add 4 spaces). Open
and word[-2] not in self._vowels- Read upRead up
- Exclude checks
TODO and word[-2] not in self._vowels ^ |
Wrong hanging indentation before block (add 4 spaces). Open
word[-2:] == 'ig'- Read upRead up
- Exclude checks
TODO word[-2:] == 'ig' ^ |
Wrong hanging indentation before block (add 4 spaces). Open
and word[-1] != 'I'- Read upRead up
- Exclude checks
TODO and word[-1] != 'I' ^ |
Wrong hanging indentation before block (add 4 spaces). Open
len(word) > 1- Read upRead up
- Exclude checks
TODO len(word) > 1 ^ |
Wrong hanging indentation before block (add 4 spaces). Open
len(word[r1_start:]) >= 2- Read upRead up
- Exclude checks
TODO len(word[r1_start:]) >= 2 ^ |
Wrong hanging indentation before block (add 4 spaces). Open
and len(word[r2_start:]) >= 2- Read upRead up
- Exclude checks
TODO and len(word[r2_start:]) >= 2 ^ |
Wrong hanging indentation before block (add 4 spaces). Open
and word[i + 1] in self._vowels- Read upRead up
- Exclude checks
TODO and word[i + 1] in self._vowels ^ |
Wrong hanging indentation before block (add 4 spaces). Open
len(word[r1_start:]) >= 1- Read upRead up
- Exclude checks
TODO len(word[r1_start:]) >= 1 ^ |
Wrong hanging indentation before block (add 4 spaces). Open
len(word) >= 4- Read upRead up
- Exclude checks
TODO len(word) >= 4 ^ |
Wrong hanging indentation before block (add 4 spaces). Open
and word[-1] not in self._vowels- Read upRead up
- Exclude checks
TODO and word[-1] not in self._vowels ^ |