Function fingerprint_tuple has a Cognitive Complexity of 125 (exceeds 5 allowed). Consider refactoring. Open
def fingerprint_tuple(
self, lname: str, fname: str = '', qual: str = '', normalize: int = 0
) -> Tuple[str, str, str]:
"""Build the Synoname toolcode.
- 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 fingerprint_tuple. (50) Open
def fingerprint_tuple(
self, lname: str, fname: str = '', qual: str = '', normalize: int = 0
) -> Tuple[str, str, str]:
"""Build the Synoname toolcode.
- 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 _synoname_toolcode.py has 474 lines of code (exceeds 250 allowed). Consider refactoring. Open
# Copyright 2018-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 class SynonameToolcode. (26) Open
class SynonameToolcode(_Fingerprint):
"""Synoname Toolcode.
Cf. :cite:`Getty:1991,Gross:1991`.
- 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 not any(
abbr in fname for abbr in ('i.', 'v.', 'x.')
):
full_name = full_name[:loc]
toolcode[7] += '{:03d}'.format(num) + 'a'Avoid deeply nested control flow statements. Open
if roman:
if not any(
abbr in fname for abbr in ('i.', 'v.', 'x.')
):
full_name = (Refactor this function to reduce its Cognitive Complexity from 127 to the 15 allowed. Open
def fingerprint_tuple(- 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 (25/15) Open
def fingerprint_tuple(- Read upRead up
- Exclude checks
Used when a function or method has too many local variables.
Too many nested blocks (6/5) Open
for num, special in enumerate(self._synoname_special_table):- Read upRead up
- Exclude checks
Used when a function or a method has too many nested blocks. This makes the code less understandable and maintainable.
Too many branches (46/12) Open
def fingerprint_tuple(- Read upRead up
- Exclude checks
Used when a function or method has too many branches, making it hard to follow.
Too many statements (101/50) Open
def fingerprint_tuple(- 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 nested blocks (7/5) Open
for num, special in enumerate(self._synoname_special_table):- Read upRead up
- Exclude checks
Used when a function or a method has too many nested blocks. This makes the code less understandable and maintainable.
Parameters differ from overridden 'fingerprint' method Open
def fingerprint(- Read upRead up
- Exclude checks
Used when a method has a different number of arguments than in the implemented interface or in an overridden method.
Wrong hanging indentation before block (add 4 spaces). Open
self, lname: str, fname: str = '', qual: str = '', normalize: int = 0- Read upRead up
- Exclude checks
TODO self, lname: str, fname: str = '', qual: str = '', normalize: int = 0 ^ |
Wrong hanging indentation before block (add 4 spaces). Open
numeral: str, fname: str, lname: str- Read upRead up
- Exclude checks
TODO numeral: str, fname: str, lname: str ^ |
Wrong hanging indentation before block (add 4 spaces). Open
and (len(fname[loc:]) == len(numeral))- Read upRead up
- Exclude checks
TODO and (len(fname[loc:]) == len(numeral)) ^ |
Wrong hanging indentation before block (add 4 spaces). Open
self, lname: str, fname: str = '', qual: str = '', normalize: int = 0- Read upRead up
- Exclude checks
TODO self, lname: str, fname: str = '', qual: str = '', normalize: int = 0 ^ |
Wrong hanging indentation before block (add 4 spaces). Open
loc != -1- Read upRead up
- Exclude checks
TODO loc != -1 ^ |
Wrong hanging indentation before block (add 4 spaces). Open
abbr in fname for abbr in ('i.', 'v.', 'x.')- Read upRead up
- Exclude checks
TODO abbr in fname for abbr in ('i.', 'v.', 'x.') ^ |
Wrong hanging indentation before block (add 4 spaces). Open
abbr in fname for abbr in ('i.', 'v.', 'x.')- Read upRead up
- Exclude checks
TODO abbr in fname for abbr in ('i.', 'v.', 'x.') ^ |
Wrong hanging indentation before block (add 4 spaces). Open
or fname[loc + len(numeral)] in {' ', ','}- Read upRead up
- Exclude checks
TODO or fname[loc + len(numeral)] in {' ', ','} ^ |
Wrong hanging indentation before block (add 4 spaces). Open
loc == len(full_name) - len(match_context)- Read upRead up
- Exclude checks
TODO loc == len(fullname) - len(matchcontext) ^ |