USDA-ARS-NWRC/awsm

View on GitHub
awsm/framework/framework.py

Summary

Maintainability
C
1 day
Test Coverage

File framework.py has 365 lines of code (exceeds 300 allowed). Consider refactoring.
Open

import copy
import logging
import os
import sys
from datetime import datetime
Severity: Minor
Found in awsm/framework/framework.py - About 3 hrs to fix

    Function run_awsm_daily_ops has a Cognitive Complexity of 17 (exceeds 8 allowed). Consider refactoring.
    Open

    def run_awsm_daily_ops(config_file):
        """
        Run each day seperately. Calls run_awsm
        """
        # define some formats
    Severity: Minor
    Found in awsm/framework/framework.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 read_config has a Cognitive Complexity of 9 (exceeds 8 allowed). Consider refactoring.
    Wontfix

        def read_config(self, config):
            if isinstance(config, str):
                if not os.path.isfile(config):
                    raise Exception('Configuration file does not exist --> {}'
                                    .format(config))
    Severity: Minor
    Found in awsm/framework/framework.py - About 25 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 run_awsm has a Cognitive Complexity of 9 (exceeds 8 allowed). Consider refactoring.
    Open

    def run_awsm(config):
        """
        Function that runs awsm how it should be operate for full runs.
    
        Args:
    Severity: Minor
    Found in awsm/framework/framework.py - About 25 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

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

        prev_out_base = os.path.join(paths['path_dr'],
                                     paths['basin'],
                                     'wy{}'.format(wy),
                                     paths['project_name'],
                                     'runs')
    Severity: Major
    Found in awsm/framework/framework.py and 1 other location - About 1 hr to fix
    awsm/framework/framework.py on lines 444..448

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

    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

        prev_data_base = os.path.join(paths['path_dr'],
                                      paths['basin'],
                                      'wy{}'.format(wy),
                                      paths['project_name'],
                                      'data')
    Severity: Major
    Found in awsm/framework/framework.py and 1 other location - About 1 hr to fix
    awsm/framework/framework.py on lines 438..442

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

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

                self.start_date = self.start_date - \
                    pd.Timedelta(minutes=self.config['time']['time_step'])
    Severity: Minor
    Found in awsm/framework/framework.py and 1 other location - About 55 mins to fix
    awsm/models/pysnobal/init_model.py on lines 73..74

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

    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