Merge pull request matplotlib#29565 from anntzer/rcd

Remove rcParams deprecation machinery

Author: timhoffm

lib/matplotlib/__init__.py

@@ -639,18 +639,6 @@ def gen_candidates():
                        "install is broken")
 
 
-# rcParams deprecated and automatically mapped to another key.
-# Values are tuples of (version, new_name, f_old2new, f_new2old).
-_deprecated_map = {}
-# rcParams deprecated; some can manually be mapped to another key.
-# Values are tuples of (version, new_name_or_None).
-_deprecated_ignore_map = {}
-# rcParams deprecated; can use None to suppress warnings; remain actually
-# listed in the rcParams.
-# Values are tuples of (version,)
-_deprecated_remain_as_none = {}
-
-
 @_docstring.Substitution(
     "\n".join(map("- {}".format, sorted(rcsetup._validators, key=str.lower)))
 )
@@ -747,56 +735,28 @@ def _ensure_has_backend(self):
         dict.setdefault(self, "backend", rcsetup._auto_backend_sentinel)
 
     def __setitem__(self, key, val):
+        if (key == "backend"
+                and val is rcsetup._auto_backend_sentinel
+                and "backend" in self):
+            return
         try:
-            if key in _deprecated_map:
-                version, alt_key, alt_val, inverse_alt = _deprecated_map[key]
-                _api.warn_deprecated(
-                    version, name=key, obj_type="rcparam", alternative=alt_key)
-                key = alt_key
-                val = alt_val(val)
-            elif key in _deprecated_remain_as_none and val is not None:
-                version, = _deprecated_remain_as_none[key]
-                _api.warn_deprecated(version, name=key, obj_type="rcparam")
-            elif key in _deprecated_ignore_map:
-                version, alt_key = _deprecated_ignore_map[key]
-                _api.warn_deprecated(
-                    version, name=key, obj_type="rcparam", alternative=alt_key)
-                return
-            elif key == 'backend':
-                if val is rcsetup._auto_backend_sentinel:
-                    if 'backend' in self:
-                        return
-            try:
-                cval = self.validate[key](val)
-            except ValueError as ve:
-                raise ValueError(f"Key {key}: {ve}") from None
-            self._set(key, cval)
+            cval = self.validate[key](val)
         except KeyError as err:
             raise KeyError(
                 f"{key} is not a valid rc parameter (see rcParams.keys() for "
                 f"a list of valid parameters)") from err
+        except ValueError as ve:
+            raise ValueError(f"Key {key}: {ve}") from None
+        self._set(key, cval)
 
     def __getitem__(self, key):
-        if key in _deprecated_map:
-            version, alt_key, alt_val, inverse_alt = _deprecated_map[key]
-            _api.warn_deprecated(
-                version, name=key, obj_type="rcparam", alternative=alt_key)
-            return inverse_alt(self._get(alt_key))
-
-        elif key in _deprecated_ignore_map:
-            version, alt_key = _deprecated_ignore_map[key]
-            _api.warn_deprecated(
-                version, name=key, obj_type="rcparam", alternative=alt_key)
-            return self._get(alt_key) if alt_key else None
-
         # In theory, this should only ever be used after the global rcParams
         # has been set up, but better be safe e.g. in presence of breakpoints.
-        elif key == "backend" and self is globals().get("rcParams"):
+        if key == "backend" and self is globals().get("rcParams"):
             val = self._get(key)
             if val is rcsetup._auto_backend_sentinel:
                 from matplotlib import pyplot as plt
                 plt.switch_backend(rcsetup._auto_backend_sentinel)
-
         return self._get(key)
 
     def _get_backend_or_none(self):
@@ -818,6 +778,8 @@ def __str__(self):
 
     def __iter__(self):
         """Yield sorted list of keys."""
+        # Deprecation warnings are silenced to cover the case where some
+        # rcParams entries are being deprecated.
         with _api.suppress_matplotlib_deprecation_warning():
             yield from sorted(dict.__iter__(self))
 
@@ -939,11 +901,6 @@ def _rc_params_in_file(fname, transform=lambda x: x, fail_on_error=False):
                 except Exception as msg:
                     _log.warning('Bad value in file %r, line %d (%r): %s',
                                  fname, line_no, line.rstrip('\n'), msg)
-        elif key in _deprecated_ignore_map:
-            version, alt_key = _deprecated_ignore_map[key]
-            _api.warn_deprecated(
-                version, name=key, alternative=alt_key, obj_type='rcparam',
-                addendum="Please update your matplotlibrc.")
         else:
             # __version__ must be looked up as an attribute to trigger the
             # module-level __getattr__.

lib/matplotlib/tests/test_rcparams.py

@@ -564,40 +564,6 @@ def test_backend_fallback_headful(tmp_path):
 
 
 def test_deprecation(monkeypatch):
-    monkeypatch.setitem(
-        mpl._deprecated_map, "patch.linewidth",
-        ("0.0", "axes.linewidth", lambda old: 2 * old, lambda new: new / 2))
-    with pytest.warns(mpl.MatplotlibDeprecationWarning):
-        assert mpl.rcParams["patch.linewidth"] \
-            == mpl.rcParams["axes.linewidth"] / 2
-    with pytest.warns(mpl.MatplotlibDeprecationWarning):
-        mpl.rcParams["patch.linewidth"] = 1
-    assert mpl.rcParams["axes.linewidth"] == 2
-
-    monkeypatch.setitem(
-        mpl._deprecated_ignore_map, "patch.edgecolor",
-        ("0.0", "axes.edgecolor"))
-    with pytest.warns(mpl.MatplotlibDeprecationWarning):
-        assert mpl.rcParams["patch.edgecolor"] \
-            == mpl.rcParams["axes.edgecolor"]
-    with pytest.warns(mpl.MatplotlibDeprecationWarning):
-        mpl.rcParams["patch.edgecolor"] = "#abcd"
-    assert mpl.rcParams["axes.edgecolor"] != "#abcd"
-
-    monkeypatch.setitem(
-        mpl._deprecated_ignore_map, "patch.force_edgecolor",
-        ("0.0", None))
-    with pytest.warns(mpl.MatplotlibDeprecationWarning):
-        assert mpl.rcParams["patch.force_edgecolor"] is None
-
-    monkeypatch.setitem(
-        mpl._deprecated_remain_as_none, "svg.hashsalt",
-        ("0.0",))
-    with pytest.warns(mpl.MatplotlibDeprecationWarning):
-        mpl.rcParams["svg.hashsalt"] = "foobar"
-    assert mpl.rcParams["svg.hashsalt"] == "foobar"  # Doesn't warn.
-    mpl.rcParams["svg.hashsalt"] = None  # Doesn't warn.
-
     mpl.rcParams.update(mpl.rcParams.copy())  # Doesn't warn.
     # Note that the warning suppression actually arises from the
     # iteration over the updater rcParams being protected by