KarrLab/wc_utils

View on GitHub
wc_utils/config/core.py

Summary

Maintainability
C
1 day
Test Coverage
B
81%

File core.py has 306 lines of code (exceeds 250 allowed). Consider refactoring.
Open

""" Read configuration settings from files, environment variables, and function arguments

:Author: Jonathan Karr <karr@mssm.edu>
:Author: Arthur Goldberg <Arthur.Goldberg@mssm.edu>
:Date: 2016-10-25
Severity: Minor
Found in wc_utils/config/core.py - About 3 hrs to fix

    Function get_config has a Cognitive Complexity of 21 (exceeds 5 allowed). Consider refactoring.
    Open

        def get_config(self, extra=None, context=None):
            """ Setup configuration from config file(s), environment variables, and/or function arguments.
    
            1. Setup configuration from default values specified in `paths.default`.
            2. If `paths.user` is set, find the first file in it that exists, and override
    Severity: Minor
    Found in wc_utils/config/core.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

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

        def __init__(self, sources, config):
            """
            Args:
                sources (:obj:`list` of :obj:`str`): list of sources of configuration values
                config (:obj:`configobj.ConfigObj`): configuration
    Severity: Minor
    Found in wc_utils/config/core.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 get_package_root has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
    Open

        def get_package_root(file_in_package):
            """ Obtain root directory of a package by following `__init__.py` files up the file hierarchy
    
            Args:
                file_in_package (:obj:`str`): pathname of a file in a package
    Severity: Minor
    Found in wc_utils/config/core.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 any_checker has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
    Open

    def any_checker(value):
        ''' Convert value to its built-in data type if possible
    
        Convert a string value to its built-in data type (integer, float, boolean, str
        or list of these) if possible
    Severity: Minor
    Found in wc_utils/config/core.py - About 35 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 __init__ has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
    Open

        def __init__(self, sources, config, result):
            """
            Args:
                sources (:obj:`list` of :obj:`str`): list of sources of configuration values
                config (:obj:`configobj.ConfigObj`): configuration
    Severity: Minor
    Found in wc_utils/config/core.py - About 35 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 too many return statements within this function.
    Open

        return is_string(value)
    Severity: Major
    Found in wc_utils/config/core.py - About 30 mins to fix

      There are no issues that match your filters.

      Category
      Status