avocado-framework/avocado

View on GitHub
avocado/core/safeloader/docstring.py

Summary

Maintainability
B
4 hrs
Test Coverage
A
95%

Function get_docstring_directives_tags has a Cognitive Complexity of 21 (exceeds 5 allowed). Consider refactoring.
Open

def get_docstring_directives_tags(docstring):
    """
    Returns the test categories based on a `:avocado: tags=category`
    docstring

Severity: Minor
Found in avocado/core/safeloader/docstring.py - About 2 hrs 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 deeply nested control flow statements.
Open

                    if key in result:
                        result[key].add(val)
                    else:
                        result[key] = set([val])
                else:
Severity: Major
Found in avocado/core/safeloader/docstring.py - About 45 mins to fix

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

    def get_docstring_directives(docstring):
        """
        Returns the values of the avocado docstring directives
    
        :param docstring: the complete text used as documentation
    Severity: Minor
    Found in avocado/core/safeloader/docstring.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

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

    def get_docstring_directives_requirements(docstring):
        """
        Returns the test requirements from docstring patterns like
        `:avocado: requirement={}`.
    
    
    Severity: Minor
    Found in avocado/core/safeloader/docstring.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