Sign upLogin

qutip/qutip

View on GitHub
Star
qutip/visualization.py

Summary

Maintainability
F
5 days
Test Coverage

Function hinton has a Cognitive Complexity of 68 (exceeds 20 allowed). Consider refactoring.
Open

def hinton(rho, x_basis=None, y_basis=None, color_style="scaled",
           label_top=True, *, cmap=None, colorbar=True, fig=None, ax=None):
    """Draws a Hinton diagram to visualize a density matrix or superoperator.

    Parameters
Severity: Minor
Found in qutip/visualization.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 plot_wigner has 13 arguments (exceeds 10 allowed). Consider refactoring.
Open

def plot_wigner(rho, xvec=None, yvec=None, method='clenshaw', projection='2d',
Severity: Major
Found in qutip/visualization.py - About 50 mins to fix

    Function matrix_histogram has 13 arguments (exceeds 10 allowed). Consider refactoring.
    Open

    def matrix_histogram(M, x_basis=None, y_basis=None, limits=None,
    Severity: Major
    Found in qutip/visualization.py - About 50 mins to fix

      FIXME found
      Open

          # FIXME: assumes dims, such that we only need left_dims == dims[0].
      Severity: Minor
      Found in qutip/visualization.py by fixme

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

      def _update_xaxis(spacing, M, ax, xlabels):
    """
    updates the x-axis
    """
    xtics = [x + (1 - (spacing / 2)) for x in range(M.shape[0])]
      Severity: Major
      Found in qutip/visualization.py and 1 other location - About 2 days to fix
      qutip/visualization.py on lines 613..628

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

      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

      def _update_yaxis(spacing, M, ax, ylabels):
    """
    updates the y-axis
    """
    ytics = [y + (1 - (spacing / 2)) for y in range(M.shape[1])]
      Severity: Major
      Found in qutip/visualization.py and 1 other location - About 2 days to fix
      qutip/visualization.py on lines 631..646

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

      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 parse_version(mpl.__version__) >= parse_version('3.4'):
        def _axes3D(fig, *args, **kwargs):
            ax = Axes3D(fig, *args, auto_add_to_figure=False, **kwargs)
            return fig.add_axes(ax)
    else:
      Severity: Major
      Found in qutip/visualization.py and 1 other location - About 1 hr to fix
      qutip/bloch.py on lines 21..27

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

      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

      Line too long (82 > 79 characters)
      Open

          method : str {'clenshaw', 'iterative', 'laguerre', 'fft'}, default: 'clenshaw'
      Severity: Minor
      Found in qutip/visualization.py by pep8

      Limit all lines to a maximum of 79 characters.

      There are still many devices around that are limited to 80 character
lines; plus, limiting windows to 80 characters makes it possible to
have several windows side-by-side.  The default wrapping on such
devices looks ugly.  Therefore, please limit all lines to a maximum
of 79 characters. For flowing long blocks of text (docstrings or
comments), limiting the length to 72 characters is recommended.

Reports error E501.

      Do not use bare 'except'
      Open

      except:
      Severity: Minor
      Found in qutip/visualization.py by pep8

      When catching exceptions, mention specific exceptions when possible.

      Okay: except Exception:
Okay: except BaseException:
E722: except:

      Do not use bare 'except'
      Open

              except:
      Severity: Minor
      Found in qutip/visualization.py by pep8

      When catching exceptions, mention specific exceptions when possible.

      Okay: except Exception:
Okay: except BaseException:
E722: except:

      There are no issues that match your filters.

      Category
      Status