cea-sec/miasm

View on GitHub
miasm/__init__.py

Summary

Maintainability
A
1 hr
Test Coverage

Function _version has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
Open

def _version():
    version_file = os.path.join(_MIASM_PKG_DIR, 'VERSION')
    try:
        tag = _version_from_git_describe()
        # successfully read the tag from git, write it in VERSION for
Severity: Minor
Found in miasm/__init__.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

Avoid too many return statements within this function.
Open

                return 'unknown.version'
Severity: Major
Found in miasm/__init__.py - About 30 mins to fix

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

    def _version_from_git_describe():
        """
        Read the version from ``git describe``. It returns the latest tag with an
        optional suffix if the current directory is not exactly on the tag.
    
    
    Severity: Minor
    Found in miasm/__init__.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

    There are no issues that match your filters.

    Category
    Status