Function alignments has a Cognitive Complexity of 45 (exceeds 5 allowed). Consider refactoring. Open
def alignments(
self, src: str, tar: str, top_n: Optional[int] = None
) -> List[Alignment]:
"""Return the Covington alignments of two strings.
- 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 alignments. (8) Open
def alignments(
self, src: str, tar: str, top_n: Optional[int] = None
) -> List[Alignment]:
"""Return the Covington alignments of two strings.
- 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. |
Avoid too many return statements within this function. Open
return self._weights[2]Avoid too many return statements within this function. Open
return self._weights[5]Avoid too many return statements within this function. Open
return self._weights[1]Avoid too many return statements within this function. Open
return self._weights[2]Avoid too many return statements within this function. Open
return self._weights[4]Avoid too many return statements within this function. Open
return self._weights[0]Avoid too many return statements within this function. Open
return terminals[:top_n]Avoid too many return statements within this function. Open
return self._weights[3]Refactor this function to reduce its Cognitive Complexity from 51 to the 15 allowed. Open
def alignments(- 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 else after return Open
if top_n 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.
Unnecessary else after return Open
if s[-2:] == '--':- 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.
Unnecessary else after return Open
if t[-2:] == '--':- 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.
Useless return at end of function or method Open
def _add_alignments(- Read upRead up
- Exclude checks
Emitted when a single return or return None statement is found at the end of function or method definition. This statement can safely be removed because Python will implicitly return None
Too many branches (13/12) Open
def _cost(s: str, t: str) -> float:- Read upRead up
- Exclude checks
Used when a function or method has too many branches, making it hard to follow.
Unnecessary else after return Open
if s in self._consonants or s in self._glides:- 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.
Too many return statements (11/6) Open
def _cost(s: str, t: str) -> float:- Read upRead up
- Exclude checks
Used when a function or method has too many return statement, making it hard to follow.
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
**kwargs: Any- Read upRead up
- Exclude checks
TODO **kwargs: Any ^ |
Variable name sd doesn't conform to snake_case naming style Open
sd = unicode_normalize('NFKD', s)- Read upRead up
- Exclude checks
Used when the name doesn't conform to naming rules associated to its type (constant, variable, class...).
Wrong hanging indentation before block (add 4 spaces). Open
top_n < len(terminals) and terminals[top_n].score == top_score- Read upRead up
- Exclude checks
TODO topn < len(terminals) and terminals[topn].score == top_score ^ |
Argument name s doesn't conform to snake_case naming style Open
def _cost(s: str, t: str) -> float:- Read upRead up
- Exclude checks
Used when the name doesn't conform to naming rules associated to its type (constant, variable, class...).
Wrong hanging indentation before block (add 4 spaces). Open
weights: Tuple[int, int, int, int, int, int, int, int] = (- Read upRead up
- Exclude checks
TODO weights: Tuple[int, int, int, int, int, int, int, int] = ( ^ |
Argument name t doesn't conform to snake_case naming style Open
def _cost(s: str, t: str) -> float:- Read upRead up
- Exclude checks
Used when the name doesn't conform to naming rules associated to its type (constant, variable, class...).
Variable name td doesn't conform to snake_case naming style Open
td = unicode_normalize('NFKD', t)- Read upRead up
- Exclude checks
Used when the name doesn't conform to naming rules associated to its type (constant, variable, class...).
Wrong hanging indentation before block (add 4 spaces). Open
self, src: str, tar: str, top_n: Optional[int] = None- Read upRead up
- Exclude checks
TODO self, src: str, tar: str, top_n: Optional[int] = None ^ |
Wrong hanging indentation before block (add 4 spaces). Open
cost: float, src: str, tar: str, src_align: str, tar_align: str- Read upRead up
- Exclude checks
TODO cost: float, src: str, tar: str, srcalign: str, taralign: str ^ |