Sign upLogin

alchemyst/Skogestad-Python

View on GitHub
Star
robustcontrol/Chapter_05.py

Summary

Maintainability
D
1 day
Test Coverage

File Chapter_05.py has 368 lines of code (exceeds 250 allowed). Consider refactoring.
Open

from __future__ import division
from __future__ import print_function

import numpy as np
import matplotlib.pyplot as plt
Severity: Minor
Found in robustcontrol/Chapter_05.py - About 4 hrs to fix

    Cyclomatic complexity is too high in function rule6. (6)
    Open

    def rule6(G, Gm, message=False):
    """
    This is rule six of chapter five

    Calculates if tight control at low frequencies with RHP-zeros is possible
    Severity: Minor
    Found in robustcontrol/Chapter_05.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 rule6 has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
    Open

    def rule6(G, Gm, message=False):
    """
    This is rule six of chapter five

    Calculates if tight control at low frequencies with RHP-zeros is possible
    Severity: Minor
    Found in robustcontrol/Chapter_05.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 rule2 has 8 arguments (exceeds 4 allowed). Consider refactoring.
    Open

    def rule2(G, R, K, wr, message=False, plot=False, w1=-4, w2=2):
    Severity: Major
    Found in robustcontrol/Chapter_05.py - About 1 hr to fix

      Function rule1 has 7 arguments (exceeds 4 allowed). Consider refactoring.
      Open

      def rule1(G, Gd, K=1, message=False, plot=False, w1=-4, w2=2):
      Severity: Major
      Found in robustcontrol/Chapter_05.py - About 50 mins to fix

        Function allSISOrules has 7 arguments (exceeds 4 allowed). Consider refactoring.
        Open

        def allSISOrules(G, deadtime, Gd, K, R, wr, Gm):
        Severity: Major
        Found in robustcontrol/Chapter_05.py - About 50 mins to fix

          Function rule4 has 6 arguments (exceeds 4 allowed). Consider refactoring.
          Open

          def rule4(G, R, wr, message=False, w1=-4, w2=2):
          Severity: Minor
          Found in robustcontrol/Chapter_05.py - About 45 mins to fix

            Function rule5 has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
            Open

            def rule5(G, Gm=1, message=False):
    """
    This is rule five of chapter five

    Calculates constraints for time delay, wc < 1 / theta
            Severity: Minor
            Found in robustcontrol/Chapter_05.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 rule3 has 5 arguments (exceeds 4 allowed). Consider refactoring.
            Open

            def rule3(G, Gd, message=False, w1=-4, w2=2):
            Severity: Minor
            Found in robustcontrol/Chapter_05.py - About 35 mins to fix

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

              def rule8(G, message=False):
    """
    This is rule eight of chapter five

    This function determines if the plant is open-loop stable at its poles
              Severity: Minor
              Found in robustcontrol/Chapter_05.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 merge all siso_controllability.py routines with this file
              Severity: Minor
              Found in robustcontrol/Chapter_05.py by fixme

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

                  if message:
        print('Rule 7:')
        if valid7:
            print('wc < wu :', wc, '<', wu)
        else:
              Severity: Minor
              Found in robustcontrol/Chapter_05.py and 1 other location - About 50 mins to fix
              robustcontrol/Chapter_05.py on lines 454..459

              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 message:
        print('Rule 8:')
        if valid8:
            print('wc > 2p :', wc, '>', wp)
        else:
              Severity: Minor
              Found in robustcontrol/Chapter_05.py and 1 other location - About 50 mins to fix
              robustcontrol/Chapter_05.py on lines 410..415

              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

              At least two spaces before inline comment
              Open

              if __name__ == '__main__': # only executed when called directly
              Severity: Minor
              Found in robustcontrol/Chapter_05.py by pep8

              Separate inline comments by at least two spaces.

              An inline comment is a comment on the same line as a statement.
Inline comments should be separated by at least two spaces from the
statement. They should start with a # and a single space.

Each line of a block comment starts with a # and a single space
(unless it is indented text inside the comment).

Okay: x = x + 1  # Increment x
Okay: x = x + 1    # Increment x
Okay: # Block comment
E261: x = x + 1 # Increment x
E262: x = x + 1  #Increment x
E262: x = x + 1  #  Increment x
E265: #Block comment
E266: ### Block comment

              Invalid escape sequence '\o'
              Open

                  plt.scatter(wu, 1, color='magenta', label='$\omega_u$')
              Severity: Minor
              Found in robustcontrol/Chapter_05.py by pep8

              Invalid escape sequences are deprecated in Python 3.6.

              Okay: regex = r'\.png$'
W605: regex = '\.png$'

              Expected 2 blank lines after class or function definition, found 1
              Open

              if __name__ == '__main__': # only executed when called directly
              Severity: Minor
              Found in robustcontrol/Chapter_05.py by pep8

              Separate top-level function and class definitions with two blank lines.

              Method definitions inside a class are separated by a single blank
line.

Extra blank lines may be used (sparingly) to separate groups of
related functions.  Blank lines may be omitted between a bunch of
related one-liners (e.g. a set of dummy implementations).

Use blank lines in functions, sparingly, to indicate logical
sections.

Okay: def a():\n    pass\n\n\ndef b():\n    pass
Okay: def a():\n    pass\n\n\nasync def b():\n    pass
Okay: def a():\n    pass\n\n\n# Foo\n# Bar\n\ndef b():\n    pass
Okay: default = 1\nfoo = 1
Okay: classify = 1\nfoo = 1

E301: class Foo:\n    b = 0\n    def bar():\n        pass
E302: def a():\n    pass\n\ndef b(n):\n    pass
E302: def a():\n    pass\n\nasync def b(n):\n    pass
E303: def a():\n    pass\n\n\n\ndef b(n):\n    pass
E303: def a():\n\n\n\n    pass
E304: @decorator\n\ndef a():\n    pass
E305: def a():\n    pass\na()
E306: def a():\n    def b():\n        pass\n    def c():\n        pass

              Invalid escape sequence '\o'
              Open

                  plt.axvline(wc, ls='--', color='k', label='$\omega_c$')
              Severity: Minor
              Found in robustcontrol/Chapter_05.py by pep8

              Invalid escape sequences are deprecated in Python 3.6.

              Okay: regex = r'\.png$'
W605: regex = '\.png$'

              Invalid escape sequence '\o'
              Open

                  plt.axvline(wd, ls='--', color='k', label='$\omega_d$')
              Severity: Minor
              Found in robustcontrol/Chapter_05.py by pep8

              Invalid escape sequences are deprecated in Python 3.6.

              Okay: regex = r'\.png$'
W605: regex = '\.png$'

              There are no issues that match your filters.

              Category
              Status