Function dist_abs has a Cognitive Complexity of 53 (exceeds 5 allowed). Consider refactoring. Open
def dist_abs(self, src: str, tar: str) -> float:
"""Return the Sift4 Extended distance between two strings.
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 dist_abs. (25) Open
def dist_abs(self, src: str, tar: str) -> float:
"""Return the Sift4 Extended distance between two strings.
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. |
File _sift4_extended.py has 283 lines of code (exceeds 250 allowed). Consider refactoring. Open
# Copyright 2019-2020 by Christopher C. Little.
# This file is part of Abydos.
#
# Abydos is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published byCyclomatic complexity is too high in method __init__. (7) Open
def __init__(
self,
max_offset: int = 5,
max_distance: int = 0,
tokenizer: Optional[_Tokenizer] = None,- 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 __init__ has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring. Open
def __init__(
self,
max_offset: int = 5,
max_distance: int = 0,
tokenizer: Optional[_Tokenizer] = None,- 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 __init__ has 9 arguments (exceeds 4 allowed). Consider refactoring. Open
def __init__(Avoid deeply nested control flow statements. Open
if is_trans:
trans += self._transposition_cost_evaluator(
src_cur, tar_cur
)
elif not ofs['trans']:Method "__init__" has 10 parameters, which is greater than the 7 authorized. Open
self,
max_offset: int = 5,
max_distance: int = 0,
tokenizer: Optional[_Tokenizer] = None,
token_matcher: Optional[Callable[[str, str], bool]] = None,- Read upRead up
- Exclude checks
A long parameter list can indicate that a new structure should be created to wrap the numerous parameters or that the function is doing too many things.
Noncompliant Code Example
With a maximum number of 4 parameters:
def do_something(param1, param2, param3, param4, param5):
...
Compliant Solution
def do_something(param1, param2, param3, param4):
...
Refactor this function to reduce its Cognitive Complexity from 53 to the 15 allowed. Open
def dist_abs(self, src: str, tar: str) -> float:- 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 branches (19/12) Open
def dist_abs(self, src: str, tar: str) -> float:- Read upRead up
- Exclude checks
Used when a function or method has too many branches, making it hard to follow.
Too many instance attributes (8/7) Open
class Sift4Extended(_Distance):- Read upRead up
- Exclude checks
Used when class has too many instance attributes, try to reduce this to get a simpler (and so easier to use) class.
Unnecessary elif after break Open
if src_cur <= ofs['src_cur'] or tar_cur <= ofs['tar_cur']:- Read upRead up
- Exclude checks
Used in order to highlight an unnecessary block of code following an if containing a break statement. As such, it will warn when it encounters an else following a chain of ifs, all of them containing a break statement.
Too many statements (56/50) Open
def dist_abs(self, src: str, tar: str) -> float:- Read upRead up
- Exclude checks
Used when a function or method has too many statements. You should then split it in smaller functions / methods.
Too many arguments (9/5) Open
def __init__(- Read upRead up
- Exclude checks
Used when a function or method takes too many arguments.
Too many local variables (17/15) Open
def dist_abs(self, src: str, tar: str) -> float:- Read upRead up
- Exclude checks
Used when a function or method has too many local variables.
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
transposition_cost_evaluator: Optional[- Read upRead up
- Exclude checks
TODO transpositioncostevaluator: Optional[ ^ |
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
self._token_matcher(- Read upRead up
- Exclude checks
TODO self.tokenmatcher( ^ |
Wrong hanging indentation before block (add 4 spaces). Open
matching_evaluator: Optional[Callable[[str, str], float]] = None,- Read upRead up
- Exclude checks
TODO matching_evaluator: Optional[Callable[[str, str], float]] = None, ^ |
Wrong hanging indentation before block (add 4 spaces). Open
tokenizer: Optional[_Tokenizer] = None,- Read upRead up
- Exclude checks
TODO tokenizer: Optional[_Tokenizer] = None, ^ |
Wrong hanging indentation before block (add 4 spaces). Open
token_matcher: Optional[Callable[[str, str], bool]] = None,- Read upRead up
- Exclude checks
TODO token_matcher: Optional[Callable[[str, str], bool]] = None, ^ |
Wrong hanging indentation before block (add 4 spaces). Open
local_length_evaluator: Optional[Callable[[float], float]] = None,- Read upRead up
- Exclude checks
TODO locallengthevaluator: Optional[Callable[[float], float]] = None, ^ |
Wrong hanging indentation before block (add 4 spaces). Open
max_offset: int = 5,- Read upRead up
- Exclude checks
TODO max_offset: int = 5, ^ |
Wrong hanging indentation before block (add 4 spaces). Open
(src_cur + i < src_len) or (tar_cur + i < tar_len)- Read upRead up
- Exclude checks
TODO (srccur + i < srclen) or (tarcur + i < tarlen) ^ |
Wrong hanging indentation before block (add 4 spaces). Open
max_distance: int = 0,- Read upRead up
- Exclude checks
TODO max_distance: int = 0, ^ |
Wrong hanging indentation before block (add 4 spaces). Open
self._token_matcher(- Read upRead up
- Exclude checks
TODO self.tokenmatcher( ^ |
Wrong hanging indentation before block (add 4 spaces). Open
transpositions_evaluator: Optional[- Read upRead up
- Exclude checks
TODO transpositions_evaluator: Optional[ ^ |