Sign upLogin

sitch-io/sensor

View on GitHub
Star
sitch/sitchlib/config_helper.py

Summary

Maintainability
A
3 hrs
Test Coverage

Cyclomatic complexity is too high in method get_list_from_env. (6)
Open

    @classmethod
    def get_list_from_env(cls, k, optional=False):
        """Get a list from environment variables.

        If optional=True, the absence of this var will cause a hard exit.
Severity: Minor
Found in sitch/sitchlib/config_helper.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

Function __init__ has 42 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    def __init__(self, sitch_var_base_dir="/data/sitch/"):
        """Initialize ConfigHelper.

        Args:
            sitch_var_base_dir (str): Base directory for feed and log data.
Severity: Minor
Found in sitch/sitchlib/config_helper.py - About 1 hr to fix

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

        @classmethod
    def get_db_schemas(cls, filename="/etc/schemas/feed_db_schema.yaml"):
        """Get the feed DB schemas from file."""
        with open(filename, 'r') as schema_file:
            return yaml.load(schema_file)
    Severity: Major
    Found in sitch/sitchlib/config_helper.py and 2 other locations - About 40 mins to fix
    sitch/sitchlib/config_helper.py on lines 103..107
    sitch/sitchlib/config_helper.py on lines 115..119

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

        @classmethod
    def get_db_schema_translations(cls, filename="/etc/schemas/feed_db_translation.yaml"):  # NOQA
        """Get the feed DB schema translations from file."""
        with open(filename, 'r') as translate_file:
            return yaml.load(translate_file)
    Severity: Major
    Found in sitch/sitchlib/config_helper.py and 2 other locations - About 40 mins to fix
    sitch/sitchlib/config_helper.py on lines 103..107
    sitch/sitchlib/config_helper.py on lines 109..113

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

        @classmethod
    def get_filebeat_template(cls, filename="/etc/templates/filebeat.json"):
        """Get the filebeat config from template file."""
        with open(filename, 'r') as template_file:
            return json.load(template_file)
    Severity: Major
    Found in sitch/sitchlib/config_helper.py and 2 other locations - About 40 mins to fix
    sitch/sitchlib/config_helper.py on lines 109..113
    sitch/sitchlib/config_helper.py on lines 115..119

    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

    There are no issues that match your filters.

    Category
    Status