Sign upLogin

mvondracek/PA193_mnemonic_Slytherin

View on GitHub
Star
pa193mnemonicslytherin/mnemonic.py

Summary

Maintainability
A
45 mins
Test Coverage

Use of assert detected. The enclosed code will be removed when compiling to optimised byte code.
Wontfix

        assert len(self) % 4 == 0
Severity: Info
Found in pa193mnemonicslytherin/mnemonic.py by bandit

File mnemonic.py has 461 lines of code (exceeds 250 allowed). Consider refactoring.
Wontfix

#
# BIP39 Mnemonic Phrase Generator and Verifier
#
# Secure Coding Principles and Practices (PA193)  https://is.muni.cz/course/fi/autumn2019/PA193?lang=en
# Faculty of Informatics (FI)                     https://www.fi.muni.cz/index.html.en
Severity: Minor
Found in pa193mnemonicslytherin/mnemonic.py - About 7 hrs to fix

    Cyclomatic complexity is too high in class _DictionaryAccess. (8)
    Confirmed

    class _DictionaryAccess:
    """Abstract class for classes requiring dictionary access
    """

    def __init__(self, dictionary_name: str = ENGLISH_DICTIONARY_NAME):
    Severity: Minor
    Found in pa193mnemonicslytherin/mnemonic.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__. (8)
    Confirmed

        def __init__(self, dictionary_name: str = ENGLISH_DICTIONARY_NAME):
        """Load the dictionary.
        Currently uses 1 default dictionary with English words.
        # TODO Should we support multiple dictionaries for various languages?
        :raises FileNotFoundError: If dictionary file with given `dictionary_name` could not be found.
    Severity: Minor
    Found in pa193mnemonicslytherin/mnemonic.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__. (7)
    Confirmed

        def __init__(self, mnemonic: str):
        # noinspection PyTypeChecker
        """Initialize Mnemonic representing bytes of mnemonic.

        Converts mnemonic phrase to entropy using dictionary to ensure its
    Severity: Minor
    Found in pa193mnemonicslytherin/mnemonic.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 a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
    Confirmed

        def __init__(self, dictionary_name: str = ENGLISH_DICTIONARY_NAME):
        """Load the dictionary.
        Currently uses 1 default dictionary with English words.
        # TODO Should we support multiple dictionaries for various languages?
        :raises FileNotFoundError: If dictionary file with given `dictionary_name` could not be found.
    Severity: Minor
    Found in pa193mnemonicslytherin/mnemonic.py - About 45 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

    TODO found
    Confirmed

            :raises PermissionError: If dictionary could not be retrieved due to denied permission.  # TODO test this
    Severity: Minor
    Found in pa193mnemonicslytherin/mnemonic.py by fixme

    TODO found
    Confirmed

            TODO Converted Seed instance is stored and calls to this method always
    Severity: Minor
    Found in pa193mnemonicslytherin/mnemonic.py by fixme

    TODO found
    Confirmed

            # TODO Should we support multiple dictionaries for various languages?
    Severity: Minor
    Found in pa193mnemonicslytherin/mnemonic.py by fixme

    Blank line contains whitespace
    Open
    Severity: Minor
    Found in pa193mnemonicslytherin/mnemonic.py by pep8

    Trailing whitespace is superfluous.

    The warning returned varies on whether the line itself is blank,
for easier filtering for those who want to indent their blank lines.

Okay: spam(1)\n#
W291: spam(1) \n#
W293: class Foo(object):\n    \n    bang = 12

    Line too long (134 > 120 characters)
    Wontfix

                `BIP39, Generating the mnemonic <https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki#generating-the-mnemonic>`_
    Severity: Minor
    Found in pa193mnemonicslytherin/mnemonic.py by pep8

    Limit all lines to a maximum of 79 characters.

    There are still many devices around that are limited to 80 character
lines; plus, limiting windows to 80 characters makes it possible to
have several windows side-by-side.  The default wrapping on such
devices looks ugly.  Therefore, please limit all lines to a maximum
of 79 characters. For flowing long blocks of text (docstrings or
comments), limiting the length to 72 characters is recommended.

Reports error E501.

    Blank line contains whitespace
    Open
    Severity: Minor
    Found in pa193mnemonicslytherin/mnemonic.py by pep8

    Trailing whitespace is superfluous.

    The warning returned varies on whether the line itself is blank,
for easier filtering for those who want to indent their blank lines.

Okay: spam(1)\n#
W291: spam(1) \n#
W293: class Foo(object):\n    \n    bang = 12

    Line too long (134 > 120 characters)
    Wontfix

                `BIP39, Generating the mnemonic <https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki#generating-the-mnemonic>`_
    Severity: Minor
    Found in pa193mnemonicslytherin/mnemonic.py by pep8

    Limit all lines to a maximum of 79 characters.

    There are still many devices around that are limited to 80 character
lines; plus, limiting windows to 80 characters makes it possible to
have several windows side-by-side.  The default wrapping on such
devices looks ugly.  Therefore, please limit all lines to a maximum
of 79 characters. For flowing long blocks of text (docstrings or
comments), limiting the length to 72 characters is recommended.

Reports error E501.

    There are no issues that match your filters.

    Category
    Status