Simplify the rcparams deprecation machinery.

anntzer · anntzer · commit 5207debc76b1 · 2019-11-21T11:06:18.000+01:00
Just have a single kind of deprecated rcParams, which emit a
DeprecationWarning on get and on set.

... which caught the fact that we were previously *not* warning on
access to text.latex.unicode, now we do but need to avoid triggering the
warnings internally.
diff --git a/lib/matplotlib/__init__.py b/lib/matplotlib/__init__.py
@@ -713,29 +713,16 @@ 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 = {
-    'pgf.debug': ('3.0', None),
+# Deprecated rcParams, with kwargs to warn_deprecated.  Must at least specify
+# the 'since' key.
+_deprecated_rcs = {
+    'pgf.debug': {'since': '3.0'},
+    'text.latex.unicode': {'since': '3.0'},
+    'savefig.frameon': {'since': '3.1'},
+    'verbose.fileo': {'since': '3.1'},
+    'verbose.level': {'since': '3.1'},
 }
 
-# rcParams deprecated; can use None to suppress warnings; remain actually
-# listed in the rcParams (not included in _all_deprecated).
-# Values are tuples of (version,)
-_deprecated_remain_as_none = {
-    'text.latex.unicode': ('3.0',),
-    'savefig.frameon': ('3.1',),
-    'verbose.fileo': ('3.1',),
-    'verbose.level': ('3.1',),
-}
-
-
-_all_deprecated = {*_deprecated_map, *_deprecated_ignore_map}
-
 
 class RcParams(MutableMapping, dict):
     """
@@ -750,34 +737,20 @@ class RcParams(MutableMapping, dict):
     """
 
     validate = {key: converter
-                for key, (default, converter) in defaultParams.items()
-                if key not in _all_deprecated}
+                for key, (default, converter) in defaultParams.items()}
 
     # validate values on the way in
     def __init__(self, *args, **kwargs):
         self.update(*args, **kwargs)
 
     def __setitem__(self, key, val):
+        if (key == 'backend' and val is rcsetup._auto_backend_sentinel
+                and 'backend' in self):
+            return
+        if key in _deprecated_rcs:
+            cbook.warn_deprecated(
+                **{"name": key, "obj_type": "rcparam", **_deprecated_rcs[key]})
         try:
-            if key in _deprecated_map:
-                version, alt_key, alt_val, inverse_alt = _deprecated_map[key]
-                cbook.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]
-                cbook.warn_deprecated(
-                    version, name=key, obj_type="rcparam")
-            elif key in _deprecated_ignore_map:
-                version, alt_key = _deprecated_ignore_map[key]
-                cbook.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:
@@ -789,24 +762,14 @@ def __setitem__(self, key, val):
                 f"a list of valid parameters)")
 
     def __getitem__(self, key):
-        if key in _deprecated_map:
-            version, alt_key, alt_val, inverse_alt = _deprecated_map[key]
-            cbook.warn_deprecated(
-                version, name=key, obj_type="rcparam", alternative=alt_key)
-            return inverse_alt(dict.__getitem__(self, alt_key))
-
-        elif key in _deprecated_ignore_map:
-            version, alt_key = _deprecated_ignore_map[key]
-            cbook.warn_deprecated(
-                version, name=key, obj_type="rcparam", alternative=alt_key)
-            return dict.__getitem__(self, alt_key) if alt_key else None
-
-        elif key == "backend":
+        if key == "backend":
             val = dict.__getitem__(self, key)
             if val is rcsetup._auto_backend_sentinel:
                 from matplotlib import pyplot as plt
                 plt.switch_backend(rcsetup._auto_backend_sentinel)
-
+        if key in _deprecated_rcs:
+            cbook.warn_deprecated(
+                **{"name": key, "obj_type": "rcparam", **_deprecated_rcs[key]})
         return dict.__getitem__(self, key)
 
     def __repr__(self):
@@ -926,11 +889,6 @@ def _rc_params_in_file(fname, fail_on_error=False):
                     error_details = _error_details_fmt % (line_no, line, fname)
                     _log.warning('Bad val %r on %s\n\t%s',
                                  val, error_details, msg)
-        elif key in _deprecated_ignore_map:
-            version, alt_key = _deprecated_ignore_map[key]
-            cbook.warn_deprecated(
-                version, name=key, alternative=alt_key,
-                addendum="Please update your matplotlibrc.")
         else:
             version = 'master' if '.post' in __version__ else f'v{__version__}'
             print(f"""
@@ -964,8 +922,7 @@ def rc_params_from_file(fname, fail_on_error=False, use_default_template=True):
 
     iter_params = defaultParams.items()
     with cbook._suppress_matplotlib_deprecation_warning():
-        config = RcParams([(key, default) for key, (default, _) in iter_params
-                           if key not in _all_deprecated])
+        config = RcParams((key, default) for key, (default, _) in iter_params)
     config.update(config_from_file)
 
     if config['datapath'] is None:
@@ -990,9 +947,8 @@ def rc_params_from_file(fname, fail_on_error=False, use_default_template=True):
 
 with cbook._suppress_matplotlib_deprecation_warning():
     rcParamsOrig = RcParams(rcParams.copy())
-    rcParamsDefault = RcParams([(key, default) for key, (default, converter) in
-                                defaultParams.items()
-                                if key not in _all_deprecated])
+    rcParamsDefault = RcParams(
+        (key, default) for key, (default, converter) in defaultParams.items())
 
 if rcParams['axes.formatter.use_locale']:
     locale.setlocale(locale.LC_ALL, '')
diff --git a/lib/matplotlib/projections/geo.py b/lib/matplotlib/projections/geo.py
@@ -23,7 +23,8 @@ def __init__(self, round_to=1.0):
 
         def __call__(self, x, pos=None):
             degrees = round(np.rad2deg(x) / self._round_to) * self._round_to
-            if rcParams['text.usetex'] and not rcParams['text.latex.unicode']:
+            if (rcParams['text.usetex']
+                    and not dict.__getitem__(rcParams, 'text.latex.unicode')):
                 return r"$%0.0f^\circ$" % degrees
             else:
                 return "%0.0f\N{DEGREE SIGN}" % degrees
diff --git a/lib/matplotlib/projections/polar.py b/lib/matplotlib/projections/polar.py
@@ -166,7 +166,8 @@ def __call__(self, x, pos=None):
         d = np.rad2deg(abs(vmax - vmin))
         digits = max(-int(np.log10(d) - 1.5), 0)
 
-        if rcParams['text.usetex'] and not rcParams['text.latex.unicode']:
+        if (rcParams['text.usetex']
+                and not dict.__getitem__(rcParams, 'text.latex.unicode')):
             format_str = r"${value:0.{digits:d}f}^\circ$"
             return format_str.format(value=np.rad2deg(x), digits=digits)
         else:
diff --git a/lib/matplotlib/tests/test_rcparams.py b/lib/matplotlib/tests/test_rcparams.py
@@ -462,14 +462,13 @@ def test_rcparams_reset_after_fail():
 
 def test_if_rctemplate_is_up_to_date():
     # This tests if the matplotlibrc.template file contains all valid rcParams.
-    deprecated = {*mpl._all_deprecated, *mpl._deprecated_remain_as_none}
     with cbook._get_data_path('matplotlibrc').open() as file:
         rclines = file.readlines()
     missing = {}
     for k, v in mpl.defaultParams.items():
         if k[0] == "_":
             continue
-        if k in deprecated:
+        if k in mpl._deprecated_rcs:
             continue
         found = False
         for line in rclines:
diff --git a/lib/matplotlib/texmanager.py b/lib/matplotlib/texmanager.py
@@ -169,14 +169,15 @@ def get_font_config(self):
         if self._rc_cache is None:
             self._rc_cache = dict.fromkeys(self._rc_cache_keys)
         changed = [par for par in self._rc_cache_keys
-                   if rcParams[par] != self._rc_cache[par]]
+                   if dict.__getitem__(rcParams, par) != self._rc_cache[par]]
         if changed:
             _log.debug('following keys changed: %s', changed)
             for k in changed:
                 _log.debug('%-20s: %-10s -> %-10s',
-                           k, self._rc_cache[k], rcParams[k])
+                           k, self._rc_cache[k], dict.__getitem__(rcParams, k))
                 # deepcopy may not be necessary, but feels more future-proof
-                self._rc_cache[k] = copy.deepcopy(rcParams[k])
+                self._rc_cache[k] = copy.deepcopy(
+                    dict.__getitem__(rcParams, k))
             _log.debug('RE-INIT\nold fontconfig: %s', self._fontconfig)
             self._reinit()
         _log.debug('fontconfig: %s', self._fontconfig)
@@ -209,7 +210,7 @@ def make_tex(self, tex, fontsize):
         unicode_preamble = "\n".join([
             r"\usepackage[utf8]{inputenc}",
             r"\DeclareUnicodeCharacter{2212}{\ensuremath{-}}",
-        ]) if rcParams["text.latex.unicode"] else ""
+        ]) if dict.__getitem__(rcParams, "text.latex.unicode") else ""
 
         s = r"""
 \documentclass{article}
@@ -224,7 +225,7 @@ def make_tex(self, tex, fontsize):
 """ % (self._font_preamble, unicode_preamble, custom_preamble,
        fontsize, fontsize * 1.25, tex)
         with open(texfile, 'wb') as fh:
-            if rcParams['text.latex.unicode']:
+            if dict.__getitem__(rcParams, 'text.latex.unicode'):
                 fh.write(s.encode('utf8'))
             else:
                 try:
@@ -259,7 +260,7 @@ def make_tex_preview(self, tex, fontsize):
         unicode_preamble = "\n".join([
             r"\usepackage[utf8]{inputenc}",
             r"\DeclareUnicodeCharacter{2212}{\ensuremath{-}}",
-        ]) if rcParams["text.latex.unicode"] else ""
+        ]) if dict.__getitem__(rcParams, "text.latex.unicode") else ""
 
         # newbox, setbox, immediate, etc. are used to find the box
         # extent of the rendered text.
@@ -285,7 +286,7 @@ def make_tex_preview(self, tex, fontsize):
 """ % (self._font_preamble, unicode_preamble, custom_preamble,
        fontsize, fontsize * 1.25, tex)
         with open(texfile, 'wb') as fh:
-            if rcParams['text.latex.unicode']:
+            if dict.__getitem__(rcParams, 'text.latex.unicode'):
                 fh.write(s.encode('utf8'))
             else:
                 try:
