increase coverage; PEP8 cleanup

murrayrm · murrayrm · commit a9ac4907539b · 2022-04-14T22:11:28.000-07:00
diff --git a/control/freqplot.py b/control/freqplot.py
@@ -149,12 +149,13 @@ def bode_plot(syslist, omega=None,
         the `deg` parameter. Default is -180 if wrap_phase is False, 0 if
         wrap_phase is True.
     wrap_phase : bool or float
-        If wrap_phase is `False`, then the phase will be unwrapped so that it
-        is continuously increasing or decreasing.  If wrap_phase is `True` the
-        phase will be restricted to the range [-180, 180) (or [:math:`-\\pi`,
-        :math:`\\pi`) radians). If `wrap_phase` is specified as a float, the
-        phase will be offset by 360 degrees if it falls below the specified
-        value. Default to `False`, set by config.defaults['freqplot.wrap_phase'].
+        If wrap_phase is `False` (default), then the phase will be unwrapped
+        so that it is continuously increasing or decreasing.  If wrap_phase is
+        `True` the phase will be restricted to the range [-180, 180) (or
+        [:math:`-\\pi`, :math:`\\pi`) radians). If `wrap_phase` is specified
+        as a float, the phase will be offset by 360 degrees if it falls below
+        the specified value. Default value is `False` and can be set using
+        config.defaults['freqplot.wrap_phase'].
 
     The default values for Bode plot configuration parameters can be reset
     using the `config.defaults` dictionary, with module name 'bode'.
@@ -572,9 +573,6 @@ def nyquist_plot(syslist, omega=None, plot=True, omega_limits=None,
     return_contour : bool, optional
         If 'True', return the contour used to evaluate the Nyquist plot.
 
-    *args : :func:`matplotlib.pyplot.plot` positional properties, optional
-        Additional arguments for `matplotlib` plots (color, linestyle, etc)
-
     **kwargs : :func:`matplotlib.pyplot.plot` keyword properties, optional
         Additional keywords (passed to `matplotlib`)
 
@@ -585,15 +583,12 @@ def nyquist_plot(syslist, omega=None, plot=True, omega_limits=None,
         multiple systems are given, an array of counts is returned.
 
     contour : ndarray (or list of ndarray if len(syslist) > 1)), optional
-        The contour used to create the primary Nyquist curve segment.  To
-        obtain the Nyquist curve values, evaluate system(s) along contour.
+        The contour used to create the primary Nyquist curve segment, returned
+        if `return_contour` is Tue.  To obtain the Nyquist curve values,
+        evaluate system(s) along contour.
 
     Additional Parameters
     ---------------------
-    label_freq : int, optiona
-        Label every nth frequency on the plot.  If not specified, no labels
-        are generated.
-
     arrows : int or 1D/2D array of floats, optional
         Specify the number of arrows to plot on the Nyquist curve.  If an
         integer is passed. that number of equally spaced arrows will be
@@ -629,6 +624,10 @@ def nyquist_plot(syslist, omega=None, plot=True, omega_limits=None,
         imaginary axis. Portions of the Nyquist plot corresponding to indented
         portions of the contour are plotted using a different line style.
 
+    label_freq : int, optiona
+        Label every nth frequency on the plot.  If not specified, no labels
+        are generated.
+
     max_curve_magnitude : float, optional
         Restrict the maximum magnitude of the Nyquist plot to this value.
         Portions of the Nyquist plot whose magnitude is restricted are
@@ -665,6 +664,10 @@ def nyquist_plot(syslist, omega=None, plot=True, omega_limits=None,
     warn_nyquist : bool, optional
         If set to 'False', turn off warnings about frequencies above Nyquist.
 
+    warn_encirclements : bool, optional
+        If set to 'False', turn off warnings about number of encirclements not
+        meeting the Nyquist criterion.
+
     Notes
     -----
     1. If a discrete time model is given, the frequency response is computed
@@ -884,22 +887,22 @@ def _parse_linestyle(style_name, allow_false=False):
                 # See if we need to indent around it
                 if abs(s - p) < indent_radius:
                     # Figure out how much to offset (simple trigonometry)
-                    offset = np.sqrt(indent_radius ** 2 - (s-p).imag ** 2) \
-                        -(s-p).real
+                    offset = np.sqrt(indent_radius ** 2 - (s - p).imag ** 2) \
+                        - (s - p).real
 
                     # Figure out which way to offset the contour point
-                    if p.real < 0 or (np.isclose(p.real, 0) \
-                            and indent_direction == 'right'):
+                    if p.real < 0 or (np.isclose(p.real, 0)
+                                      and indent_direction == 'right'):
                         # Indent to the right
                         splane_contour[i] += offset
 
-                    elif p.real > 0 or (np.isclose(p.real, 0) \
-                            and indent_direction == 'left'):
+                    elif p.real > 0 or (np.isclose(p.real, 0)
+                                        and indent_direction == 'left'):
                         # Indent to the left
                         splane_contour[i] -= offset
 
                     else:
-                        ValueError("unknown value for indent_direction")
+                        raise ValueError("unknown value for indent_direction")
 
         # change contour to z-plane if necessary
         if sys.isctime():
@@ -938,7 +941,8 @@ def _parse_linestyle(style_name, allow_false=False):
                     "number of encirclements does not match Nyquist criterion;"
                     " check frequency range and indent radius/direction",
                     UserWarning, stacklevel=2)
-            elif indent_direction == 'none' and any(sys.pole().real == 0):
+            elif indent_direction == 'none' and \
+                 any(np.isclose(sys.pole().real, 0)):
                 warnings.warn(
                     "system has pure imaginary poles but indentation is"
                     " turned off; results may be meaningless",
@@ -949,14 +953,14 @@ def _parse_linestyle(style_name, allow_false=False):
 
         if plot:
             # Parse the arrows keyword
-            if isinstance(arrows, int):
+            if not arrows:
+                arrow_pos = []
+            elif isinstance(arrows, int):
                 N = arrows
                 # Space arrows out, starting midway along each "region"
                 arrow_pos = np.linspace(0.5/N, 1 + 0.5/N, N, endpoint=False)
             elif isinstance(arrows, (list, np.ndarray)):
                 arrow_pos = np.sort(np.atleast_1d(arrows))
-            elif not arrows:
-                arrow_pos = []
             else:
                 raise ValueError("unknown or unsupported arrow location")
 
@@ -1149,6 +1153,7 @@ def _add_arrows_to_line2D(
         arrows.append(p)
     return arrows
 
+
 #
 # Function to compute Nyquist curve offsets
 #
@@ -1171,13 +1176,13 @@ def _compute_curve_offset(resp, mask, max_offset):
         while i < resp.size and mask[i]:
             i += 1              # Increment the counter
             if i == resp.size:
-                break;
+                break
             # Keep track of the arclength
             arclen[i] = arclen[i-1] + np.abs(resp[i] - resp[i-1])
 
         nsegs += 0.5
         if i == resp.size:
-            break;
+            break
 
         # Save the starting offset of this segment
         seg_start = i
@@ -1186,13 +1191,13 @@ def _compute_curve_offset(resp, mask, max_offset):
         while i < resp.size and not mask[i]:
             i += 1
             if i == resp.size:  # See if we are done with this segment
-                break;
+                break
             # Keep track of the arclength
             arclen[i] = arclen[i-1] + np.abs(resp[i] - resp[i-1])
 
         nsegs += 0.5
         if i == resp.size:
-            break;
+            break
 
         # Save the ending offset of this segment
         seg_end = i
@@ -1332,7 +1337,8 @@ def singular_values_plot(syslist, omega=None,
                          *args, **kwargs):
     """Singular value plot for a system
 
-    Plots a Singular Value plot for the system over a (optional) frequency range.
+    Plots a singular value plot for the system over a (optional) frequency
+    range.
 
     Parameters
     ----------
@@ -1346,11 +1352,11 @@ def singular_values_plot(syslist, omega=None,
         Limits of the frequency vector to generate.
         If Hz=True the limits are in Hz otherwise in rad/s.
     omega_num : int
-        Number of samples to plot.
-        Default value (1000) set by config.defaults['freqplot.number_of_samples'].
+        Number of samples to plot. Default value (1000) set by
+        config.defaults['freqplot.number_of_samples'].
     dB : bool
-        If True, plot result in dB.
-        Default value (False) set by config.defaults['freqplot.dB'].
+        If True, plot result in dB. Default value (False) set by
+        config.defaults['freqplot.dB'].
     Hz : bool
         If True, plot frequency in Hz (omega must be provided in rad/sec).
         Default value (False) set by config.defaults['freqplot.Hz']
@@ -1372,7 +1378,8 @@ def singular_values_plot(syslist, omega=None,
     --------
     >>> import numpy as np
     >>> den = [75, 1]
-    >>> sys = TransferFunction([[[87.8], [-86.4]], [[108.2], [-109.6]]], [[den, den], [den, den]])
+    >>> sys = TransferFunction(
+        [[[87.8], [-86.4]], [[108.2], [-109.6]]], [[den, den], [den, den]])
     >>> omega = np.logspace(-4, 1, 1000)
     >>> sigma, omega = singular_values_plot(sys, plot=True)
     >>> singular_values_plot(sys, 0.0, plot=False)
@@ -1479,7 +1486,8 @@ def singular_values_plot(syslist, omega=None,
     # Add a grid to the plot + labeling
     if plot:
         ax_sigma.grid(grid, which='both')
-        ax_sigma.set_ylabel("Singular Values (dB)" if dB else "Singular Values")
+        ax_sigma.set_ylabel(
+            "Singular Values (dB)" if dB else "Singular Values")
         ax_sigma.set_xlabel("Frequency (Hz)" if Hz else "Frequency (rad/sec)")
 
     if len(syslist) == 1:
diff --git a/control/tests/nyquist_test.py b/control/tests/nyquist_test.py
@@ -185,6 +185,7 @@ def test_nyquist_fbs_examples():
 
 @pytest.mark.parametrize("arrows", [
     None,                       # default argument
+    False,                      # no arrows
     1, 2, 3, 4,                 # specified number of arrows
     [0.1, 0.5, 0.9],            # specify arc lengths
 ])
@@ -318,12 +319,22 @@ def test_nyquist_exceptions():
     with pytest.warns(FutureWarning, match="use `arrow_size` instead"):
         ct.nyquist_plot(sys, arrow_width=8, arrow_length=6)
 
+    # Unknown arrow keyword
+    with pytest.raises(ValueError, match="unsupported arrow location"):
+        ct.nyquist_plot(sys, arrows='uniform')
+
+    # Bad value for indent direction
+    sys = ct.tf([1], [1, 0, 1])
+    with pytest.raises(ValueError, match="unknown value for indent"):
+        ct.nyquist_plot(sys, indent_direction='up')
+
     # Discrete time system sampled above Nyquist frequency
     sys = ct.drss(2, 1, 1)
     sys.dt = 0.01
     with pytest.warns(UserWarning, match="above Nyquist"):
         ct.nyquist_plot(sys, np.logspace(-2, 3))
 
+
 def test_linestyle_checks():
     sys = ct.rss(2, 1, 1)
 
@@ -337,6 +348,10 @@ def test_linestyle_checks():
     with pytest.raises(ValueError, match="invalid 'mirror_style'"):
         ct.nyquist_plot(sys, mirror_style=0.2)
 
+    # If only one line style is given use, the default value for the other
+    # TODO: for now, just make sure the signature works; no correct check yet
+    ct.nyquist_plot(sys, primary_style=':', mirror_style='-.')
+
 @pytest.mark.usefixtures("editsdefaults")
 def test_nyquist_legacy():
     ct.use_legacy_defaults('0.9.1')
