itsVale/Vale.py

View on GitHub
utils/examples.py

Summary

Maintainability
A
3 hrs
Test Coverage

Function get_example has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
Open

def get_example(converter, ctx):
    """Returns a random example based on the converter."""

    if hasattr(converter, 'random_example'):
        return converter.random_example(ctx)
Severity: Minor
Found in utils/examples.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 _parameter_examples has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
Open

def _parameter_examples(parameters, ctx, command=None):
    command = command or ctx.command

    def parameter_example(parameter):
        ctx._current_parameter = parameter
Severity: Minor
Found in utils/examples.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 _split_params has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
Open

def _split_params(command):
    """Splits a command's parameters into required and optional parts."""

    params = command.clean_params.values()
    required = list(itertools.takewhile(_is_required_parameter, params))
Severity: Minor
Found in utils/examples.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

There are no issues that match your filters.

Category
Status