Merge pull request matplotlib#26330 from anntzer/agaa

QuLogic · web-flow · commit c6db591f7817 · 2023-07-18T16:27:38.000-04:00
Deprecate wrappers combining axes_grid1 and axisartist.
diff --git a/doc/api/next_api_changes/deprecations/26329-AL.rst b/doc/api/next_api_changes/deprecations/26329-AL.rst
@@ -0,0 +1,5 @@
+``axisartist.axes_grid`` and ``axisartist.axes_rgb``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+These modules, which provide wrappers combining the functionality of
+`.axes_grid1` and `.axisartist`, are deprecated; directly use e.g.
+``AxesGrid(..., axes_class=axislines.Axes)`` instead.
diff --git a/lib/mpl_toolkits/axisartist/axes_grid.py b/lib/mpl_toolkits/axisartist/axes_grid.py
@@ -1,11 +1,21 @@
+from matplotlib import _api
+
 import mpl_toolkits.axes_grid1.axes_grid as axes_grid_orig
 from .axislines import Axes
 
 
+_api.warn_deprecated(
+    "3.8", name=__name__, obj_type="module", alternative="axes_grid1.axes_grid")
+
+
+@_api.deprecated("3.8", alternative=(
+    "axes_grid1.axes_grid.Grid(..., axes_class=axislines.Axes"))
 class Grid(axes_grid_orig.Grid):
     _defaultAxesClass = Axes
 
 
+@_api.deprecated("3.8", alternative=(
+    "axes_grid1.axes_grid.ImageGrid(..., axes_class=axislines.Axes"))
 class ImageGrid(axes_grid_orig.ImageGrid):
     _defaultAxesClass = Axes
 
diff --git a/lib/mpl_toolkits/axisartist/axes_rgb.py b/lib/mpl_toolkits/axisartist/axes_rgb.py
@@ -1,8 +1,15 @@
+from matplotlib import _api
 from mpl_toolkits.axes_grid1.axes_rgb import (  # noqa
     make_rgb_axes, RGBAxes as _RGBAxes)
 from .axislines import Axes
 
 
+_api.warn_deprecated(
+    "3.8", name=__name__, obj_type="module", alternative="axes_grid1.axes_rgb")
+
+
+@_api.deprecated("3.8", alternative=(
+    "axes_grid1.axes_rgb.RGBAxes(..., axes_class=axislines.Axes"))
 class RGBAxes(_RGBAxes):
     """
     Subclass of `~.axes_grid1.axes_rgb.RGBAxes` with
