Function _alignment_matrix has a Cognitive Complexity of 30 (exceeds 5 allowed). Consider refactoring. Open
def _alignment_matrix(
self, src: str, tar: str, backtrace: bool = True
) -> Union[np.ndarray, Tuple[np.ndarray, np.ndarray]]:
"""Return the phonetic edit distance alignment matrix.
- 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 _alignment_matrix. (17) Open
def _alignment_matrix(
self, src: str, tar: str, backtrace: bool = True
) -> Union[np.ndarray, Tuple[np.ndarray, np.ndarray]]:
"""Return the phonetic edit distance alignment matrix.
- 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 PhoneticEditDistance. (7) Open
class PhoneticEditDistance(Levenshtein):
"""Phonetic edit distance.
This is a variation on Levenshtein edit distance, intended for strings in
IPA, that compares individual phones based on their featural similarity.- 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 deeply nested control flow statements. Open
if backtrace:
trace_mat[i + 1, j + 1] = 2
if backtrace:Function __init__ has 5 arguments (exceeds 4 allowed). Consider refactoring. Open
def __init__(Avoid too many return statements within this function. Open
return cast(float, d_mat[src_len, tar_len])Refactor this function to reduce its Cognitive Complexity from 30 to the 15 allowed. Open
def _alignment_matrix(- 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 local variables (18/15) Open
def _alignment_matrix(- Read upRead up
- Exclude checks
Used when a function or method has too many local variables.
Unnecessary else after return Open
if int(d_mat[src_len, tar_len]) == d_mat[src_len, tar_len]:- 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.
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:
# ...
Unable to import 'numpy' Open
import numpy as np- Read upRead up
- Exclude checks
Used when pylint has been unable to import a module.
Unused variable 'sub_cost' Open
ins_cost, del_cost, sub_cost, trans_cost = self._cost- Read upRead up
- Exclude checks
Used when a variable is defined but not used.
Unused variable 'trans_cost' Open
ins_cost, del_cost, sub_cost, trans_cost = self._cost- Read upRead up
- Exclude checks
Used when a variable is defined but not used.
Wrong hanging indentation before block (add 4 spaces). Open
and j + 1 > 1- Read upRead up
- Exclude checks
TODO and j + 1 > 1 ^ |
Wrong hanging indentation before block (add 4 spaces). Open
normalizer: Callable[[List[float]], float] = max,- Read upRead up
- Exclude checks
TODO normalizer: Callable[[List[float]], float] = max, ^ |
Wrong hanging indentation before block (add 4 spaces). Open
mode: str = 'lev',- Read upRead up
- Exclude checks
TODO mode: str = 'lev', ^ |
Wrong hanging indentation before block (add 4 spaces). Open
and src_list[i - 1] == tar_list[j]- Read upRead up
- Exclude checks
TODO and srclist[i - 1] == tarlist[j] ^ |
Wrong hanging indentation before block (add 4 spaces). Open
self, src: str, tar: str, backtrace: bool = True- Read upRead up
- Exclude checks
TODO self, src: str, tar: str, backtrace: bool = True ^ |
Wrong hanging indentation before block (add 4 spaces). Open
and src_list[i] == tar_list[j - 1]- Read upRead up
- Exclude checks
TODO and srclist[i] == tarlist[j - 1] ^ |
Wrong hanging indentation before block (add 4 spaces). Open
cost: Tuple[float, float, float, float] = (1, 1, 1, 0.33333),- Read upRead up
- Exclude checks
TODO cost: Tuple[float, float, float, float] = (1, 1, 1, 0.33333), ^ |
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 ^ |
Wrong hanging indentation before block (add 4 spaces). Open
weights: Optional[Union[Iterable[float], Dict[str, float]]] = None,- Read upRead up
- Exclude checks
TODO weights: Optional[Union[Iterable[float], Dict[str, float]]] = None, ^ |
Wrong hanging indentation before block (add 4 spaces). Open
i + 1 > 1- Read upRead up
- Exclude checks
TODO i + 1 > 1 ^ |