Remove 3.8 deprecations in toolkits

Author: QuLogic

doc/api/next_api_changes/removals/28874-ES.rst

@@ -0,0 +1,33 @@
+``axes_grid1`` API changes
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+``anchored_artists.AnchoredEllipse`` has been removed. Instead, directly construct an
+`.AnchoredOffsetbox`, an `.AuxTransformBox`, and an `~.patches.Ellipse`, as demonstrated
+in :doc:`/gallery/misc/anchored_artists`.
+
+The ``axes_divider.AxesLocator`` class has been removed.  The ``new_locator`` method of
+divider instances now instead returns an opaque callable (which can still be passed to
+``ax.set_axes_locator``).
+
+``axes_divider.Divider.locate`` has been removed; use ``Divider.new_locator(...)(ax,
+renderer)`` instead.
+
+``axes_grid.CbarAxesBase.toggle_label`` has been removed. Instead, use standard methods
+for manipulating colorbar labels (`.Colorbar.set_label`) and tick labels
+(`.Axes.tick_params`).
+
+``inset_location.InsetPosition`` has been removed; use `~.Axes.inset_axes` instead.
+
+
+``axisartist`` API changes
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The ``axisartist.axes_grid`` and ``axisartist.axes_rgb`` modules, which provide wrappers
+combining the functionality of `.axes_grid1` and `.axisartist`, have been removed;
+directly use e.g. ``AxesGrid(..., axes_class=axislines.Axes)`` instead.
+
+Calling an axisartist Axes to mean `~matplotlib.pyplot.axis` has been removed; explicitly
+call the method instead.
+
+``floating_axes.GridHelperCurveLinear.get_data_boundary`` has been removed.  Use
+``grid_finder.extreme_finder(*[None] * 5)`` to get the extremes of the grid.

doc/api/prev_api_changes/api_changes_3.6.0/behaviour.rst

@@ -241,7 +241,7 @@ Specified exception types in ``Grid``
 
 In a few cases an `Exception` was thrown when an incorrect argument value was
 set in the `mpl_toolkits.axes_grid1.axes_grid.Grid` (=
-`mpl_toolkits.axisartist.axes_grid.Grid`) constructor. These are replaced as
+``mpl_toolkits.axisartist.axes_grid.Grid``) constructor. These are replaced as
 follows:
 
 * Providing an incorrect value for *ngrids* now raises a `ValueError`

doc/api/prev_api_changes/api_changes_3.7.0/deprecations.rst

@@ -90,7 +90,7 @@ Passing undefined *label_mode* to ``Grid``
 ... is deprecated. This includes `mpl_toolkits.axes_grid1.axes_grid.Grid`,
 `mpl_toolkits.axes_grid1.axes_grid.AxesGrid`, and
 `mpl_toolkits.axes_grid1.axes_grid.ImageGrid` as well as the corresponding
-classes imported from `mpl_toolkits.axisartist.axes_grid`.
+classes imported from ``mpl_toolkits.axisartist.axes_grid``.
 
 Pass ``label_mode='keep'`` instead to get the previous behavior of not modifying labels.
 

doc/api/prev_api_changes/api_changes_3.9.0/removals.rst

@@ -111,7 +111,7 @@ Passing undefined *label_mode* to ``Grid``
 ... is no longer allowed. This includes `mpl_toolkits.axes_grid1.axes_grid.Grid`,
 `mpl_toolkits.axes_grid1.axes_grid.AxesGrid`, and
 `mpl_toolkits.axes_grid1.axes_grid.ImageGrid` as well as the corresponding classes
-imported from `mpl_toolkits.axisartist.axes_grid`.
+imported from ``mpl_toolkits.axisartist.axes_grid``.
 
 Pass ``label_mode='keep'`` instead to get the previous behavior of not modifying labels.
 

doc/api/toolkits/axisartist.rst

@@ -34,8 +34,6 @@ You can find a tutorial describing usage of axisartist at the
 
    axisartist.angle_helper
    axisartist.axes_divider
-   axisartist.axes_grid
-   axisartist.axes_rgb
    axisartist.axis_artist
    axisartist.axisline_style
    axisartist.axislines

lib/mpl_toolkits/axes_grid1/anchored_artists.py

@@ -1,12 +1,12 @@
-from matplotlib import _api, transforms
+from matplotlib import transforms
 from matplotlib.offsetbox import (AnchoredOffsetbox, AuxTransformBox,
                                   DrawingArea, TextArea, VPacker)
-from matplotlib.patches import (Rectangle, Ellipse, ArrowStyle,
+from matplotlib.patches import (Rectangle, ArrowStyle,
                                 FancyArrowPatch, PathPatch)
 from matplotlib.text import TextPath
 
 __all__ = ['AnchoredDrawingArea', 'AnchoredAuxTransformBox',
-           'AnchoredEllipse', 'AnchoredSizeBar', 'AnchoredDirectionArrows']
+           'AnchoredSizeBar', 'AnchoredDirectionArrows']
 
 
 class AnchoredDrawingArea(AnchoredOffsetbox):
@@ -124,54 +124,6 @@ def __init__(self, transform, loc,
                          **kwargs)
 
 
-@_api.deprecated("3.8")
-class AnchoredEllipse(AnchoredOffsetbox):
-    def __init__(self, transform, width, height, angle, loc,
-                 pad=0.1, borderpad=0.1, prop=None, frameon=True, **kwargs):
-        """
-        Draw an anchored ellipse of a given size.
-
-        Parameters
-        ----------
-        transform : `~matplotlib.transforms.Transform`
-            The transformation object for the coordinate system in use, i.e.,
-            :attr:`matplotlib.axes.Axes.transData`.
-        width, height : float
-            Width and height of the ellipse, given in coordinates of
-            *transform*.
-        angle : float
-            Rotation of the ellipse, in degrees, anti-clockwise.
-        loc : str
-            Location of the ellipse.  Valid locations are
-            'upper left', 'upper center', 'upper right',
-            'center left', 'center', 'center right',
-            'lower left', 'lower center', 'lower right'.
-            For backward compatibility, numeric values are accepted as well.
-            See the parameter *loc* of `.Legend` for details.
-        pad : float, default: 0.1
-            Padding around the ellipse, in fraction of the font size.
-        borderpad : float, default: 0.1
-            Border padding, in fraction of the font size.
-        frameon : bool, default: True
-            If True, draw a box around the ellipse.
-        prop : `~matplotlib.font_manager.FontProperties`, optional
-            Font property used as a reference for paddings.
-        **kwargs
-            Keyword arguments forwarded to `.AnchoredOffsetbox`.
-
-        Attributes
-        ----------
-        ellipse : `~matplotlib.patches.Ellipse`
-            Ellipse patch drawn.
-        """
-        self._box = AuxTransformBox(transform)
-        self.ellipse = Ellipse((0, 0), width, height, angle=angle)
-        self._box.add_artist(self.ellipse)
-
-        super().__init__(loc, pad=pad, borderpad=borderpad, child=self._box,
-                         prop=prop, frameon=frameon, **kwargs)
-
-
 class AnchoredSizeBar(AnchoredOffsetbox):
     def __init__(self, transform, size, label, loc,
                  pad=0.1, borderpad=0.1, sep=2,

lib/mpl_toolkits/axes_grid1/axes_divider.py

@@ -199,31 +199,6 @@ def new_locator(self, nx, ny, nx1=None, ny1=None):
         locator.get_subplotspec = self.get_subplotspec
         return locator
 
-    @_api.deprecated(
-        "3.8", alternative="divider.new_locator(...)(ax, renderer)")
-    def locate(self, nx, ny, nx1=None, ny1=None, axes=None, renderer=None):
-        """
-        Implementation of ``divider.new_locator().__call__``.
-
-        Parameters
-        ----------
-        nx, nx1 : int
-            Integers specifying the column-position of the cell. When *nx1* is
-            None, a single *nx*-th column is specified. Otherwise, the
-            location of columns spanning between *nx* to *nx1* (but excluding
-            *nx1*-th column) is specified.
-        ny, ny1 : int
-            Same as *nx* and *nx1*, but for row positions.
-        axes
-        renderer
-        """
-        xref = self._xrefindex
-        yref = self._yrefindex
-        return self._locate(
-            nx - xref, (nx + 1 if nx1 is None else nx1) - xref,
-            ny - yref, (ny + 1 if ny1 is None else ny1) - yref,
-            axes, renderer)
-
     def _locate(self, nx, ny, nx1, ny1, axes, renderer):
         """
         Implementation of ``divider.new_locator().__call__``.
@@ -305,57 +280,6 @@ def add_auto_adjustable_area(self, use_axes, pad=0.1, adjust_dirs=None):
             self.append_size(d, Size._AxesDecorationsSize(use_axes, d) + pad)
 
 
-@_api.deprecated("3.8")
-class AxesLocator:
-    """
-    A callable object which returns the position and size of a given
-    `.AxesDivider` cell.
-    """
-
-    def __init__(self, axes_divider, nx, ny, nx1=None, ny1=None):
-        """
-        Parameters
-        ----------
-        axes_divider : `~mpl_toolkits.axes_grid1.axes_divider.AxesDivider`
-        nx, nx1 : int
-            Integers specifying the column-position of the
-            cell. When *nx1* is None, a single *nx*-th column is
-            specified. Otherwise, location of columns spanning between *nx*
-            to *nx1* (but excluding *nx1*-th column) is specified.
-        ny, ny1 : int
-            Same as *nx* and *nx1*, but for row positions.
-        """
-        self._axes_divider = axes_divider
-
-        _xrefindex = axes_divider._xrefindex
-        _yrefindex = axes_divider._yrefindex
-
-        self._nx, self._ny = nx - _xrefindex, ny - _yrefindex
-
-        if nx1 is None:
-            nx1 = len(self._axes_divider)
-        if ny1 is None:
-            ny1 = len(self._axes_divider[0])
-
-        self._nx1 = nx1 - _xrefindex
-        self._ny1 = ny1 - _yrefindex
-
-    def __call__(self, axes, renderer):
-
-        _xrefindex = self._axes_divider._xrefindex
-        _yrefindex = self._axes_divider._yrefindex
-
-        return self._axes_divider.locate(self._nx + _xrefindex,
-                                         self._ny + _yrefindex,
-                                         self._nx1 + _xrefindex,
-                                         self._ny1 + _yrefindex,
-                                         axes,
-                                         renderer)
-
-    def get_subplotspec(self):
-        return self._axes_divider.get_subplotspec()
-
-
 class SubplotDivider(Divider):
     """
     The Divider class whose rectangle area is specified as a subplot geometry.

lib/mpl_toolkits/axes_grid1/axes_grid.py

@@ -20,11 +20,6 @@ def colorbar(self, mappable, **kwargs):
         return self.get_figure(root=False).colorbar(
             mappable, cax=self, location=self.orientation, **kwargs)
 
-    @_api.deprecated("3.8", alternative="ax.tick_params and colorbar.set_label")
-    def toggle_label(self, b):
-        axis = self.axis[self.orientation]
-        axis.toggle(ticklabels=b, label=b)
-
 
 _cbaraxes_class_factory = cbook._make_class_factory(CbarAxesBase, "Cbar{}")
 

lib/mpl_toolkits/axes_grid1/inset_locator.py

@@ -6,58 +6,13 @@
 from matplotlib.offsetbox import AnchoredOffsetbox
 from matplotlib.patches import Patch, Rectangle
 from matplotlib.path import Path
-from matplotlib.transforms import Bbox, BboxTransformTo
+from matplotlib.transforms import Bbox
 from matplotlib.transforms import IdentityTransform, TransformedBbox
 
 from . import axes_size as Size
 from .parasite_axes import HostAxes
 
 
-@_api.deprecated("3.8", alternative="Axes.inset_axes")
-class InsetPosition:
-    @_docstring.interpd
-    def __init__(self, parent, lbwh):
-        """
-        An object for positioning an inset axes.
-
-        This is created by specifying the normalized coordinates in the axes,
-        instead of the figure.
-
-        Parameters
-        ----------
-        parent : `~matplotlib.axes.Axes`
-            Axes to use for normalizing coordinates.
-
-        lbwh : iterable of four floats
-            The left edge, bottom edge, width, and height of the inset axes, in
-            units of the normalized coordinate of the *parent* axes.
-
-        See Also
-        --------
-        :meth:`matplotlib.axes.Axes.set_axes_locator`
-
-        Examples
-        --------
-        The following bounds the inset axes to a box with 20%% of the parent
-        axes height and 40%% of the width. The size of the axes specified
-        ([0, 0, 1, 1]) ensures that the axes completely fills the bounding box:
-
-        >>> parent_axes = plt.gca()
-        >>> ax_ins = plt.axes([0, 0, 1, 1])
-        >>> ip = InsetPosition(parent_axes, [0.5, 0.1, 0.4, 0.2])
-        >>> ax_ins.set_axes_locator(ip)
-        """
-        self.parent = parent
-        self.lbwh = lbwh
-
-    def __call__(self, ax, renderer):
-        bbox_parent = self.parent.get_position(original=False)
-        trans = BboxTransformTo(bbox_parent)
-        bbox_inset = Bbox.from_bounds(*self.lbwh)
-        bb = TransformedBbox(bbox_inset, trans)
-        return bb
-
-
 class AnchoredLocatorBase(AnchoredOffsetbox):
     def __init__(self, bbox_to_anchor, offsetbox, loc,
                  borderpad=0.5, bbox_transform=None):