Function encode has a Cognitive Complexity of 48 (exceeds 5 allowed). Consider refactoring. Open
def encode(self, word: str) -> str:
"""Return the Phonix code for a word.
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
File _phonix.py has 349 lines of code (exceeds 250 allowed). Consider refactoring. Open
# Copyright 2014-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 encode. (8) Open
def encode(self, word: str) -> str:
"""Return the Phonix code for a word.
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. |
Refactor this function to reduce its Cognitive Complexity from 48 to the 15 allowed. Open
def encode(self, word: str) -> str:- 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 pre or post:- 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 elif after return Open
if not pre:- 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
word: str,- Read upRead up
- Exclude checks
TODO word: str, ^ |
Wrong hanging indentation before block (add 4 spaces). Open
src: str,- Read upRead up
- Exclude checks
TODO src: str, ^ |
Wrong hanging indentation before block (add 4 spaces). Open
tar: str,- Read upRead up
- Exclude checks
TODO tar: str, ^ |
Wrong hanging indentation before block (add 4 spaces). Open
word: str, src: str, tar: str, pre: Optional[Set[str]] = None- Read upRead up
- Exclude checks
TODO word: str, src: str, tar: str, pre: Optional[Set[str]] = None ^ |
Wrong hanging indentation before block (add 4 spaces). Open
word: str, src: str, tar: str, post: Optional[Set[str]] = None- Read upRead up
- Exclude checks
TODO word: str, src: str, tar: str, post: Optional[Set[str]] = None ^ |
Wrong hanging indentation before block (add 4 spaces). Open
post: Optional[Set[str]] = None,- Read upRead up
- Exclude checks
TODO post: Optional[Set[str]] = None, ^ |
Wrong hanging indentation before block (add 4 spaces). Open
post: Optional[Set[str]] = None,- Read upRead up
- Exclude checks
TODO post: Optional[Set[str]] = None, ^ |
Wrong hanging indentation before block (add 4 spaces). Open
pre: Optional[Set[str]] = None,- Read upRead up
- Exclude checks
TODO pre: Optional[Set[str]] = None, ^ |
Wrong hanging indentation before block (add 4 spaces). Open
word: str,- Read upRead up
- Exclude checks
TODO word: str, ^ |
Wrong hanging indentation before block (add 4 spaces). Open
tar: str,- Read upRead up
- Exclude checks
TODO tar: str, ^ |
Wrong hanging indentation before block (add 4 spaces). Open
pre: Optional[Set[str]] = None,- Read upRead up
- Exclude checks
TODO pre: Optional[Set[str]] = None, ^ |
Wrong hanging indentation before block (add 4 spaces). Open
src: str,- Read upRead up
- Exclude checks
TODO src: str, ^ |