add DefaultDict for deprecation handling

bnavigator · bnavigator · commit 21ef29e53de8 · 2021-04-29T22:34:58.000+02:00
diff --git a/control/config.py b/control/config.py
@@ -20,7 +20,43 @@
     'control.squeeze_time_response': None,
     'forced_response.return_x': False,
 }
-defaults = dict(_control_defaults)
+
+
+class DefaultDict(dict):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+    def __getitem__(self, key):
+        return super().__getitem__(self._check_deprecation(key))
+
+    def __setitem__(self, key, value):
+        super().__setitem__(self._check_deprecation(key), value)
+
+    def __missing__(self, key):
+        repl = self._check_deprecation(key)
+        if self.__contains__(repl):
+            return self[repl]
+        else:
+            raise KeyError
+
+    def copy(self):
+        return DefaultDict(self)
+
+    def get(self, key, default=None):
+        return super().get(self._check_deprecation(key), default)
+
+    def _check_deprecation(self, key):
+        if self.__contains__(f"deprecated.{key}"):
+            repl = self[f"deprecated.{key}"]
+            warnings.warn(f"config.defaults['{key}'] has been renamed to "
+                          f"config.defaults['{repl}'].",
+                          DeprecationWarning)
+            return repl
+        else:
+            return key
+
+
+defaults = DefaultDict(_control_defaults)
 
 
 def set_defaults(module, **keywords):
diff --git a/control/freqplot.py b/control/freqplot.py
@@ -68,8 +68,16 @@
     'freqplot.Hz': False,  # Plot frequency in Hertz
     'freqplot.grid': True,  # Turn on grid for gain and phase
     'freqplot.wrap_phase': False,  # Wrap the phase plot at a given value
+
+    # deprecations
+    'deprecated.bode.dB': 'freqplot.dB',
+    'deprecated.bode.deg': 'freqplot.deg',
+    'deprecated.bode.Hz': 'freqplot.Hz',
+    'deprecated.bode.grid': 'freqplot.grid',
+    'deprecated.bode.wrap_phase': 'freqplot.wrap_phase',
 }
 
+
 #
 # Main plotting functions
 #
diff --git a/control/tests/config_test.py b/control/tests/config_test.py
@@ -49,6 +49,43 @@ def test_get_param(self):
 
         assert ct.config._get_param('config', 'test4', {'test4': 1}, None) == 1
 
+    def test_default_deprecation(self):
+        ct.config.defaults['config.newkey'] = 1
+        ct.config.defaults['deprecated.config.oldkey'] = 'config.newkey'
+        ct.config.defaults['deprecated.config.oldmiss'] = 'config.newmiss'
+
+        msgpattern = r'config\.oldkey.* has been renamed to .*config\.newkey'
+
+        with pytest.warns(DeprecationWarning, match=msgpattern):
+            assert ct.config.defaults['config.oldkey'] == 1
+        with pytest.warns(DeprecationWarning, match=msgpattern):
+            ct.config.defaults['config.oldkey'] = 2
+        with pytest.warns(DeprecationWarning, match=msgpattern):
+            assert ct.config.defaults['config.oldkey'] == 2
+        assert ct.config.defaults['config.newkey'] == 2
+
+        ct.config.set_defaults('config', newkey=3)
+        with pytest.warns(DeprecationWarning, match=msgpattern):
+            assert ct.config._get_param('config', 'oldkey') == 3
+        with pytest.warns(DeprecationWarning, match=msgpattern):
+            ct.config.set_defaults('config', oldkey=4)
+        with pytest.warns(DeprecationWarning, match=msgpattern):
+            assert ct.config.defaults['config.oldkey'] == 4
+        assert ct.config.defaults['config.newkey'] == 4
+
+        with pytest.raises(KeyError):
+            with pytest.warns(DeprecationWarning, match=msgpattern):
+                ct.config.defaults['config.oldmiss']
+        with pytest.raises(KeyError):
+            ct.config.defaults['config.neverdefined']
+
+        # assert that reset defaults keeps the custom type
+        ct.config.reset_defaults()
+        with pytest.warns(DeprecationWarning,
+                          match='bode.* has been renamed to.*freqplot'):
+            assert ct.config.defaults['bode.Hz'] \
+                == ct.config.defaults['freqplot.Hz']
+
     @mplcleanup
     def test_fbs_bode(self):
         ct.use_fbs_defaults()

Original file line number	Diff line number	Diff line change
`@@ -68,8 +68,16 @@`
`68`	`68`	`'freqplot.Hz': False, # Plot frequency in Hertz`
`69`	`69`	`'freqplot.grid': True, # Turn on grid for gain and phase`
`70`	`70`	`'freqplot.wrap_phase': False, # Wrap the phase plot at a given value`
	`71`	`+`
	`72`	`+ # deprecations`
	`73`	`+ 'deprecated.bode.dB': 'freqplot.dB',`
	`74`	`+ 'deprecated.bode.deg': 'freqplot.deg',`
	`75`	`+ 'deprecated.bode.Hz': 'freqplot.Hz',`
	`76`	`+ 'deprecated.bode.grid': 'freqplot.grid',`
	`77`	`+ 'deprecated.bode.wrap_phase': 'freqplot.wrap_phase',`
`71`	`78`	`}`
`72`	`79`
	`80`	`+`
`73`	`81`	`#`
`74`	`82`	`# Main plotting functions`
`75`	`83`	`#`