Merge pull request matplotlib#19134 from timhoffm/api-move-functions

MNT: Switch internal API function calls from cbook to _api

Author: tacaswell

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

@@ -294,7 +294,7 @@ def __set_name__(self, owner, name):
             property(lambda self: getattr(self, f"_{name}")), name=name))
 
 
-def _rename_parameter(since, old, new, func=None):
+def rename_parameter(since, old, new, func=None):
     """
     Decorator indicating that parameter *old* of *func* is renamed to *new*.
 
@@ -309,12 +309,12 @@ def _rename_parameter(since, old, new, func=None):
     --------
     ::
 
-        @_rename_parameter("3.1", "bad_name", "good_name")
+        @_api.rename_parameter("3.1", "bad_name", "good_name")
         def func(good_name): ...
     """
 
     if func is None:
-        return functools.partial(_rename_parameter, since, old, new)
+        return functools.partial(rename_parameter, since, old, new)
 
     signature = inspect.signature(func)
     assert old not in signature.parameters, (
@@ -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
@@ -433,14 +433,14 @@ def wrapper(*inner_args, **inner_kwargs):
     return wrapper
 
 
-def _make_keyword_only(since, name, func=None):
+def make_keyword_only(since, name, func=None):
     """
     Decorator indicating that passing parameter *name* (or any of the following
     ones) positionally to *func* is being deprecated.
     """
 
     if func is None:
-        return functools.partial(_make_keyword_only, since, name)
+        return functools.partial(make_keyword_only, since, name)
 
     signature = inspect.signature(func)
     POK = inspect.Parameter.POSITIONAL_OR_KEYWORD
@@ -459,7 +459,7 @@ def _make_keyword_only(since, name, func=None):
     @functools.wraps(func)
     def wrapper(*args, **kwargs):
         # Don't use signature.bind here, as it would fail when stacked with
-        # _rename_parameter and an "old" argument name is passed in
+        # rename_parameter and an "old" argument name is passed in
         # (signature.bind would fail, but the actual call would succeed).
         idx = [*func.__signature__.parameters].index(name)
         if len(args) > idx:

lib/matplotlib/_mathtext.py

@@ -158,7 +158,7 @@ def set_canvas_size(self, w, h, d):
         self.mathtext_backend.set_canvas_size(
             self.width, self.height, self.depth)
 
-    @cbook._rename_parameter("3.4", "facename", "font")
+    @_api.rename_parameter("3.4", "facename", "font")
     def render_glyph(self, ox, oy, font, font_class, sym, fontsize, dpi):
         """
         At position (*ox*, *oy*), draw the glyph specified by the remaining
@@ -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/_axes.py

@@ -645,7 +645,7 @@ def text(self, x, y, s, fontdict=None, **kwargs):
         self._add_text(t)
         return t
 
-    @cbook._rename_parameter("3.3", "s", "text")
+    @_api.rename_parameter("3.3", "s", "text")
     @docstring.dedent_interpd
     def annotate(self, text, xy, *args, **kwargs):
         a = mtext.Annotation(text, xy, *args, **kwargs)

lib/matplotlib/axes/_base.py

@@ -465,7 +465,7 @@ def __str__(self):
         return "{0}({1[0]:g},{1[1]:g};{1[2]:g}x{1[3]:g})".format(
             type(self).__name__, self._position.bounds)
 
-    @cbook._make_keyword_only("3.4", "facecolor")
+    @_api.make_keyword_only("3.4", "facecolor")
     def __init__(self, fig, rect,
                  facecolor=None,  # defaults to rc axes.facecolor
                  frameon=True,
@@ -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,
@@ -1266,7 +1266,7 @@ def get_minorticklocs(self):
                 if ~np.isclose(tr_loc, tr_major_locs, atol=tol, rtol=0).any()]
         return minor_locs
 
-    @cbook._make_keyword_only("3.3", "minor")
+    @_api.make_keyword_only("3.3", "minor")
     def get_ticklocs(self, minor=False):
         """Return this Axis' tick locations in data coordinates."""
         return self.get_minorticklocs() if minor else self.get_majorticklocs()
@@ -1738,7 +1738,7 @@ def set_ticklabels(self, ticklabels, *, minor=False, **kwargs):
 
     # Wrapper around set_ticklabels used to generate Axes.set_x/ytickabels; can
     # go away once the API of Axes.set_x/yticklabels becomes consistent.
-    @cbook._make_keyword_only("3.3", "fontdict")
+    @_api.make_keyword_only("3.3", "fontdict")
     def _set_ticklabels(self, labels, fontdict=None, minor=False, **kwargs):
         """
         Set this Axis' labels with list of string labels.

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):
         """
         """