saltstack/salt

View on GitHub
salt/pillar/sql_base.py

Summary

Maintainability
F
4 days
Test Coverage

Function process_results has a Cognitive Complexity of 110 (exceeds 5 allowed). Consider refactoring.
Open

    def process_results(self, rows):
        '''
        This function takes a list of database results and iterates over,
        merging them into a dict form.
        '''
Severity: Minor
Found in salt/pillar/sql_base.py - About 2 days 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

Cyclomatic complexity is too high in method process_results. (35)
Open

    def process_results(self, rows):
        '''
        This function takes a list of database results and iterates over,
        merging them into a dict form.
        '''
Severity: Minor
Found in salt/pillar/sql_base.py by radon

Cyclomatic Complexity

Cyclomatic Complexity corresponds to the number of decisions a block of code contains plus 1. This number (also called McCabe number) is equal to the number of linearly independent paths through the code. This number can be used as a guide when testing conditional logic in blocks.

Radon analyzes the AST tree of a Python program to compute Cyclomatic Complexity. Statements have the following effects on Cyclomatic Complexity:

Construct Effect on CC Reasoning
if +1 An if statement is a single decision.
elif +1 The elif statement adds another decision.
else +0 The else statement does not cause a new decision. The decision is at the if.
for +1 There is a decision at the start of the loop.
while +1 There is a decision at the while statement.
except +1 Each except branch adds a new conditional path of execution.
finally +0 The finally block is unconditionally executed.
with +1 The with statement roughly corresponds to a try/except block (see PEP 343 for details).
assert +1 The assert statement internally roughly equals a conditional statement.
Comprehension +1 A list/set/dict comprehension of generator expression is equivalent to a for loop.
Boolean Operator +1 Every boolean operator (and, or) adds a decision point.

Source: http://radon.readthedocs.org/en/latest/intro.html

File sql_base.py has 327 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# -*- coding: utf-8 -*-
'''
Retrieve Pillar data by doing a SQL query

This module is not meant to be used directly as an ext_pillar.
Severity: Minor
Found in salt/pillar/sql_base.py - About 3 hrs to fix

    Function extract_queries has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.
    Open

        def extract_queries(self, args, kwargs):
            '''
            This function normalizes the config block into a set of queries we
            can use.  The return is a list of consistently laid out dicts.
            '''
    Severity: Minor
    Found in salt/pillar/sql_base.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

    Avoid deeply nested control flow statements.
    Open

                            if isinstance(crd[nk], list):
                                crd[nk].append(ret[i])
                            else:
                                crd[nk] = [crd[nk], ret[i]]
                        else:
    Severity: Major
    Found in salt/pillar/sql_base.py - About 45 mins to fix

      Avoid deeply nested control flow statements.
      Open

                              if id(crd) not in listify:
                                  listify[id(crd)] = []
                                  listify_dicts[id(crd)] = crd
                              if nk not in listify[id(crd)]:
      Severity: Major
      Found in salt/pillar/sql_base.py - About 45 mins to fix

        Avoid deeply nested control flow statements.
        Open

                                if nk not in listify[id(crd)]:
                                    listify[id(crd)].append(nk)
                            # Collision detection
                            if self.as_list and (nk in crd):
        Severity: Major
        Found in salt/pillar/sql_base.py - About 45 mins to fix

          Avoid deeply nested control flow statements.
          Open

                                  if self.as_list:
                                      # Make list
                                      temp = {}
                                      crd[ret[i]] = [crd[ret[i]], temp]
                                      crd = temp
          Severity: Major
          Found in salt/pillar/sql_base.py - About 45 mins to fix

            Avoid deeply nested control flow statements.
            Open

                                    if not self.ignore_null or ret[i] is not None:
                                        crd[nk] = ret[i]
                    # Get key list and work backwards.  This is inner-out processing
                    ks = list(listify_dicts.keys())
            Severity: Major
            Found in salt/pillar/sql_base.py - About 45 mins to fix

              Avoid deeply nested control flow statements.
              Open

                                      if not isinstance(crd[ret[nk]], list):
                                          crd[ret[nk]] = [crd[ret[nk]]]
                                      # if it's already a list, do nothing
                                  else:
              Severity: Major
              Found in salt/pillar/sql_base.py - About 45 mins to fix

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

                                    if id(crd) not in listify:
                                        listify[id(crd)] = []
                                        listify_dicts[id(crd)] = crd
                Severity: Major
                Found in salt/pillar/sql_base.py and 2 other locations - About 1 hr to fix
                salt/pillar/sql_base.py on lines 381..383
                salt/pillar/sql_base.py on lines 392..394

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

                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 3 locations. Consider refactoring.
                Open

                                    if id(crd) not in listify:
                                        listify[id(crd)] = []
                                        listify_dicts[id(crd)] = crd
                Severity: Major
                Found in salt/pillar/sql_base.py and 2 other locations - About 1 hr to fix
                salt/pillar/sql_base.py on lines 325..327
                salt/pillar/sql_base.py on lines 392..394

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

                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 3 locations. Consider refactoring.
                Open

                                        if id(crd) not in listify:
                                            listify[id(crd)] = []
                                            listify_dicts[id(crd)] = crd
                Severity: Major
                Found in salt/pillar/sql_base.py and 2 other locations - About 1 hr to fix
                salt/pillar/sql_base.py on lines 325..327
                salt/pillar/sql_base.py on lines 381..383

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

                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