Sign upLogin

KarrLab/wc_utils

View on GitHub
Star
wc_utils/util/types.py

Summary

Maintainability
D
1 day
Test Coverage
B
88%

Function assert_value_equal has a Cognitive Complexity of 71 (exceeds 5 allowed). Consider refactoring.
Open

def assert_value_equal(obj1, obj2, check_type=False, check_iterable_ordering=False):
    """ Recursively raise an exception if two objects have different semantic values, ignoring

    * key/attribute order
    * optionally, object types
Severity: Minor
Found in wc_utils/util/types.py - About 1 day 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 cast_to_builtins has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
Open

def cast_to_builtins(obj):
    """ Recursively type cast an object to a semantically equivalent object expressed using only builtin types

    * All iterable objects (objects with `__iter__` attribute) are converted to lists
    * All dictionable objects (objects which are dictionaries or which have the `__dict__` attribute) are
Severity: Minor
Found in wc_utils/util/types.py - About 55 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 deeply nested control flow statements.
Open

                    if i2 in used2:
                        continue
                    try:
Severity: Major
Found in wc_utils/util/types.py - About 45 mins to fix

    Avoid too many return statements within this function.
    Open

            return obj
    Severity: Major
    Found in wc_utils/util/types.py - About 30 mins to fix

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

              if not ((hasattr(obj2, '__iter__') and not (isinstance(obj2, dict) or
                                                    hasattr(obj2, '__dict__') or isinstance(obj2, str)))):
      Severity: Minor
      Found in wc_utils/util/types.py and 1 other location - About 50 mins to fix
      wc_utils/util/types.py on lines 97..98

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

      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

          elif (hasattr(obj1, '__iter__') and not (isinstance(obj1, dict) or hasattr(obj1, '__dict__') or
                                             isinstance(obj1, str))):
      Severity: Minor
      Found in wc_utils/util/types.py and 1 other location - About 50 mins to fix
      wc_utils/util/types.py on lines 99..100

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

      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