0h-n0/simple-lock

View on GitHub

Showing 6 of 6 total issues

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

def lock(filename='simple.lock',
         path='.',
         threaded=True,
         return_value: typing.Callable = None,
         **return_func_kwargs):
Severity: Minor
Found in simple_lock/lockfile.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

File lockfile.py has 258 lines of code (exceeds 250 allowed). Consider refactoring.
Open

"""
This program is based on `pylockfile`.

"""
import os
Severity: Minor
Found in simple_lock/lockfile.py - About 2 hrs to fix

    Function watch has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
    Open

    def watch(filename='simple.lock',
              path='.',
              threaded=True,
              return_value: typing.Callable = None,
              **return_func_kwargs):
    Severity: Minor
    Found in simple_lock/lockfile.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 watch has 5 arguments (exceeds 4 allowed). Consider refactoring.
    Open

    def watch(filename='simple.lock',
    Severity: Minor
    Found in simple_lock/lockfile.py - About 35 mins to fix

      Function lock has 5 arguments (exceeds 4 allowed). Consider refactoring.
      Open

      def lock(filename='simple.lock',
      Severity: Minor
      Found in simple_lock/lockfile.py - About 35 mins to fix

        Function clean has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
        Open

            def clean(cls, filename, path='.'):
                if path == '.':
                    path = cls.root_path
                path = Path(path).expanduser().resolve()
                hostname = socket.gethostname()
        Severity: Minor
        Found in simple_lock/lockfile.py - About 35 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

        Severity
        Category
        Status
        Source
        Language