simonkowallik/as3ninja

View on GitHub
as3ninja/cli.py

Summary

Maintainability
A
25 mins
Test Coverage
A
100%

File cli.py has 307 lines of code (exceeds 250 allowed). Consider refactoring.
Wontfix

# -*- coding: utf-8 -*-
"""
AS3 Ninja CLI module
"""

Severity: Minor
Found in as3ninja/cli.py - About 3 hrs to fix

    Function git_transform has 11 arguments (exceeds 4 allowed). Consider refactoring.
    Wontfix

    def git_transform(  # pylint: disable=R0913 # Too many arguments
    Severity: Major
    Found in as3ninja/cli.py - About 1 hr to fix

      Function git_transform has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
      Wontfix

      def git_transform(  # pylint: disable=R0913 # Too many arguments
          declaration_template: Optional[str],
          configuration_file: Optional[List],
          output_file: Union[str, None],
          validate: bool,  # pylint: disable=W0621 # Redefining name 'validate' from outer scope
      Severity: Minor
      Found in as3ninja/cli.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 transform has 6 arguments (exceeds 4 allowed). Consider refactoring.
      Wontfix

      def transform(
      Severity: Minor
      Found in as3ninja/cli.py - About 45 mins to fix

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

        def validate(
            declaration: str,
            version: Optional[str],
        ):
            """Validate an AS3 Declaration against the AS3 JSON Schema.
        Severity: Minor
        Found in as3ninja/cli.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 "git_transform" has 9 parameters, which is greater than the 7 authorized.
        Open

            declaration_template: Optional[str],
            configuration_file: Optional[List],
            output_file: Union[str, None],
            validate: bool,  # pylint: disable=W0621 # Redefining name 'validate' from outer scope
            pretty: bool,
        Severity: Major
        Found in as3ninja/cli.py by sonar-python

        A long parameter list can indicate that a new structure should be created to wrap the numerous parameters or that the function is doing too many things.

        Noncompliant Code Example

        With a maximum number of 4 parameters:

        def do_something(param1, param2, param3, param4, param5):
            ...
        

        Compliant Solution

        def do_something(param1, param2, param3, param4):
            ...
        

        There are no issues that match your filters.

        Category
        Status