Sign upLogin

chrislit/abydos

View on GitHub
Star
abydos/distance/_bleu.py

Summary

Maintainability
A
1 hr
Test Coverage

Cyclomatic complexity is too high in method sim. (7)
Open

    def sim(self, src: str, tar: str) -> float:
        """Return the BLEU similarity of two strings.

        Parameters
        ----------
Severity: Minor
Found in abydos/distance/_bleu.py by radon

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.

Source: http://radon.readthedocs.org/en/latest/intro.html

Cyclomatic complexity is too high in class BLEU. (7)
Open

class BLEU(_Distance):
    r"""BLEU similarity.

    BLEU similarity :cite:`Papineni:2002` compares two strings for similarity
    using a set of tokenizers and a brevity penalty:
Severity: Minor
Found in abydos/distance/_bleu.py by radon

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.

Source: http://radon.readthedocs.org/en/latest/intro.html

Cyclomatic complexity is too high in method __init__. (6)
Open

    def __init__(
        self,
        n_min: int = 1,
        n_max: int = 4,
        tokenizers: Optional[List[_Tokenizer]] = None,
Severity: Minor
Found in abydos/distance/_bleu.py by radon

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.

Source: http://radon.readthedocs.org/en/latest/intro.html

Function __init__ has 5 arguments (exceeds 4 allowed). Consider refactoring.
Open

    def __init__(
Severity: Minor
Found in abydos/distance/_bleu.py - About 35 mins to fix

    Function sim has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

        def sim(self, src: str, tar: str) -> float:
        """Return the BLEU similarity of two strings.

        Parameters
        ----------
    Severity: Minor
    Found in abydos/distance/_bleu.py - About 25 mins to fix

    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

    Wrong hanging indentation before block (add 4 spaces).
    Open

            tokenizers: Optional[List[_Tokenizer]] = None,
    Severity: Info
    Found in abydos/distance/_bleu.py by pylint

    TODO tokenizers: Optional[List[_Tokenizer]] = None, ^ |

    Wrong hanging indentation before block (add 4 spaces).
    Open

            n_max: int = 4,
    Severity: Info
    Found in abydos/distance/_bleu.py by pylint

    TODO n_max: int = 4, ^ |

    Wrong hanging indentation before block (add 4 spaces).
    Open

            **kwargs: Any
    Severity: Info
    Found in abydos/distance/_bleu.py by pylint

    TODO **kwargs: Any ^ |

    Wrong hanging indentation before block (add 4 spaces).
    Open

            n_min: int = 1,
    Severity: Info
    Found in abydos/distance/_bleu.py by pylint

    TODO n_min: int = 1, ^ |

    Wrong hanging indentation before block (add 4 spaces).
    Open

            self,
    Severity: Info
    Found in abydos/distance/_bleu.py by pylint

    TODO self, ^ |

    Wrong hanging indentation before block (add 4 spaces).
    Open

            weights: Optional[List[float]] = None,
    Severity: Info
    Found in abydos/distance/_bleu.py by pylint

    TODO weights: Optional[List[float]] = None, ^ |

    There are no issues that match your filters.

    Category
    Status