Cyclomatic complexity is too high in method _sb_r1. (9) Open
def _sb_r1(
self, term: str, r1_prefixes: Optional[Iterable[str]] = None
) -> int:
"""Return the R1 region, as defined in the Porter2 specification.
- 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 method _sb_ends_in_short_syllable. (9) Open
def _sb_ends_in_short_syllable(self, term: str) -> bool:
"""Return True iff term ends in a short syllable.
(...according to the Porter2 specification.)
- 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 _sb_r1
has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring. Open
def _sb_r1(
self, term: str, r1_prefixes: Optional[Iterable[str]] = None
) -> int:
"""Return the R1 region, as defined in the Porter2 specification.
- 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
Function _sb_ends_in_short_syllable
has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring. Open
def _sb_ends_in_short_syllable(self, term: str) -> bool:
"""Return True iff term ends in a short syllable.
(...according to the Porter2 specification.)
- 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
Too few public methods (1/2) Open
class _Snowball(_Stemmer):
- Read upRead up
- Exclude checks
Used when class has too few public methods, so be sure it's really worth it.
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
self, term: str, r1_prefixes: Optional[Iterable[str]] = None
- Read upRead up
- Exclude checks
TODO self, term: str, r1_prefixes: Optional[Iterable[str]] = None ^ |
Wrong hanging indentation before block (add 4 spaces). Open
term
- Read upRead up
- Exclude checks
TODO term ^ |
Consider using enumerate instead of iterating with range and len Open
for i in range(len(term)):
- 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
term[-3] not in self._vowels
- Read upRead up
- Exclude checks
TODO term[-3] not in self._vowels ^ |
Wrong hanging indentation before block (add 4 spaces). Open
self, term: str, r1_prefixes: Optional[Iterable[str]] = None
- Read upRead up
- Exclude checks
TODO self, term: str, r1_prefixes: Optional[Iterable[str]] = None ^ |
Wrong hanging indentation before block (add 4 spaces). Open
and term[-1] in self._codanonvowels
- Read upRead up
- Exclude checks
TODO and term[-1] in self._codanonvowels ^ |
Wrong hanging indentation before block (add 4 spaces). Open
and term[-2] in self._vowels
- Read upRead up
- Exclude checks
TODO and term[-2] in self._vowels ^ |
Wrong hanging indentation before block (add 4 spaces). Open
self, term: str, r1_prefixes: Optional[Iterable[str]] = None
- Read upRead up
- Exclude checks
TODO self, term: str, r1_prefixes: Optional[Iterable[str]] = None ^ |