Move internal usage from cbook._delete_parameter to _api.delete_param…

…eter
tacaswell · Dec 17, 2020 · Dec 17, 2020 · Dec 17, 2020 · Dec 17, 2020 · Dec 17, 2020
commit 410c51d6cb6887215558956eb0dcf5e7c96ec401
diff --git a/lib/matplotlib/__init__.py b/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."""
 

diff --git a/lib/matplotlib/_api/__init__.py b/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)

diff --git a/lib/matplotlib/_api/deprecation.py b/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

diff --git a/lib/matplotlib/_mathtext.py b/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):

diff --git a/lib/matplotlib/animation.py b/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):
         """

diff --git a/lib/matplotlib/artist.py b/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.

diff --git a/lib/matplotlib/axes/_base.py b/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

diff --git a/lib/matplotlib/axis.py b/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,

diff --git a/lib/matplotlib/backend_bases.py b/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):
         """
         """

diff --git a/lib/matplotlib/backend_managers.py b/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.

diff --git a/lib/matplotlib/backends/_backend_tk.py b/lib/matplotlib/backends/_backend_tk.py
@@ -159,7 +159,7 @@ def _on_timer(self):
 class FigureCanvasTk(FigureCanvasBase):
     required_interactive_framework = "tk"
 
-    @cbook._delete_parameter(
+    @_api.delete_parameter(
         "3.4", "resize_callback",
         alternative="get_tk_widget().bind('<Configure>', ..., True)")
     def __init__(self, figure, master=None, resize_callback=None):

diff --git a/lib/matplotlib/backends/backend_agg.py b/lib/matplotlib/backends/backend_agg.py
@@ -522,12 +522,12 @@ def print_to_buffer(self):
 
     @_check_savefig_extra_args(
         extra_kwargs=["quality", "optimize", "progressive"])
-    @cbook._delete_parameter("3.3", "quality",
-                             alternative="pil_kwargs={'quality': ...}")
-    @cbook._delete_parameter("3.3", "optimize",
-                             alternative="pil_kwargs={'optimize': ...}")
-    @cbook._delete_parameter("3.3", "progressive",
-                             alternative="pil_kwargs={'progressive': ...}")
+    @_api.delete_parameter("3.3", "quality",
+                           alternative="pil_kwargs={'quality': ...}")
+    @_api.delete_parameter("3.3", "optimize",
+                           alternative="pil_kwargs={'optimize': ...}")
+    @_api.delete_parameter("3.3", "progressive",
+                           alternative="pil_kwargs={'progressive': ...}")
     def print_jpg(self, filename_or_obj, *args, pil_kwargs=None, **kwargs):
         """
         Write the figure to a JPEG file.

diff --git a/lib/matplotlib/backends/backend_pdf.py b/lib/matplotlib/backends/backend_pdf.py
@@ -2155,7 +2155,7 @@ def draw_mathtext(self, gc, x, y, s, prop, angle):
         # Pop off the global transformation
         self.file.output(Op.grestore)
 
-    @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):
         # docstring inherited
         texmanager = self.get_texmanager()

diff --git a/lib/matplotlib/backends/backend_pgf.py b/lib/matplotlib/backends/backend_pgf.py
@@ -380,7 +380,7 @@ def _get_image_inclusion_command():
 
 class RendererPgf(RendererBase):
 
-    @cbook._delete_parameter("3.3", "dummy")
+    @_api.delete_parameter("3.3", "dummy")
     def __init__(self, figure, fh, dummy=False):
         """
         Create a new PGF renderer that translates any drawing instruction

diff --git a/lib/matplotlib/backends/backend_ps.py b/lib/matplotlib/backends/backend_ps.py
@@ -554,7 +554,7 @@ def draw_path_collection(self, gc, master_transform, paths, all_transforms,
 
         self._path_collection_id += 1
 
-    @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):
         # docstring inherited
         if not hasattr(self, "psfrag"):

diff --git a/lib/matplotlib/backends/backend_svg.py b/lib/matplotlib/backends/backend_svg.py
@@ -1238,7 +1238,7 @@ def _draw_text_as_text(self, gc, x, y, s, prop, angle, ismath, mtext=None):
 
             writer.end('g')
 
-    @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):
         # docstring inherited
         self._draw_text_as_path(gc, x, y, s, prop, angle, ismath="TeX")

diff --git a/lib/matplotlib/backends/backend_wx.py b/lib/matplotlib/backends/backend_wx.py
@@ -599,7 +599,7 @@ def _get_imagesave_wildcards(self):
         wildcards = '|'.join(wildcards)
         return wildcards, extensions, filter_index
 
-    @cbook._delete_parameter("3.4", "origin")
+    @_api.delete_parameter("3.4", "origin")
     def gui_repaint(self, drawDC=None, origin='WX'):
         """
         Performs update of the displayed image on the GUI canvas, using the

diff --git a/lib/matplotlib/cbook/__init__.py b/lib/matplotlib/cbook/__init__.py
@@ -28,12 +28,11 @@
 import numpy as np
 
 import matplotlib
-from matplotlib import _c_internal_utils
+from matplotlib import _api, _c_internal_utils
 from matplotlib._api import (
     warn_external as _warn_external, classproperty as _classproperty)
 from matplotlib._api.deprecation import (
     deprecated, warn_deprecated,
-    _delete_parameter,
     _deprecate_method_override, _deprecate_privatize_attribute,
     MatplotlibDeprecationWarning, mplDeprecation)
 
@@ -1704,9 +1703,9 @@ def sanitize_sequence(data):
             else data)
 
 
-@_delete_parameter("3.3", "required")
-@_delete_parameter("3.3", "forbidden")
-@_delete_parameter("3.3", "allowed")
+@_api.delete_parameter("3.3", "required")
+@_api.delete_parameter("3.3", "forbidden")
+@_api.delete_parameter("3.3", "allowed")
 def normalize_kwargs(kw, alias_mapping=None, required=(), forbidden=(),
                      allowed=None):
     """

diff --git a/lib/matplotlib/collections.py b/lib/matplotlib/collections.py
@@ -70,7 +70,7 @@ class Collection(artist.Artist, cm.ScalarMappable):
     # subclass-by-subclass basis.
     _edge_default = False
 
-    @cbook._delete_parameter("3.3", "offset_position")
+    @_api.delete_parameter("3.3", "offset_position")
     def __init__(self,
                  edgecolors=None,
                  facecolors=None,

diff --git a/lib/matplotlib/gridspec.py b/lib/matplotlib/gridspec.py
@@ -723,7 +723,7 @@ def is_first_col(self):
     def is_last_col(self):
         return self.colspan.stop == self.get_gridspec().ncols
 
-    @cbook._delete_parameter("3.4", "return_all")
+    @_api.delete_parameter("3.4", "return_all")
     def get_position(self, figure, return_all=False):
         """
         Update the subplot position from ``figure.subplotpars``.

diff --git a/lib/matplotlib/offsetbox.py b/lib/matplotlib/offsetbox.py
@@ -706,7 +706,7 @@ class TextArea(OffsetBox):
     child text.
     """
 
-    @cbook._delete_parameter("3.4", "minimumdescent")
+    @_api.delete_parameter("3.4", "minimumdescent")
     def __init__(self, s,
                  textprops=None,
                  multilinebaseline=False,
@@ -1480,7 +1480,7 @@ def set_fontsize(self, s=None):
         self.prop = FontProperties(size=s)
         self.stale = True
 
-    @cbook._delete_parameter("3.3", "s")
+    @_api.delete_parameter("3.3", "s")
     def get_fontsize(self, s=None):
         """Return the fontsize in points."""
         return self.prop.get_size_in_points()

diff --git a/lib/matplotlib/patches.py b/lib/matplotlib/patches.py
@@ -638,7 +638,7 @@ class Shadow(Patch):
     def __str__(self):
         return "Shadow(%s)" % (str(self.patch))
 
-    @cbook._delete_parameter("3.3", "props")
+    @_api.delete_parameter("3.3", "props")
     @docstring.dedent_interpd
     def __init__(self, patch, ox, oy, props=None, **kwargs):
         """
@@ -2014,7 +2014,7 @@ def __init_subclass__(cls):
 
             __call__ = cls.__call__
 
-            @cbook._delete_parameter("3.4", "mutation_aspect")
+            @_api.delete_parameter("3.4", "mutation_aspect")
             def call_wrapper(
                     self, x0, y0, width, height, mutation_size,
                     mutation_aspect=_api.deprecation._deprecated_parameter):
@@ -3602,7 +3602,7 @@ def __str__(self):
         return s % (self._x, self._y, self._width, self._height)
 
     @docstring.dedent_interpd
-    @cbook._delete_parameter("3.4", "bbox_transmuter", alternative="boxstyle")
+    @_api.delete_parameter("3.4", "bbox_transmuter", alternative="boxstyle")
     def __init__(self, xy, width, height,
                  boxstyle="round", bbox_transmuter=None,
                  mutation_scale=1, mutation_aspect=1,
@@ -3893,7 +3893,7 @@ def __str__(self):
             return f"{type(self).__name__}({self._path_original})"
 
     @docstring.dedent_interpd
-    @cbook._delete_parameter("3.4", "dpi_cor")
+    @_api.delete_parameter("3.4", "dpi_cor")
     def __init__(self, posA=None, posB=None, path=None,
                  arrowstyle="simple", connectionstyle="arc3",
                  patchA=None, patchB=None,
@@ -4240,7 +4240,7 @@ def __str__(self):
                (self.xy1[0], self.xy1[1], self.xy2[0], self.xy2[1])
 
     @docstring.dedent_interpd
-    @cbook._delete_parameter("3.4", "dpi_cor")
+    @_api.delete_parameter("3.4", "dpi_cor")
     def __init__(self, xyA, xyB, coordsA, coordsB=None,
                  axesA=None, axesB=None,
                  arrowstyle="-",

diff --git a/lib/matplotlib/path.py b/lib/matplotlib/path.py
@@ -15,7 +15,7 @@
 import numpy as np
 
 import matplotlib as mpl
-from . import _api, _path, cbook
+from . import _api, _path
 from .cbook import _to_unmasked_float_array, simple_linear_interpolation
 from .bezier import BezierSegment
 
@@ -461,7 +461,7 @@ def iter_bezier(self, **kwargs):
                 raise ValueError("Invalid Path.code_type: " + str(code))
             prev_vert = verts[-2:]
 
-    @cbook._delete_parameter("3.3", "quantize")
+    @_api.delete_parameter("3.3", "quantize")
     def cleaned(self, transform=None, remove_nans=False, clip=None,
                 quantize=False, simplify=False, curves=False,
                 stroke_width=1.0, snap=False, sketch=None):

diff --git a/lib/matplotlib/projections/polar.py b/lib/matplotlib/projections/polar.py
@@ -945,8 +945,8 @@ def get_yaxis_text2_transform(self, pad):
             pad_shift = _ThetaShift(self, pad, 'min')
         return self._yaxis_text_transform + pad_shift, 'center', halign
 
-    @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):
         self._unstale_viewLim()
         thetamin, thetamax = np.rad2deg(self._realViewLim.intervalx)

diff --git a/lib/matplotlib/scale.py b/lib/matplotlib/scale.py
@@ -14,7 +14,7 @@
 from numpy import ma
 
 import matplotlib as mpl
-from matplotlib import _api, cbook, docstring
+from matplotlib import _api, docstring
 from matplotlib.ticker import (
     NullFormatter, ScalarFormatter, LogFormatterSciNotation, LogitFormatter,
     NullLocator, LogLocator, AutoLocator, AutoMinorLocator,

diff --git a/lib/matplotlib/tests/test_api.py b/lib/matplotlib/tests/test_api.py
@@ -34,6 +34,28 @@ def f(cls):
         a.f
 
 
+def test_delete_parameter():
+    @_api.delete_parameter("3.0", "foo")
+    def func1(foo=None):
+        pass
+
+    @_api.delete_parameter("3.0", "foo")
+    def func2(**kwargs):
+        pass
+
+    for func in [func1, func2]:
+        func()  # No warning.
+        with pytest.warns(_api.MatplotlibDeprecationWarning):
+            func(foo="bar")
+
+    def pyplot_wrapper(foo=_api.deprecation._deprecated_parameter):
+        func1(foo)
+
+    pyplot_wrapper()  # No warning.
+    with pytest.warns(_api.MatplotlibDeprecationWarning):
+        func(foo="bar")
+
+
 def test_make_keyword_only():
     @_api.make_keyword_only("3.0", "arg")
     def func(pre, arg, post=None):