yzhao062/Pyod

View on GitHub
pyod/utils/utility.py

Summary

Maintainability
B
4 hrs
Test Coverage

File utility.py has 389 lines of code (exceeds 250 allowed). Consider refactoring.
Wontfix

# -*- coding: utf-8 -*-
"""A set of utility functions to support outlier detection.
"""
# Author: Yue Zhao <zhaoy@cmu.edu>
# License: BSD 2 clause
Severity: Minor
Found in pyod/utils/utility.py - About 5 hrs to fix

    Consider simplifying this complex logical expression.
    Open

        if (include_left and include_right) and (param < low or param > high):
            raise ValueError(
                '{param_name} is set to {param}. '
                'Not in the range of [{low}, {high}].'.format(
                    param=param, low=low, high=high, param_name=param_name))
    Severity: Critical
    Found in pyod/utils/utility.py - About 3 hrs to fix

      Function check_parameter has a Cognitive Complexity of 19 (exceeds 5 allowed). Consider refactoring.
      Invalid

      def check_parameter(param, low=MIN_INT, high=MAX_INT, param_name='',
                          include_left=False, include_right=False):
          """Check if an input is within the defined range.
      
          Parameters
      Severity: Minor
      Found in pyod/utils/utility.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 standardizer has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
      Invalid

      def standardizer(X, X_t=None, keep_scalar=False):
          """Conduct Z-normalization on data to turn input samples become zero-mean
          and unit variance.
      
          Parameters
      Severity: Minor
      Found in pyod/utils/utility.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 check_parameter has 6 arguments (exceeds 4 allowed). Consider refactoring.
      Invalid

      def check_parameter(param, low=MIN_INT, high=MAX_INT, param_name='',
      Severity: Minor
      Found in pyod/utils/utility.py - About 45 mins to fix

        Function generate_bagging_indices has 5 arguments (exceeds 4 allowed). Consider refactoring.
        Invalid

        def generate_bagging_indices(random_state, bootstrap_features, n_features,
        Severity: Minor
        Found in pyod/utils/utility.py - About 35 mins to fix

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

              if not isinstance(high, (numbers.Integral, np.integer, float)):
                  raise TypeError('high is set to {high}. Not numerical'.format(
          Severity: Minor
          Found in pyod/utils/utility.py and 1 other location - About 50 mins to fix
          pyod/utils/utility.py on lines 63..64

          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

              if not isinstance(low, (numbers.Integral, np.integer, float)):
                  raise TypeError('low is set to {low}. Not numerical'.format(low=low))
          Severity: Minor
          Found in pyod/utils/utility.py and 1 other location - About 50 mins to fix
          pyod/utils/utility.py on lines 66..67

          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