Merge pull request #24251 from oscargus/autoaddtofiguredeprecationexpiration

QuLogic · web-flow · commit aefe56f61a23 · 2022-10-25T16:03:56.000-04:00
Expire deprecation for `auto_add_to_figure=True` in `Axes3D`
diff --git a/doc/api/next_api_changes/removals/24251-OG.rst b/doc/api/next_api_changes/removals/24251-OG.rst
@@ -0,0 +1,4 @@
+``auto_add_to_figure=True`` for ``Axes3D``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+... is no longer supported. Instead use ``fig.add_axes(ax)``.
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -1679,8 +1679,6 @@ def _process_projection_requirements(
                 raise TypeError(
                     f"projection must be a string, None or implement a "
                     f"_as_mpl_axes method, not {projection!r}")
-        if projection_class.__name__ == 'Axes3D':
-            kwargs.setdefault('auto_add_to_figure', False)
         return projection_class, kwargs
 
     def get_default_bbox_extra_artists(self):
diff --git a/lib/matplotlib/tests/test_collections.py b/lib/matplotlib/tests/test_collections.py
@@ -403,7 +403,7 @@ def test_polycollection_close():
         [[3., 0.], [3., 1.], [4., 1.], [4., 0.]]]
 
     fig = plt.figure()
-    ax = fig.add_axes(Axes3D(fig, auto_add_to_figure=False))
+    ax = fig.add_axes(Axes3D(fig))
 
     colors = ['r', 'g', 'b', 'y', 'k']
     zpos = list(range(5))
diff --git a/lib/mpl_toolkits/mplot3d/axes3d.py b/lib/mpl_toolkits/mplot3d/axes3d.py
@@ -99,14 +99,6 @@ def __init__(
             does not produce the desired result. Note however, that a manual
             zorder will only be correct for a limited view angle. If the figure
             is rotated by the user, it will look wrong from certain angles.
-        auto_add_to_figure : bool, default: False
-            Prior to Matplotlib 3.4 Axes3D would add themselves
-            to their host Figure on init.  Other Axes class do not
-            do this.
-
-            This behavior is deprecated in 3.4, the default is
-            changed to False in 3.6.  The keyword will be undocumented
-            and a non-False value will be an error in 3.7.
         focal_length : float, default: None
             For a projection type of 'persp', the focal length of the virtual
             camera. Must be > 0. If None, defaults to 1.
@@ -145,7 +137,11 @@ def __init__(
             self._shared_axes["z"].join(self, sharez)
             self._adjustable = 'datalim'
 
-        auto_add_to_figure = kwargs.pop('auto_add_to_figure', False)
+        if kwargs.pop('auto_add_to_figure', False):
+            raise AttributeError(
+                'auto_add_to_figure is no longer supported for Axes3D. '
+                'Use fig.add_axes(ax) instead.'
+            )
 
         super().__init__(
             fig, rect, frameon=True, box_aspect=box_aspect, *args, **kwargs
@@ -177,18 +173,6 @@ def __init__(
         # for bounding box calculations
         self.spines[:].set_visible(False)
 
-        if auto_add_to_figure:
-            _api.warn_deprecated(
-                "3.4", removal="3.7", message="Axes3D(fig) adding itself "
-                "to the figure is deprecated since %(since)s. "
-                "Pass the keyword argument auto_add_to_figure=False "
-                "and use fig.add_axes(ax) to suppress this warning. "
-                "The default value of auto_add_to_figure is changed to "
-                "False in mpl3.6 and True values will "
-                "no longer work %(removal)s.  This is consistent with "
-                "other Axes classes.")
-            fig.add_axes(self)
-
     def set_axis_off(self):
         self._axis3don = False
         self.stale = True
diff --git a/lib/mpl_toolkits/tests/test_mplot3d.py b/lib/mpl_toolkits/tests/test_mplot3d.py
@@ -925,7 +925,7 @@ def test_add_collection3d_zs_scalar():
 @mpl3d_image_comparison(['axes3d_labelpad.png'], remove_text=False)
 def test_axes3d_labelpad():
     fig = plt.figure()
-    ax = fig.add_axes(Axes3D(fig, auto_add_to_figure=False))
+    ax = fig.add_axes(Axes3D(fig))
     # labelpad respects rcParams
     assert ax.xaxis.labelpad == mpl.rcParams['axes.labelpad']
     # labelpad can be set in set_label
