Sign upLogin

krux/python-krux-stdlib

View on GitHub
Star

Showing 13 of 13 total issues

Function run has a Cognitive Complexity of 30 (exceeds 5 allowed). Consider refactoring.
Open

    def run(self, command, filters=None, timeout=None, timeout_terminate_signal=signal.SIGTERM):
        log = self.___logger
        stats = self.___stats

        # for bookkeeping purposes
Severity: Minor
Found in krux/io.py - About 4 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 add_argument has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
Open

    def add_argument(self, *args, **kwargs):
        """
        Creates a CLI argument under this group based on the passed parameters.

        :param env_var: Name of the environment variable to use. If set to False or not
Severity: Minor
Found in krux/parser.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 sendmail has 9 arguments (exceeds 4 allowed). Consider refactoring.
Open

def sendmail(
Severity: Major
Found in krux/mail.py - About 1 hr to fix

    Function cache_wrapper has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
    Open

    def cache_wrapper(cached_function: Callable, *,
                  expire_seconds: Union[float, int] = None,
                  ) -> Callable:
    """Function wrapper that caches the wrapped function's results.
    Optionally, cached call results can be expired with the expire_seconds argument.
    Severity: Minor
    Found in krux/util.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 sendmail has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
    Open

    def sendmail(
        sender,
        recipients,
        subject,
        body,
    Severity: Minor
    Found in krux/mail.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 7 arguments (exceeds 4 allowed). Consider refactoring.
    Open

        def __init__(
    Severity: Major
    Found in example.py - About 50 mins to fix

      Function __init__ has 7 arguments (exceeds 4 allowed). Consider refactoring.
      Open

          def __init__(
      Severity: Major
      Found in krux/cli.py - About 50 mins to fix

        Function flatten has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
        Open

        def flatten(lst):
    """
    Flattens a mixture of lists and objects into a one-dimensional list

    https://rosettacode.org/wiki/Flatten_a_list#Generative
        Severity: Minor
        Found in krux/util.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

        Function get_stats has 6 arguments (exceeds 4 allowed). Consider refactoring.
        Open

        def get_stats(
        Severity: Minor
        Found in krux/stats.py - About 45 mins to fix

          Avoid deeply nested control flow statements.
          Open

                                      if r.search(s):
                                log.debug('line "%s" matches "%s"' % (s, r.pattern))
                                ignore = True
                        # not filtered - store the filtered output in the object,
                        # so caller can inspect them
          Severity: Major
          Found in krux/io.py - About 45 mins to fix

            Function get_parser has 6 arguments (exceeds 4 allowed). Consider refactoring.
            Open

            def get_parser(
            Severity: Minor
            Found in krux/parser.py - About 45 mins to fix

              Similar blocks of code found in 2 locations. Consider refactoring.
              Open

                      title = args[0] if len(args) > 0 else kwargs.pop('title', None)
              Severity: Minor
              Found in krux/parser.py and 1 other location - About 40 mins to fix
              krux/parser.py on lines 216..216

              Duplicated Code

              Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

              Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

              When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

              Tuning

              This issue has a mass of 34.

              We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

              The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

              If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

              See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

              Refactorings

              Further Reading

              Similar blocks of code found in 2 locations. Consider refactoring.
              Open

                      description = args[1] if len(args) > 1 else kwargs.pop('description', None)
              Severity: Minor
              Found in krux/parser.py and 1 other location - About 40 mins to fix
              krux/parser.py on lines 215..215

              Duplicated Code

              Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

              Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

              When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

              Tuning

              This issue has a mass of 34.

              We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

              The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

              If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

              See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

              Refactorings

              Further Reading

              Severity
              Category
              Status
              Source
              Language