mvondracek/PA193_mnemonic_Slytherin

View on GitHub

Showing 6 of 37 total issues

Function parse_args has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
Confirmed

    def parse_args(cls, args: Sequence[str]):
        """Parse command line arguments and store checked and converted values in Config object.

        According to default behaviour of `argparse.ArgumentParser`, this method terminates
        program with exit code 2 (corresponding to `ExitCode.ARGUMENTS`) if passed arguments are
Severity: Minor
Found in pa193mnemonicslytherin/mnemoniccli.py - About 1 hr 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

Function __init__ has 10 arguments (exceeds 4 allowed). Consider refactoring.
Confirmed

    def __init__(self,
Severity: Major
Found in pa193mnemonicslytherin/mnemoniccli.py - About 1 hr to fix

    Function action_verify has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
    Confirmed

    def action_verify(config: Config) -> ExitCode:
        """
        :raises InputDataError: The input data was incorrect in some way.
        :raises NoInputError: An input file (not a system file) did not exist or was not readable.
        """
    Severity: Minor
    Found in pa193mnemonicslytherin/mnemoniccli.py - About 1 hr 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

    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

    Function action_generate has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
    Confirmed

    def action_generate(config: Config) -> ExitCode:
        """
        :raises InputDataError: The input data was incorrect in some way.
        :raises NoInputError: An input file (not a system file) did not exist or was not readable.
        """
    Severity: Minor
    Found in pa193mnemonicslytherin/mnemoniccli.py - About 35 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

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

    def main(argv) -> ExitCode:
        logging.captureWarnings(True)
        warnings.simplefilter('always', ResourceWarning)
    
        config = Config.parse_args(argv[1:])  # argv[0] is program name
    Severity: Minor
    Found in pa193mnemonicslytherin/mnemoniccli.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

    Severity
    Category
    Status
    Source
    Language