Replace mplcleanup decorator use by fixture

bnavigator · bnavigator · commit 7f13a07d26e3 · 2022-08-20T12:54:00.000+02:00
diff --git a/control/tests/config_test.py b/control/tests/config_test.py
@@ -8,7 +8,6 @@
 from math import pi, log10
 
 import matplotlib.pyplot as plt
-from matplotlib.testing.decorators import cleanup as mplcleanup
 import numpy as np
 import pytest
 
@@ -18,7 +17,6 @@
 @pytest.mark.usefixtures("editsdefaults")  # makes sure to reset the defaults
                                            # to the test configuration
 class TestConfig:
-
     # Create a simple second order system to use for testing
     sys = ct.tf([10], [1, 2, 1])
 
@@ -28,8 +26,7 @@ def test_set_defaults(self):
         assert ct.config.defaults['freqplot.deg'] == 2
         assert ct.config.defaults['freqplot.Hz'] is None
 
-    @mplcleanup
-    def test_get_param(self):
+    def test_get_param(self, mplcleanup):
         assert ct.config._get_param('freqplot', 'dB')\
             == ct.config.defaults['freqplot.dB']
         assert ct.config._get_param('freqplot', 'dB', 1) == 1
@@ -92,8 +89,7 @@ def test_default_deprecation(self):
             assert ct.config.defaults['bode.Hz'] \
                 == ct.config.defaults['freqplot.Hz']
 
-    @mplcleanup
-    def test_fbs_bode(self):
+    def test_fbs_bode(self, mplcleanup):
         ct.use_fbs_defaults()
 
         # Generate a Bode plot
@@ -137,8 +133,7 @@ def test_fbs_bode(self):
         phase_x, phase_y = (((plt.gcf().axes[1]).get_lines())[0]).get_data()
         np.testing.assert_almost_equal(phase_y[-1], -pi, decimal=2)
 
-    @mplcleanup
-    def test_matlab_bode(self):
+    def test_matlab_bode(self, mplcleanup):
         ct.use_matlab_defaults()
 
         # Generate a Bode plot
@@ -182,8 +177,7 @@ def test_matlab_bode(self):
         phase_x, phase_y = (((plt.gcf().axes[1]).get_lines())[0]).get_data()
         np.testing.assert_almost_equal(phase_y[-1], -pi, decimal=2)
 
-    @mplcleanup
-    def test_custom_bode_default(self):
+    def test_custom_bode_default(self, mplcleanup):
         ct.config.defaults['freqplot.dB'] = True
         ct.config.defaults['freqplot.deg'] = True
         ct.config.defaults['freqplot.Hz'] = True
@@ -204,8 +198,7 @@ def test_custom_bode_default(self):
         np.testing.assert_almost_equal(mag_y[0], 20*log10(10), decimal=3)
         np.testing.assert_almost_equal(phase_y[-1], -pi, decimal=2)
 
-    @mplcleanup
-    def test_bode_number_of_samples(self):
+    def test_bode_number_of_samples(self, mplcleanup):
         # Set the number of samples (default is 50, from np.logspace)
         mag_ret, phase_ret, omega_ret = ct.bode_plot(self.sys, omega_num=87)
         assert len(mag_ret) == 87
@@ -219,8 +212,7 @@ def test_bode_number_of_samples(self):
         mag_ret, phase_ret, omega_ret = ct.bode_plot(self.sys, omega_num=87)
         assert len(mag_ret) == 87
 
-    @mplcleanup
-    def test_bode_feature_periphery_decade(self):
+    def test_bode_feature_periphery_decade(self, mplcleanup):
         # Generate a sample Bode plot to figure out the range it uses
         ct.reset_defaults()     # Make sure starting state is correct
         mag_ret, phase_ret, omega_ret = ct.bode_plot(self.sys, Hz=False)
diff --git a/control/tests/conftest.py b/control/tests/conftest.py
@@ -1,13 +1,11 @@
 """conftest.py - pytest local plugins and fixtures"""
 
 import os
-import sys
 from contextlib import contextmanager
 
 import matplotlib as mpl
 import numpy as np
 import pytest
-import scipy as sp
 
 import control
 
@@ -45,15 +43,15 @@ def control_defaults():
                 params=[pytest.param("arrayout", marks=matrixerrorfilter),
                         pytest.param("matrixout", marks=matrixfilter)])
 def matarrayout(request):
-    """Switch the config to use np.ndarray and np.matrix as returns"""
+    """Switch the config to use np.ndarray and np.matrix as returns."""
     restore = control.config.defaults['statesp.use_numpy_matrix']
     control.use_numpy_matrix(request.param == "matrixout", warn=False)
     yield
     control.use_numpy_matrix(restore, warn=False)
 
 
 def ismatarrayout(obj):
-    """Test if the returned object has the correct type as configured
+    """Test if the returned object has the correct type as configured.
 
     note that isinstance(np.matrix(obj), np.ndarray) is True
     """
@@ -63,15 +61,15 @@ def ismatarrayout(obj):
 
 
 def asmatarrayout(obj):
-    """Return a object according to the configured default"""
+    """Return a object according to the configured default."""
     use_matrix = control.config.defaults['statesp.use_numpy_matrix']
     matarray = np.asmatrix if use_matrix else np.asarray
     return matarray(obj)
 
 
 @contextmanager
 def check_deprecated_matrix():
-    """Check that a call produces a deprecation warning because of np.matrix"""
+    """Check that a call produces a deprecation warning because of np.matrix."""
     use_matrix = control.config.defaults['statesp.use_numpy_matrix']
     if use_matrix:
         with pytest.deprecated_call():
@@ -94,13 +92,13 @@ def check_deprecated_matrix():
                           False)]
                         if usebydefault or TEST_MATRIX_AND_ARRAY])
 def matarrayin(request):
-    """Use array and matrix to construct input data in tests"""
+    """Use array and matrix to construct input data in tests."""
     return request.param
 
 
 @pytest.fixture(scope="function")
 def editsdefaults():
-    """Make sure any changes to the defaults only last during a test"""
+    """Make sure any changes to the defaults only last during a test."""
     restore = control.config.defaults.copy()
     yield
     control.config.defaults = restore.copy()
