Move internal usage from cbook._make_keyword_only to _api.make_keyword_only

Author: timhoffm

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

@@ -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

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,

lib/matplotlib/axis.py

@@ -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/cbook/__init__.py

@@ -33,7 +33,7 @@
     warn_external as _warn_external, classproperty as _classproperty)
 from matplotlib._api.deprecation import (
     deprecated, warn_deprecated,
-    _delete_parameter, _make_keyword_only,
+    _delete_parameter,
     _deprecate_method_override, _deprecate_privatize_attribute,
     MatplotlibDeprecationWarning, mplDeprecation)
 

lib/matplotlib/colorbar.py

@@ -411,7 +411,7 @@ class ColorbarBase:
 
     n_rasterize = 50  # rasterize solids if number of colors >= n_rasterize
 
-    @cbook._make_keyword_only("3.3", "cmap")
+    @_api.make_keyword_only("3.3", "cmap")
     def __init__(self, ax, cmap=None,
                  norm=None,
                  alpha=None,

lib/matplotlib/figure.py

@@ -29,6 +29,7 @@
     Artist, allow_rasterization, _finalize_rasterization)
 from matplotlib.backend_bases import (
     FigureCanvasBase, NonGuiException, MouseButton)
+import matplotlib._api as _api
 import matplotlib.cbook as cbook
 import matplotlib.colorbar as cbar
 import matplotlib.image as mimage
@@ -887,7 +888,7 @@ def _add_axes_internal(self, key, ax):
         ax.stale_callback = _stale_figure_callback
         return ax
 
-    @cbook._make_keyword_only("3.3", "sharex")
+    @_api.make_keyword_only("3.3", "sharex")
     def subplots(self, nrows=1, ncols=1, sharex=False, sharey=False,
                  squeeze=True, subplot_kw=None, gridspec_kw=None):
         """

lib/matplotlib/pyplot.py

@@ -75,8 +75,8 @@
 _code_objs = {
     _api.rename_parameter:
         _api.rename_parameter("", "old", "new", lambda new: None).__code__,
-    cbook._make_keyword_only:
-        cbook._make_keyword_only("", "p", lambda p: None).__code__,
+    _api.make_keyword_only:
+        _api.make_keyword_only("", "p", lambda p: None).__code__,
 }
 
 
@@ -85,7 +85,7 @@ def _copy_docstring_and_deprecators(method, func=None):
         return functools.partial(_copy_docstring_and_deprecators, method)
     decorators = [docstring.copy(method)]
     # Check whether the definition of *method* includes @_api.rename_parameter
-    # or @_api._make_keyword_only decorators; if so, propagate them to the
+    # or @_api.make_keyword_only decorators; if so, propagate them to the
     # pyplot wrapper as well.
     while getattr(method, "__wrapped__", None) is not None:
         for decorator_maker, code in _code_objs.items():
@@ -1236,7 +1236,7 @@ def subplot(*args, **kwargs):
     return ax
 
 
-@cbook._make_keyword_only("3.3", "sharex")
+@_api.make_keyword_only("3.3", "sharex")
 def subplots(nrows=1, ncols=1, sharex=False, sharey=False, squeeze=True,
              subplot_kw=None, gridspec_kw=None, **fig_kw):
     """
@@ -1574,7 +1574,7 @@ def subplot_tool(targetfig=None):
 
 
 # After deprecation elapses, this can be autogenerated by boilerplate.py.
-@cbook._make_keyword_only("3.3", "pad")
+@_api.make_keyword_only("3.3", "pad")
 def tight_layout(pad=1.08, h_pad=None, w_pad=None, rect=None):
     """
     Adjust the padding between and around subplots.

lib/matplotlib/tests/test_api.py

@@ -32,3 +32,16 @@ def f(cls):
     with pytest.warns(_api.MatplotlibDeprecationWarning):
         a = A()
         a.f
+
+
+def test_make_keyword_only():
+    @_api.make_keyword_only("3.0", "arg")
+    def func(pre, arg, post=None):
+        pass
+
+    func(1, arg=2)  # Check that no warning is emitted.
+
+    with pytest.warns(_api.MatplotlibDeprecationWarning):
+        func(1, 2)
+    with pytest.warns(_api.MatplotlibDeprecationWarning):
+        func(1, 2, 3)

lib/matplotlib/tests/test_cbook.py

@@ -628,19 +628,6 @@ def pyplot_wrapper(foo=_api.deprecation._deprecated_parameter):
         func(foo="bar")
 
 
-def test_make_keyword_only():
-    @cbook._make_keyword_only("3.0", "arg")
-    def func(pre, arg, post=None):
-        pass
-
-    func(1, arg=2)  # Check that no warning is emitted.
-
-    with pytest.warns(MatplotlibDeprecationWarning):
-        func(1, 2)
-    with pytest.warns(MatplotlibDeprecationWarning):
-        func(1, 2, 3)
-
-
 def test_warn_external(recwarn):
     cbook._warn_external("oops")
     assert len(recwarn) == 1