HazyResearch/numbskull

View on GitHub
numbskull/numbskull.py

Summary

Maintainability
D
2 days
Test Coverage

File numbskull.py has 349 lines of code (exceeds 250 allowed). Consider refactoring.
Open

#!/usr/bin/env python

"""TODO: This is a docstring."""

from __future__ import print_function, absolute_import
Severity: Minor
Found in numbskull/numbskull.py - About 4 hrs to fix

    Cyclomatic complexity is too high in method loadFGFromFile. (18)
    Open

        def loadFGFromFile(self, directory=None, metafile=None, weightfile=None,
                           variablefile=None, factorfile=None, domainfile=None,
                           var_copies=1, weight_copies=1):
            """TODO."""
            # init necessary input arguments
    Severity: Minor
    Found in numbskull/numbskull.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 loadFGFromFile has a Cognitive Complexity of 19 (exceeds 5 allowed). Consider refactoring.
    Open

        def loadFGFromFile(self, directory=None, metafile=None, weightfile=None,
                           variablefile=None, factorfile=None, domainfile=None,
                           var_copies=1, weight_copies=1):
            """TODO."""
            # init necessary input arguments
    Severity: Minor
    Found in numbskull/numbskull.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

    Cyclomatic complexity is too high in method loadFactorGraph. (10)
    Open

        def loadFactorGraph(self, weight, variable, factor, fmap, domain_mask,
                            edges, var_copies=1, weight_copies=1,
                            factors_to_skip=np.empty(0, np.int64)):
            """TODO."""
            # Note: factors_to_skip must be sorted
    Severity: Minor
    Found in numbskull/numbskull.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 loadFGFromFile has 36 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        def loadFGFromFile(self, directory=None, metafile=None, weightfile=None,
                           variablefile=None, factorfile=None, domainfile=None,
                           var_copies=1, weight_copies=1):
            """TODO."""
            # init necessary input arguments
    Severity: Minor
    Found in numbskull/numbskull.py - About 1 hr to fix

      Function loadFactorGraph has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
      Open

          def loadFactorGraph(self, weight, variable, factor, fmap, domain_mask,
                              edges, var_copies=1, weight_copies=1,
                              factors_to_skip=np.empty(0, np.int64)):
              """TODO."""
              # Note: factors_to_skip must be sorted
      Severity: Minor
      Found in numbskull/numbskull.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 loadFactorGraph has 9 arguments (exceeds 4 allowed). Consider refactoring.
      Open

          def loadFactorGraph(self, weight, variable, factor, fmap, domain_mask,
      Severity: Major
      Found in numbskull/numbskull.py - About 1 hr to fix

        Function loadFactorGraphRaw has 8 arguments (exceeds 4 allowed). Consider refactoring.
        Open

            def loadFactorGraphRaw(self, weight, variable, factor, fmap,
        Severity: Major
        Found in numbskull/numbskull.py - About 1 hr to fix

          Function loadFGFromFile has 8 arguments (exceeds 4 allowed). Consider refactoring.
          Open

              def loadFGFromFile(self, directory=None, metafile=None, weightfile=None,
          Severity: Major
          Found in numbskull/numbskull.py - About 1 hr to fix

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

                def __init__(self, **kwargs):
                    """TODO.
            
                    Parameters
                    ----------
            Severity: Minor
            Found in numbskull/numbskull.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

            TODO found
            Open

                # TODO: print default for meta, weight, variable, factor in help
            Severity: Minor
            Found in numbskull/numbskull.py by fixme

            TODO found
            Open

                """TODO: Main class for numbskull."""
            Severity: Minor
            Found in numbskull/numbskull.py by fixme

            TODO found
            Open

                    """TODO."""
            Severity: Minor
            Found in numbskull/numbskull.py by fixme

            TODO found
            Open

                    """TODO."""
            Severity: Minor
            Found in numbskull/numbskull.py by fixme

            TODO found
            Open

                    """TODO.
            Severity: Minor
            Found in numbskull/numbskull.py by fixme

            TODO found
            Open

                    """TODO."""
            Severity: Minor
            Found in numbskull/numbskull.py by fixme

            TODO found
            Open

                """TODO."""
            Severity: Minor
            Found in numbskull/numbskull.py by fixme

            TODO found
            Open

            """TODO: This is a docstring."""
            Severity: Minor
            Found in numbskull/numbskull.py by fixme

            TODO found
            Open

                    # TODO: should probably just delete edges as an argument
            Severity: Minor
            Found in numbskull/numbskull.py by fixme

            TODO found
            Open

                    """TODO."""
            Severity: Minor
            Found in numbskull/numbskull.py by fixme

            TODO found
            Open

                    """TODO."""
            Severity: Minor
            Found in numbskull/numbskull.py by fixme

            TODO found
            Open

                    """TODO."""
            Severity: Minor
            Found in numbskull/numbskull.py by fixme

            TODO found
            Open

                    # TODO: edges is really poorly defined with factors_to_skip
            Severity: Minor
            Found in numbskull/numbskull.py by fixme

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

                    for var in variable:
                        var["vtf_offset"] = num_vtfs
                        if var["dataType"] == 0:  # boolean
                            num_vtfs += 1
                        else:
            Severity: Major
            Found in numbskull/numbskull.py and 1 other location - About 2 hrs to fix
            numbskull/numbskull.py on lines 222..227

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

            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 var in variable:
                        var["vtf_offset"] = num_vtfs
                        if var["dataType"] == 0:  # boolean
                            num_vtfs += 1
                        else:
            Severity: Major
            Found in numbskull/numbskull.py and 1 other location - About 2 hrs to fix
            numbskull/numbskull.py on lines 312..317

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

            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