Move internal usage from cbook._delete_parameter to _api.delete_parameter

Author: timhoffm

lib/matplotlib/__init__.py

@@ -1194,7 +1194,7 @@ def _init_tests():
                 "" if ft2font.__freetype_build_type__ == 'local' else "not "))
 
 
-@cbook._delete_parameter("3.3", "recursionlimit")
+@_api.delete_parameter("3.3", "recursionlimit")
 def test(verbosity=None, coverage=False, *, recursionlimit=0, **kwargs):
     """Run the matplotlib test suite."""
 

lib/matplotlib/_api/__init__.py

@@ -17,7 +17,7 @@
 
 from .deprecation import (
     deprecated, warn_deprecated,
-    rename_parameter, _delete_parameter, make_keyword_only,
+    rename_parameter, delete_parameter, make_keyword_only,
     _deprecate_method_override, _deprecate_privatize_attribute,
     suppress_matplotlib_deprecation_warning,
     MatplotlibDeprecationWarning)

lib/matplotlib/_api/deprecation.py

@@ -350,7 +350,7 @@ def __repr__(self):
 _deprecated_parameter = _deprecated_parameter_class()
 
 
-def _delete_parameter(since, name, func=None, **kwargs):
+def delete_parameter(since, name, func=None, **kwargs):
     """
     Decorator indicating that parameter *name* of *func* is being deprecated.
 
@@ -371,12 +371,12 @@ def _delete_parameter(since, name, func=None, **kwargs):
     --------
     ::
 
-        @_delete_parameter("3.1", "unused")
+        @_api.delete_parameter("3.1", "unused")
         def func(used_arg, other_arg, unused, more_args): ...
     """
 
     if func is None:
-        return functools.partial(_delete_parameter, since, name, **kwargs)
+        return functools.partial(delete_parameter, since, name, **kwargs)
 
     signature = inspect.signature(func)
     # Name of `**kwargs` parameter of the decorated function, typically

lib/matplotlib/_mathtext.py

@@ -1551,7 +1551,7 @@ class Glue(Node):
 
     glue_subtype = cbook.deprecated("3.3")(property(lambda self: "normal"))
 
-    @cbook._delete_parameter("3.3", "copy")
+    @_api.delete_parameter("3.3", "copy")
     def __init__(self, glue_type, copy=False):
         super().__init__()
         if isinstance(glue_type, str):

lib/matplotlib/animation.py

@@ -407,7 +407,7 @@ def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self.frame_format = mpl.rcParams['animation.frame_format']
 
-    @cbook._delete_parameter("3.3", "clear_temp")
+    @_api.delete_parameter("3.3", "clear_temp")
     def setup(self, fig, outfile, dpi=None, frame_prefix=None,
               clear_temp=True):
         """

lib/matplotlib/artist.py

@@ -28,7 +28,7 @@ def allow_rasterization(draw):
 
     # Axes has a second (deprecated) argument inframe for its draw method.
     # args and kwargs are deprecated, but we don't wrap this in
-    # cbook._delete_parameter for performance; the relevant deprecation
+    # _api.delete_parameter for performance; the relevant deprecation
     # warning will be emitted by the inner draw() call.
     @wraps(draw)
     def draw_wrapper(artist, renderer, *args, **kwargs):
@@ -926,8 +926,8 @@ def set_agg_filter(self, filter_func):
         self._agg_filter = filter_func
         self.stale = True
 
-    @cbook._delete_parameter("3.3", "args")
-    @cbook._delete_parameter("3.3", "kwargs")
+    @_api.delete_parameter("3.3", "args")
+    @_api.delete_parameter("3.3", "kwargs")
     def draw(self, renderer, *args, **kwargs):
         """
         Draw the Artist (and its children) using the given renderer.

lib/matplotlib/axes/_base.py

@@ -2743,7 +2743,7 @@ def _update_title_position(self, renderer):
 
     # Drawing
     @martist.allow_rasterization
-    @cbook._delete_parameter(
+    @_api.delete_parameter(
         "3.3", "inframe", alternative="Axes.redraw_in_frame()")
     def draw(self, renderer=None, inframe=False):
         # docstring inherited

lib/matplotlib/axis.py

@@ -54,7 +54,7 @@ class Tick(martist.Artist):
         The right/top tick label.
 
     """
-    @cbook._delete_parameter("3.3", "label")
+    @_api.delete_parameter("3.3", "label")
     def __init__(self, axes, loc, label=None,
                  size=None,  # points
                  width=None,

lib/matplotlib/backend_bases.py

@@ -535,7 +535,7 @@ def option_scale_image(self):
         """
         return False
 
-    @cbook._delete_parameter("3.3", "ismath")
+    @_api.delete_parameter("3.3", "ismath")
     def draw_tex(self, gc, x, y, s, prop, angle, ismath='TeX!', mtext=None):
         """
         """

lib/matplotlib/backend_managers.py

@@ -1,7 +1,6 @@
 import logging
 
-import matplotlib.cbook as cbook
-import matplotlib.widgets as widgets
+from matplotlib import _api, cbook, widgets
 from matplotlib.rcsetup import validate_stringlist
 import matplotlib.backend_tools as tools
 
@@ -183,7 +182,7 @@ def _remove_keys(self, name):
         for k in self.get_tool_keymap(name):
             del self._keys[k]
 
-    @cbook._delete_parameter("3.3", "args")
+    @_api.delete_parameter("3.3", "args")
     def update_keymap(self, name, key, *args):
         """
         Set the keymap to associate with the specified tool.