Deprecate Axes.apply_aspect()

timhoffm · timhoffm · commit 35a21f9ce8be · 2022-08-15T21:42:58.000+02:00
diff --git a/lib/matplotlib/_constrained_layout.py b/lib/matplotlib/_constrained_layout.py
@@ -267,7 +267,7 @@ def compress_fixed_aspect(layoutgrids, fig):
     for ax in fig.axes:
         if not hasattr(ax, 'get_subplotspec'):
             continue
-        ax.apply_aspect()
+        ax._apply_aspect()
         sub = ax.get_subplotspec()
         _gs = sub.get_gridspec()
         if gs is None:
diff --git a/lib/matplotlib/_tight_bbox.py b/lib/matplotlib/_tight_bbox.py
@@ -29,20 +29,20 @@ def adjust_bbox(fig, bbox_inches, fixed_dpi=None):
         current_pos = ax.get_position(original=False).frozen()
         ax.set_axes_locator(lambda a, r, _pos=current_pos: _pos)
         # override the method that enforces the aspect ratio on the Axes
-        if 'apply_aspect' in ax.__dict__:
-            old_aspect.append(ax.apply_aspect)
+        if '_apply_aspect' in ax.__dict__:
+            old_aspect.append(ax._apply_aspect)
         else:
             old_aspect.append(sentinel)
-        ax.apply_aspect = lambda pos=None: None
+        ax._apply_aspect = lambda pos=None: None
 
     def restore_bbox():
         for ax, loc, aspect in zip(fig.axes, locator_list, old_aspect):
             ax.set_axes_locator(loc)
             if aspect is sentinel:
                 # delete our no-op function which un-hides the original method
-                del ax.apply_aspect
+                del ax._apply_aspect
             else:
-                ax.apply_aspect = aspect
+                ax._apply_aspect = aspect
 
         fig.bbox = origBbox
         fig.bbox_inches = origBboxInches
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -376,7 +376,7 @@ def inset_axes(self, bounds, *, transform=None, zorder=5, **kwargs):
         inset_ax = projection_class(self.figure, bounds, zorder=zorder, **pkw)
 
         # this locator lets the axes move if in data coordinates.
-        # it gets called in `ax.apply_aspect() (of all places)
+        # it gets called in `ax._apply_aspect() (of all places)
         inset_ax.set_axes_locator(inset_locator)
 
         self.add_child_axes(inset_ax)
@@ -444,7 +444,7 @@ def indicate_inset(self, bounds, inset_ax=None, *, transform=None,
         """
         # to make the axes connectors work, we need to apply the aspect to
         # the parent axes.
-        self.apply_aspect()
+        self._apply_aspect()
 
         if transform is None:
             transform = self.transData
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -1041,7 +1041,7 @@ def get_position(self, original=False):
         else:
             locator = self.get_axes_locator()
             if not locator:
-                self.apply_aspect()
+                self._apply_aspect()
             return self._position.frozen()
 
     def set_position(self, pos, which='both'):
@@ -1719,7 +1719,7 @@ def set_adjustable(self, adjustable, share=False):
                 and any(getattr(ax.get_data_ratio, "__func__", None)
                         != _AxesBase.get_data_ratio
                         for ax in axs)):
-            # Limits adjustment by apply_aspect assumes that the axes' aspect
+            # Limits adjustment by _apply_aspect assumes that the axes' aspect
             # ratio can be computed from the data limits and scales.
             raise ValueError("Cannot set Axes adjustable to 'datalim' for "
                              "Axes which override 'get_data_ratio'")
@@ -1855,7 +1855,11 @@ def get_data_ratio(self):
         ysize = max(abs(tymax - tymin), 1e-30)
         return ysize / xsize
 
+    @_api.deprecated("3.6", alternative="Figure.draw_without_rendering")
     def apply_aspect(self, position=None):
+        self._apply_aspect(position)
+
+    def _apply_aspect(self, position=None):
         """
         Adjust the Axes for a specified data aspect ratio.
 
@@ -2954,7 +2958,7 @@ def _update_title_position(self, renderer):
         axs = self._twinned_axes.get_siblings(self) + self.child_axes
         for ax in self.child_axes:  # Child positions must be updated first.
             locator = ax.get_axes_locator()
-            ax.apply_aspect(locator(self, renderer) if locator else None)
+            ax._apply_aspect(locator(self, renderer) if locator else None)
 
         for title in titles:
             x, _ = title.get_position()
@@ -3017,7 +3021,7 @@ def draw(self, renderer):
 
         # loop over self and child Axes...
         locator = self.get_axes_locator()
-        self.apply_aspect(locator(self, renderer) if locator else None)
+        self._apply_aspect(locator(self, renderer) if locator else None)
 
         artists = self.get_children()
         artists.remove(self.patch)
@@ -4382,7 +4386,7 @@ def get_tightbbox(self, renderer=None, call_axes_locator=True,
             return None
 
         locator = self.get_axes_locator()
-        self.apply_aspect(
+        self._apply_aspect(
             locator(self, renderer) if locator and call_axes_locator else None)
 
         for axis in self._axis_map.values():
diff --git a/lib/matplotlib/axes/_secondary_axes.py b/lib/matplotlib/axes/_secondary_axes.py
@@ -114,14 +114,14 @@ def set_location(self, location):
         # this locator lets the axes move in the parent axes coordinates.
         # so it never needs to know where the parent is explicitly in
         # figure coordinates.
-        # it gets called in ax.apply_aspect() (of all places)
+        # it gets called in ax._apply_aspect() (of all places)
         self.set_axes_locator(
             _TransformedBoundsLocator(bounds, self._parent.transAxes))
 
-    def apply_aspect(self, position=None):
+    def _apply_aspect(self, position=None):
         # docstring inherited.
         self._set_lims()
-        super().apply_aspect(position)
+        super()._apply_aspect(position)
 
     @_docstring.copy(Axis.set_ticks)
     def set_ticks(self, ticks, labels=None, *, minor=False, **kwargs):
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -193,7 +193,7 @@ def __init__(self, **kwargs):
         self.set(**kwargs)
 
     def _get_draw_artists(self, renderer):
-        """Also runs apply_aspect"""
+        """Also runs _apply_aspect"""
         artists = self.get_children()
         for sfig in self.subfigs:
             artists.remove(sfig)
@@ -208,12 +208,12 @@ def _get_draw_artists(self, renderer):
             key=lambda artist: artist.get_zorder())
         for ax in self._localaxes:
             locator = ax.get_axes_locator()
-            ax.apply_aspect(locator(ax, renderer) if locator else None)
+            ax._apply_aspect(locator(ax, renderer) if locator else None)
 
             for child in ax.get_children():
-                if hasattr(child, 'apply_aspect'):
+                if hasattr(child, '_apply_aspect'):
                     locator = child.get_axes_locator()
-                    child.apply_aspect(
+                    child._apply_aspect(
                         locator(child, renderer) if locator else None)
         return artists
 
diff --git a/lib/matplotlib/tests/test_axes.py b/lib/matplotlib/tests/test_axes.py
@@ -5273,7 +5273,7 @@ def test_shared_with_aspect_2():
     axs[0].set_aspect(2, share=True)
     axs[0].plot([1, 2], [3, 4])
     axs[1].plot([3, 4], [1, 2])
-    plt.draw()  # Trigger apply_aspect().
+    plt.draw()  # Trigger _apply_aspect().
     assert axs[0].get_xlim() == axs[1].get_xlim()
     assert axs[0].get_ylim() == axs[1].get_ylim()
 
@@ -5286,7 +5286,7 @@ def test_shared_with_aspect_3():
         axs[1].set_aspect(0.5, adjustable=adjustable)
         axs[0].plot([1, 2], [3, 4])
         axs[1].plot([3, 4], [1, 2])
-        plt.draw()  # Trigger apply_aspect().
+        plt.draw()  # Trigger _apply_aspect().
         assert axs[0].get_xlim() != axs[1].get_xlim()
         assert axs[0].get_ylim() == axs[1].get_ylim()
         fig_aspect = fig.bbox_inches.height / fig.bbox_inches.width
@@ -6814,8 +6814,8 @@ def test_inset():
     fig, ax = plt.subplots()
     ax.pcolormesh(x, y, z[:-1, :-1])
     ax.set_aspect(1.)
-    ax.apply_aspect()
-    # we need to apply_aspect to make the drawing below work.
+    ax._apply_aspect()
+    # we need to _apply_aspect to make the drawing below work.
 
     xlim = [1.5, 2.15]
     ylim = [2, 2.5]
@@ -6840,8 +6840,8 @@ def test_zoom_inset():
     fig, ax = plt.subplots()
     ax.pcolormesh(x, y, z[:-1, :-1])
     ax.set_aspect(1.)
-    ax.apply_aspect()
-    # we need to apply_aspect to make the drawing below work.
+    ax._apply_aspect()
+    # we need to _apply_aspect to make the drawing below work.
 
     # Make the inset_axes...  Position axes coordinates...
     axin1 = ax.inset_axes([0.7, 0.7, 0.35, 0.35])
@@ -7376,7 +7376,7 @@ def test_aspect_nonlinear_adjustable_datalim():
            yscale="logit", ylim=(1 / 101, 1 / 11),
            aspect=1, adjustable="datalim")
     ax.margins(0)
-    ax.apply_aspect()
+    ax._apply_aspect()
 
     assert ax.get_xlim() == pytest.approx([1*10**(1/2), 100/10**(1/2)])
     assert ax.get_ylim() == (1 / 101, 1 / 11)
diff --git a/lib/mpl_toolkits/axes_grid1/parasite_axes.py b/lib/mpl_toolkits/axes_grid1/parasite_axes.py
@@ -82,9 +82,13 @@ def _update_viewlim(self):  # Inline after deprecation elapses.
         else:
             _api.check_in_list([None, "equal", "transform"], mode=mode)
 
+    @_api.deprecated("3.6", alternative="Figure.draw_if_interactive")
     def apply_aspect(self, position=None):
+        self._apply_aspect(position)
+
+    def _apply_aspect(self, position=None):
         self._update_viewlim()
-        super().apply_aspect()
+        super()._apply_aspect()
 
     # end of aux_transform support
 
@@ -126,13 +130,13 @@ def draw(self, renderer):
         if locator:
             pos = locator(self, renderer)
             self.set_position(pos, which="active")
-            self.apply_aspect(pos)
+            self._apply_aspect(pos)
         else:
-            self.apply_aspect()
+            self._apply_aspect()
 
         rect = self.get_position()
         for ax in self.parasites:
-            ax.apply_aspect(rect)
+            ax._apply_aspect(rect)
             self._children.extend(ax.get_children())
 
         super().draw(renderer)
diff --git a/lib/mpl_toolkits/mplot3d/axes3d.py b/lib/mpl_toolkits/mplot3d/axes3d.py
@@ -387,7 +387,7 @@ def set_box_aspect(self, aspect, *, zoom=1):
         self._box_aspect = aspect
         self.stale = True
 
-    def apply_aspect(self, position=None):
+    def _apply_aspect(self, position=None):
         if position is None:
             position = self.get_position(original=True)
 
@@ -420,7 +420,7 @@ def draw(self, renderer):
         # it adjusts the view limits and the size of the bounding box
         # of the Axes
         locator = self.get_axes_locator()
-        self.apply_aspect(locator(self, renderer) if locator else None)
+        self._apply_aspect(locator(self, renderer) if locator else None)
 
         # add the projection matrix to the renderer
         self.M = self.get_proj()
