Sign upLogin

levabd/stack-updater

View on GitHub
Star

Showing 9 of 9 total issues

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

    def install(self, verbose):
        """
        Dependency checking with installing required version
        :param verbose: if False then print console output into log file
        """
Severity: Minor
Found in stackupdater/src/dependency.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 __init__ has 8 arguments (exceeds 4 allowed). Consider refactoring.
Open

    def __init__(self, filename, max_bytes=0, backup_count=0, encoding=None,
Severity: Major
Found in stackupdater/src/lib/logger.py - About 1 hr to fix

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

        def call(*popenargs, **kwargs):
        """Run command with arguments. Wait for command to complete. Sends
        output to logging module. The arguments are the same as for the Popen
        constructor."""
    Severity: Minor
    Found in stackupdater/src/lib/wrappers/process.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 __init__ has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

        def __init__(self, base_path, recipe_path=''):
        """
        Load recipes from file
        """
        logger.info("Start loading recipes")
    Severity: Minor
    Found in stackupdater/src/dependency.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

    Ordered list item prefix
    Open

    2. Screenshots:
    Severity: Info
    Found in .github/issue_template.md by markdownlint

    MD029 - Ordered list item prefix

    Tags: ol

    Aliases: ol-prefix

    Parameters: style ("one", "ordered"; default "one")

    This rule is triggered on ordered lists that do not either start with '1.' or do not have a prefix that increases in numerical order (depending on the configured style, which defaults to 'one').

    Example valid list if the style is configured as 'one':

    1. Do this.
1. Do that.
1. Done.

    Example valid list if the style is configured as 'ordered':

    1. Do this.
2. Do that.
3. Done.

    Header levels should only increment by one level at a time
    Open

    #### **Did you find a bug?**
    Severity: Info
    Found in .github/CONTRIBUTING.md by markdownlint

    MD001 - Header levels should only increment by one level at a time

    Tags: headers

    Aliases: header-increment

    This rule is triggered when you skip header levels in a markdown document, for example:

    # Header 1

### Header 3

We skipped out a 2nd level header in this document

    When using multiple header levels, nested headers should increase by only one level at a time:

    # Header 1

## Header 2

### Header 3

#### Header 4

## Another Header 2

### Another Header 3

    First header should be a top level header
    Open

    ## How to contribute
    Severity: Info
    Found in .github/CONTRIBUTING.md by markdownlint

    MD002 - First header should be a top level header

    Tags: headers

    Aliases: first-header-h1

    Parameters: level (number; default 1)

    This rule is triggered when the first header in the document isn't a h1 header:

    ## This isn't a H1 header

### Another header

    The first header in the document should be a h1 header:

    # Start with a H1 header

## Then use a H2 for subsections

    Expected 2 blank lines after class or function definition, found 1
    Open

    logger = Logger()  # simple alias without ugly brackets
    Severity: Minor
    Found in stackupdater/src/lib/logger.py by pep8

    Separate top-level function and class definitions with two blank lines.

    Method definitions inside a class are separated by a single blank
line.

Extra blank lines may be used (sparingly) to separate groups of
related functions.  Blank lines may be omitted between a bunch of
related one-liners (e.g. a set of dummy implementations).

Use blank lines in functions, sparingly, to indicate logical
sections.

Okay: def a():\n    pass\n\n\ndef b():\n    pass
Okay: def a():\n    pass\n\n\nasync def b():\n    pass
Okay: def a():\n    pass\n\n\n# Foo\n# Bar\n\ndef b():\n    pass
Okay: default = 1\nfoo = 1
Okay: classify = 1\nfoo = 1

E301: class Foo:\n    b = 0\n    def bar():\n        pass
E302: def a():\n    pass\n\ndef b(n):\n    pass
E302: def a():\n    pass\n\nasync def b(n):\n    pass
E303: def a():\n    pass\n\n\n\ndef b(n):\n    pass
E303: def a():\n\n\n\n    pass
E304: @decorator\n\ndef a():\n    pass
E305: def a():\n    pass\na()
E306: def a():\n    def b():\n        pass\n    def c():\n        pass

    Ordered list item prefix
    Open

    3. Additional Information.
    Severity: Info
    Found in .github/issue_template.md by markdownlint

    MD029 - Ordered list item prefix

    Tags: ol

    Aliases: ol-prefix

    Parameters: style ("one", "ordered"; default "one")

    This rule is triggered on ordered lists that do not either start with '1.' or do not have a prefix that increases in numerical order (depending on the configured style, which defaults to 'one').

    Example valid list if the style is configured as 'one':

    1. Do this.
1. Do that.
1. Done.

    Example valid list if the style is configured as 'ordered':

    1. Do this.
2. Do that.
3. Done.
    Severity
    Category
    Status
    Source
    Language