Deprecate a validator for a deprecated rcParam value.

anntzer · anntzer · commit b4f9caf564cb · 2019-08-25T12:04:40.000+02:00
By doing so we'll be able to get rid of update_savefig_format at the
same time as we get rid of "auto" as a synonym for "png" in
:rc:savefig.format.
diff --git a/doc/api/next_api_changes/2019-07-30-AL.rst b/doc/api/next_api_changes/2019-07-30-AL.rst
@@ -5,3 +5,5 @@ Setting :rc:`savefig.format` to "auto" is deprecated; use its synonym "png" inst
 
 Setting :rc:`text.hinting` to True or False is deprecated; use their synonyms
 "auto" or "none" instead.
+
+``rcsetup.update_savefig_format`` is deprecated.
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -458,6 +458,7 @@ def validate_whiskers(s):
                                  "(float, float)]")
 
 
+@cbook.deprecated("3.2")
 def update_savefig_format(value):
     # The old savefig.extension could also have a value of "auto", but
     # the new savefig.format does not.  We need to fix this here.
@@ -471,6 +472,20 @@ def update_savefig_format(value):
     return value
 
 
+# Replace by validate_string once deprecation period passes.
+def _update_savefig_format(value):
+    # The old savefig.extension could also have a value of "auto", but
+    # the new savefig.format does not.  We need to fix this here.
+    value = validate_string(value)
+    if value == 'auto':
+        cbook.warn_deprecated(
+            "3.2", message="Support for setting the 'savefig.format' rcParam "
+            "to 'auto' is deprecated since %(since)s and will be removed "
+            "%(removal)s; set it to 'png' instead.")
+        value = 'png'
+    return value
+
+
 validate_ps_papersize = ValidateInStrings(
     'ps_papersize',
     ['auto', 'letter', 'legal', 'ledger',
@@ -1344,7 +1359,7 @@ def _validate_linestyle(ls):
     'savefig.orientation': ['portrait', validate_orientation],
     'savefig.jpeg_quality': [95, validate_int],
     # value checked by backend at runtime
-    'savefig.format':     ['png', update_savefig_format],
+    'savefig.format':     ['png', _update_savefig_format],
     # options are 'tight', or 'standard'. 'standard' validates to None.
     'savefig.bbox':       ['standard', validate_bbox],
     'savefig.pad_inches': [0.1, validate_float],
