Sign upLogin

saltstack/salt

View on GitHub
Star
salt/utils/dicttrim.py

Summary

Maintainability
D
2 days
Test Coverage

Function trim_dict has a Cognitive Complexity of 53 (exceeds 5 allowed). Consider refactoring.
Open

def trim_dict(
        data,
        max_dict_bytes,
        percent=50.0,
        stepper_size=10,
Severity: Minor
Found in salt/utils/dicttrim.py - About 1 day 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 _trim_dict_in_dict has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
Open

def _trim_dict_in_dict(data, max_val_size, replace_with):
    '''
    Takes a dictionary, max_val_size and replace_with
    and recursively loops through and replaces any values
    that are greater than max_val_size.
Severity: Minor
Found in salt/utils/dicttrim.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

Avoid deeply nested control flow statements.
Open

                        if sys.getsizeof(data[key]) > max_val_size:
                            data[key] = replace_with
                percent = percent - stepper_size
Severity: Major
Found in salt/utils/dicttrim.py - About 45 mins to fix

    Avoid too many return statements within this function.
    Open

                return data
    Severity: Major
    Found in salt/utils/dicttrim.py - About 30 mins to fix

      Avoid too many return statements within this function.
      Open

              return data
      Severity: Major
      Found in salt/utils/dicttrim.py - About 30 mins to fix

        Avoid too many return statements within this function.
        Open

                        return serializer.dumps(data, use_bin_type=True)
        Severity: Major
        Found in salt/utils/dicttrim.py - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

                          return serializer.dumps(data)
          Severity: Major
          Found in salt/utils/dicttrim.py - About 30 mins to fix

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

                for key in data:
        if isinstance(data[key], dict):
            _trim_dict_in_dict(data[key],
                               max_val_size,
                               replace_with)
            Severity: Major
            Found in salt/utils/dicttrim.py and 1 other location - About 3 hrs to fix
            salt/utils/dicttrim.py on lines 81..88

            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 70.

            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

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

                            for key in data:
                    if isinstance(data[key], dict):
                        _trim_dict_in_dict(data[key],
                                           max_val_size,
                                           replace_with)
            Severity: Major
            Found in salt/utils/dicttrim.py and 1 other location - About 3 hrs to fix
            salt/utils/dicttrim.py on lines 15..22

            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 70.

            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

            There are no issues that match your filters.

            Category
            Status