Merge pull request matplotlib#19151 from timhoffm/change-deprecated-usage

Deprecate @cbook.deprecated and move internal calls to @_api.deprecated

Author: dopplershift

lib/matplotlib/_mathtext.py

@@ -795,7 +795,7 @@ def __init__(self, default_font_prop, mathtext_backend=None):
         self.fonts['default'] = default_font
         self.fonts['regular'] = default_font
 
-    pswriter = cbook.deprecated("3.4")(property(lambda self: StringIO()))
+    pswriter = _api.deprecated("3.4")(property(lambda self: StringIO()))
 
     def _get_font(self, font):
         if font in self.fontmap:
@@ -1549,7 +1549,7 @@ class Glue(Node):
     it's easier to stick to what TeX does.)
     """
 
-    glue_subtype = cbook.deprecated("3.3")(property(lambda self: "normal"))
+    glue_subtype = _api.deprecated("3.3")(property(lambda self: "normal"))
 
     @_api.delete_parameter("3.3", "copy")
     def __init__(self, glue_type, copy=False):

lib/matplotlib/animation.py

@@ -795,7 +795,7 @@ class HTMLWriter(FileMovieWriter):
     """Writer for JavaScript-based HTML movies."""
 
     supported_formats = ['png', 'jpeg', 'tiff', 'svg']
-    args_key = cbook.deprecated("3.3")(property(
+    args_key = _api.deprecated("3.3")(property(
         lambda self: 'animation.html_args'))
 
     @classmethod

lib/matplotlib/backend_bases.py

@@ -2710,7 +2710,7 @@ class FigureManagerBase:
                 figure.canvas.manager.button_press_handler_id)
     """
 
-    statusbar = cbook.deprecated("3.3")(property(lambda self: None))
+    statusbar = _api.deprecated("3.3")(property(lambda self: None))
 
     def __init__(self, canvas, num):
         self.canvas = canvas

lib/matplotlib/backends/_backend_pdf_ps.py

@@ -5,6 +5,7 @@
 import functools
 
 import matplotlib as mpl
+from matplotlib import _api
 from .. import font_manager, ft2font
 from ..afm import AFM
 from ..backend_bases import RendererBase
@@ -27,7 +28,7 @@ class CharacterTracker:
     def __init__(self):
         self.used = {}
 
-    @mpl.cbook.deprecated("3.3")
+    @_api.deprecated("3.3")
     @property
     def used_characters(self):
         d = {}

lib/matplotlib/backends/backend_cairo.py

@@ -121,9 +121,9 @@ def attr(field):
 
 
 class RendererCairo(RendererBase):
-    fontweights = cbook.deprecated("3.3")(property(lambda self: {*_f_weights}))
-    fontangles = cbook.deprecated("3.3")(property(lambda self: {*_f_angles}))
-    mathtext_parser = cbook.deprecated("3.4")(
+    fontweights = _api.deprecated("3.3")(property(lambda self: {*_f_weights}))
+    fontangles = _api.deprecated("3.3")(property(lambda self: {*_f_angles}))
+    mathtext_parser = _api.deprecated("3.4")(
         property(lambda self: MathTextParser('Cairo')))
 
     def __init__(self, dpi):

lib/matplotlib/backends/backend_gtk3.py

@@ -432,7 +432,7 @@ def resize(self, width, height):
 
 
 class NavigationToolbar2GTK3(NavigationToolbar2, Gtk.Toolbar):
-    ctx = cbook.deprecated("3.3")(property(
+    ctx = _api.deprecated("3.3")(property(
         lambda self: self.canvas.get_property("window").cairo_create()))
 
     def __init__(self, canvas, window):

lib/matplotlib/backends/backend_pgf.py

@@ -932,7 +932,7 @@ class PdfPages:
         '_info_dict',
         '_metadata',
     )
-    metadata = cbook.deprecated('3.3')(property(lambda self: self._metadata))
+    metadata = _api.deprecated('3.3')(property(lambda self: self._metadata))
 
     def __init__(self, filename, *, keep_empty=True, metadata=None):
         """

lib/matplotlib/backends/backend_ps.py

@@ -223,9 +223,9 @@ class RendererPS(_backend_pdf_ps.RendererPDFPSBase):
     _afm_font_dir = cbook._get_data_path("fonts/afm")
     _use_afm_rc_name = "ps.useafm"
 
-    mathtext_parser = cbook.deprecated("3.4")(property(
+    mathtext_parser = _api.deprecated("3.4")(property(
         lambda self: MathTextParser("PS")))
-    used_characters = cbook.deprecated("3.3")(property(
+    used_characters = _api.deprecated("3.3")(property(
         lambda self: self._character_tracker.used_characters))
 
     def __init__(self, width, height, pswriter, imagedpi=72):

lib/matplotlib/backends/qt_compat.py

@@ -18,6 +18,7 @@
 import sys
 
 import matplotlib as mpl
+from matplotlib import _api
 
 
 QT_API_PYQT5 = "PyQt5"
@@ -87,7 +88,7 @@ def _isdeleted(obj): return not shiboken2.isValid(obj)
         raise ValueError("Unexpected value for the 'backend.qt5' rcparam")
     _getSaveFileName = QtWidgets.QFileDialog.getSaveFileName
 
-    @mpl.cbook.deprecated("3.3", alternative="QtCore.qVersion()")
+    @_api.deprecated("3.3", alternative="QtCore.qVersion()")
     def is_pyqt5():
         return True
 
@@ -143,7 +144,7 @@ def _isdeleted(obj): return not shiboken.isValid(obj)
         raise ValueError("Unexpected value for the 'backend.qt4' rcparam")
     QtWidgets = QtGui
 
-    @mpl.cbook.deprecated("3.3", alternative="QtCore.qVersion()")
+    @_api.deprecated("3.3", alternative="QtCore.qVersion()")
     def is_pyqt5():
         return False
 

lib/matplotlib/cbook/__init__.py

@@ -30,7 +30,12 @@
 import matplotlib
 from matplotlib import _api, _c_internal_utils
 from matplotlib._api.deprecation import (
-    deprecated, warn_deprecated, MatplotlibDeprecationWarning, mplDeprecation)
+    warn_deprecated, MatplotlibDeprecationWarning, mplDeprecation)
+
+
+@_api.deprecated("3.4")
+def deprecated(*args, **kwargs):
+    return _api.deprecated(*args, **kwargs)
 
 
 def _get_running_interactive_framework():
@@ -287,7 +292,7 @@ def __repr__(self):
             return "<an empty list>"
 
 
-@deprecated("3.3")
+@_api.deprecated("3.3")
 class IgnoredKeywordWarning(UserWarning):
     """
     A class for issuing warnings about keyword arguments that will be ignored
@@ -296,7 +301,7 @@ class IgnoredKeywordWarning(UserWarning):
     pass
 
 
-@deprecated("3.3", alternative="normalize_kwargs")
+@_api.deprecated("3.3", alternative="normalize_kwargs")
 def local_over_kwdict(local_var, kwargs, *keys):
     """
     Enforces the priority of a local variable over potentially conflicting
@@ -532,7 +537,7 @@ def flatten(seq, scalarp=is_scalar_or_string):
             yield from flatten(item, scalarp)
 
 
-@deprecated("3.3", alternative="os.path.realpath and os.stat")
+@_api.deprecated("3.3", alternative="os.path.realpath and os.stat")
 @functools.lru_cache()
 def get_realpath_and_stat(path):
     realpath = os.path.realpath(path)