xlab-si/xopera-opera

View on GitHub
src/opera/commands/notify.py

Summary

Maintainability
C
1 day
Test Coverage

Function _parser_callback has a Cognitive Complexity of 23 (exceeds 5 allowed). Consider refactoring.
Open

def _parser_callback(args):
    if args.instance_path and not path.isdir(args.instance_path):
        raise argparse.ArgumentTypeError(f"Directory {args.instance_path} is not a valid path!")

    storage = Storage.create(args.instance_path)
Severity: Minor
Found in src/opera/commands/notify.py - About 3 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

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

def notify(storage: Storage, verbose_mode: bool, trigger_name_or_event: str,
           notification_file_contents: typing.Optional[str]):
    if storage.exists("inputs"):
        inputs = yaml.safe_load(storage.read("inputs"))
    else:
Severity: Minor
Found in src/opera/commands/notify.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 trigger_name_or_event in (trigger.name, trigger.event.data):
                        trigger_name_or_event_exists = True
                        break

Severity: Major
Found in src/opera/commands/notify.py - About 45 mins to fix

    Avoid too many return statements within this function.
    Open

                return 0
    Severity: Major
    Found in src/opera/commands/notify.py - About 30 mins to fix

      Avoid too many return statements within this function.
      Open

              return 1
      Severity: Major
      Found in src/opera/commands/notify.py - About 30 mins to fix

        Avoid too many return statements within this function.
        Open

                return 1
        Severity: Major
        Found in src/opera/commands/notify.py - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

              return 0
          Severity: Major
          Found in src/opera/commands/notify.py - About 30 mins to fix

            There are no issues that match your filters.

            Category
            Status