Merge pull request matplotlib#19145 from timhoffm/change-deprecate-calls

Move from cbook._deprecate_*() to _api.deprecate_*()

Author: jklymak

lib/matplotlib/_api/__init__.py

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

lib/matplotlib/_api/deprecation.py

@@ -271,7 +271,7 @@ def wrapper(*args, **kwargs):
     return deprecate
 
 
-class _deprecate_privatize_attribute:
+class deprecate_privatize_attribute:
     """
     Helper to deprecate public access to an attribute.
 
@@ -473,7 +473,7 @@ def wrapper(*args, **kwargs):
     return wrapper
 
 
-def _deprecate_method_override(method, obj, *, allow_empty=False, **kwargs):
+def deprecate_method_override(method, obj, *, allow_empty=False, **kwargs):
     """
     Return ``obj.method`` with a deprecation if it was overridden, else None.
 

lib/matplotlib/_mathtext.py

@@ -203,7 +203,7 @@ def get_results(self, box):
         result = self.mathtext_backend.get_results(
             box, self.get_used_characters())
         if self.destroy != TruetypeFonts.destroy.__get__(self):
-            destroy = cbook._deprecate_method_override(
+            destroy = _api.deprecate_method_override(
                 __class__.destroy, self, since="3.4")
             if destroy:
                 destroy()

lib/matplotlib/animation.py

@@ -261,8 +261,8 @@ class MovieWriter(AbstractMovieWriter):
     # stored.  Third-party writers cannot meaningfully set these as they cannot
     # extend rcParams with new keys.
 
-    exec_key = cbook._deprecate_privatize_attribute("3.3")
-    args_key = cbook._deprecate_privatize_attribute("3.3")
+    exec_key = _api.deprecate_privatize_attribute("3.3")
+    args_key = _api.deprecate_privatize_attribute("3.3")
 
     # Pipe-based writers only support RGBA, but file-based ones support more
     # formats.
@@ -339,7 +339,7 @@ def _run(self):
 
     def finish(self):
         """Finish any processing for writing the movie."""
-        overridden_cleanup = cbook._deprecate_method_override(
+        overridden_cleanup = _api.deprecate_method_override(
             __class__.cleanup, self, since="3.4", alternative="finish()")
         if overridden_cleanup is not None:
             overridden_cleanup()

lib/matplotlib/axis.py

@@ -179,7 +179,7 @@ def __init__(self, axes, loc, label=None,
                            ("_get_gridline", "gridline"),
                            ("_get_text1", "label1"),
                            ("_get_text2", "label2")]:
-            overridden_method = cbook._deprecate_method_override(
+            overridden_method = _api.deprecate_method_override(
                 getattr(__class__, meth), self, since="3.3", message="Relying "
                 f"on {meth} to initialize Tick.{attr} is deprecated since "
                 f"%(since)s and will not work %(removal)s; please directly "

lib/matplotlib/backend_bases.py

@@ -2876,7 +2876,7 @@ def __init__(self, canvas):
         # This cursor will be set after the initial draw.
         self._lastCursor = cursors.POINTER
 
-        init = cbook._deprecate_method_override(
+        init = _api.deprecate_method_override(
             __class__._init_toolbar, self, allow_empty=True, since="3.3",
             addendum="Please fully initialize the toolbar in your subclass' "
             "__init__; a fully empty _init_toolbar implementation may be kept "
@@ -3093,7 +3093,7 @@ def press_pan(self, event):
         id_drag = self.canvas.mpl_connect("motion_notify_event", self.drag_pan)
         self._pan_info = self._PanInfo(
             button=event.button, axes=axes, cid=id_drag)
-        press = cbook._deprecate_method_override(
+        press = _api.deprecate_method_override(
             __class__.press, self, since="3.3", message="Calling an "
             "overridden press() at pan start is deprecated since %(since)s "
             "and will be removed %(removal)s; override press_pan() instead.")
@@ -3117,7 +3117,7 @@ def release_pan(self, event):
             'motion_notify_event', self.mouse_move)
         for ax in self._pan_info.axes:
             ax.end_pan()
-        release = cbook._deprecate_method_override(
+        release = _api.deprecate_method_override(
             __class__.press, self, since="3.3", message="Calling an "
             "overridden release() at pan stop is deprecated since %(since)s "
             "and will be removed %(removal)s; override release_pan() instead.")
@@ -3157,7 +3157,7 @@ def press_zoom(self, event):
         self._zoom_info = self._ZoomInfo(
             direction="in" if event.button == 1 else "out",
             start_xy=(event.x, event.y), axes=axes, cid=id_zoom)
-        press = cbook._deprecate_method_override(
+        press = _api.deprecate_method_override(
             __class__.press, self, since="3.3", message="Calling an "
             "overridden press() at zoom start is deprecated since %(since)s "
             "and will be removed %(removal)s; override press_zoom() instead.")
@@ -3193,7 +3193,7 @@ def release_zoom(self, event):
                 or (abs(event.y - start_y) < 5 and event.key != "x")):
             self._draw()
             self._zoom_info = None
-            release = cbook._deprecate_method_override(
+            release = _api.deprecate_method_override(
                 __class__.press, self, since="3.3", message="Calling an "
                 "overridden release() at zoom stop is deprecated since "
                 "%(since)s and will be removed %(removal)s; override "
@@ -3217,7 +3217,7 @@ def release_zoom(self, event):
         self._zoom_info = None
         self.push_current()
 
-        release = cbook._deprecate_method_override(
+        release = _api.deprecate_method_override(
             __class__.release, self, since="3.3", message="Calling an "
             "overridden release() at zoom stop is deprecated since %(since)s "
             "and will be removed %(removal)s; override release_zoom() "

lib/matplotlib/backends/backend_gtk3.py

@@ -127,7 +127,7 @@ def __init__(self, figure):
         self.set_double_buffered(True)
         self.set_can_focus(True)
 
-        renderer_init = cbook._deprecate_method_override(
+        renderer_init = _api.deprecate_method_override(
             __class__._renderer_init, self, allow_empty=True, since="3.3",
             addendum="Please initialize the renderer, if needed, in the "
             "subclass' __init__; a fully empty _renderer_init implementation "

lib/matplotlib/backends/backend_wx.py

@@ -1129,13 +1129,13 @@ def __init__(self, canvas, coordinates=True):
         # and/or dc.GetContentScaleFactor()
         self._retinaFix = 'wxMac' in wx.PlatformInfo
 
-    prevZoomRect = cbook._deprecate_privatize_attribute("3.3")
-    retinaFix = cbook._deprecate_privatize_attribute("3.3")
-    savedRetinaImage = cbook._deprecate_privatize_attribute("3.3")
-    wxoverlay = cbook._deprecate_privatize_attribute("3.3")
-    zoomAxes = cbook._deprecate_privatize_attribute("3.3")
-    zoomStartX = cbook._deprecate_privatize_attribute("3.3")
-    zoomStartY = cbook._deprecate_privatize_attribute("3.3")
+    prevZoomRect = _api.deprecate_privatize_attribute("3.3")
+    retinaFix = _api.deprecate_privatize_attribute("3.3")
+    savedRetinaImage = _api.deprecate_privatize_attribute("3.3")
+    wxoverlay = _api.deprecate_privatize_attribute("3.3")
+    zoomAxes = _api.deprecate_privatize_attribute("3.3")
+    zoomStartX = _api.deprecate_privatize_attribute("3.3")
+    zoomStartY = _api.deprecate_privatize_attribute("3.3")
 
     @staticmethod
     def _icon(name):

lib/matplotlib/cbook/__init__.py

@@ -32,9 +32,7 @@
 from matplotlib._api import (
     warn_external as _warn_external, classproperty as _classproperty)
 from matplotlib._api.deprecation import (
-    deprecated, warn_deprecated,
-    _deprecate_method_override, _deprecate_privatize_attribute,
-    MatplotlibDeprecationWarning, mplDeprecation)
+    deprecated, warn_deprecated, MatplotlibDeprecationWarning, mplDeprecation)
 
 
 def _get_running_interactive_framework():

lib/matplotlib/cm.py

@@ -500,7 +500,7 @@ def changed(self):
             self._update_dict[key] = True
         self.stale = True
 
-    update_dict = cbook._deprecate_privatize_attribute("3.3")
+    update_dict = _api.deprecate_privatize_attribute("3.3")
 
     @_api.deprecated("3.3")
     def add_checker(self, checker):