Function corpus_importer has a Cognitive Complexity of 21 (exceeds 5 allowed). Consider refactoring. Open
def corpus_importer(
self,
corpus: Corpus,
n_val: int = 1,
bos: str = '_START_',- 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 corpus_importer. (12) Open
def corpus_importer(
self,
corpus: Corpus,
n_val: int = 1,
bos: str = '_START_',- 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. |
Refactor this function to reduce its Cognitive Complexity from 22 to the 15 allowed. Open
def corpus_importer(- 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 return Open
if corpus is None:- Read upRead up
- Exclude checks
Used in order to highlight an unnecessary block of code following an if containing a return statement. As such, it will warn when it encounters an else following a chain of ifs, all of them containing a return statement.
Wrong hanging indentation before block (add 4 spaces). Open
self,- Read upRead up
- Exclude checks
TODO self, ^ |
Wrong hanging indentation before block (add 4 spaces). Open
self, corpus: Any, words: List[str], count: int- Read upRead up
- Exclude checks
TODO self, corpus: Any, words: List[str], count: int ^ |
Wrong hanging indentation before block (add 4 spaces). Open
n_val: int = 1,- Read upRead up
- Exclude checks
TODO n_val: int = 1, ^ |
Wrong hanging indentation before block (add 4 spaces). Open
self,- Read upRead up
- Exclude checks
TODO self, ^ |
Wrong hanging indentation before block (add 4 spaces). Open
bos: str = '_START_',- Read upRead up
- Exclude checks
TODO bos: str = 'START', ^ |
Wrong hanging indentation before block (add 4 spaces). Open
eos: str = '_END_',- Read upRead up
- Exclude checks
TODO eos: str = 'END', ^ |
Wrong hanging indentation before block (add 4 spaces). Open
corpus: Corpus,- Read upRead up
- Exclude checks
TODO corpus: Corpus, ^ |
Wrong hanging indentation before block (add 4 spaces). Open
ngram: Union[str, List[str]],- Read upRead up
- Exclude checks
TODO ngram: Union[str, List[str]], ^ |
Wrong hanging indentation before block (add 4 spaces). Open
corpus: Optional[TCounter[Optional[str]]] = None,- Read upRead up
- Exclude checks
TODO corpus: Optional[TCounter[Optional[str]]] = None, ^ |