Merge pull request matplotlib#28550 from rcomer/remove-figure-use

Remove internal use of `Artist.figure`

Author: ksunden

lib/matplotlib/_constrained_layout.py

@@ -634,7 +634,7 @@ def get_pos_and_bbox(ax, renderer):
     bbox : `~matplotlib.transforms.Bbox`
         Tight bounding box in figure coordinates.
     """
-    fig = ax.figure
+    fig = ax.get_figure(root=False)
     pos = ax.get_position(original=True)
     # pos is in panel co-ords, but we need in figure for the layout
     pos = pos.transformed(fig.transSubfigure - fig.transFigure)
@@ -706,7 +706,7 @@ def reposition_colorbar(layoutgrids, cbax, renderer, *, offset=None):
 
     parents = cbax._colorbar_info['parents']
     gs = parents[0].get_gridspec()
-    fig = cbax.figure
+    fig = cbax.get_figure(root=False)
     trans_fig_to_subfig = fig.transFigure - fig.transSubfigure
 
     cb_rspans, cb_cspans = get_cb_parent_spans(cbax)

lib/matplotlib/artist.py

@@ -74,8 +74,8 @@ def draw_wrapper(artist, renderer):
                 renderer.stop_filter(artist.get_agg_filter())
             if artist.get_rasterized():
                 renderer._raster_depth -= 1
-            if (renderer._rasterizing and artist.figure and
-                    artist.figure.suppressComposite):
+            if (renderer._rasterizing and (fig := artist.get_figure(root=True)) and
+                    fig.suppressComposite):
                 # restart rasterizing to prevent merging
                 renderer.stop_rasterizing()
                 renderer.start_rasterizing()
@@ -247,9 +247,9 @@ def remove(self):
                 self.axes = None  # decouple the artist from the Axes
                 _ax_flag = True
 
-            if self.figure:
+            if (fig := self.get_figure(root=False)) is not None:
                 if not _ax_flag:
-                    self.figure.stale = True
+                    fig.stale = True
                 self._parent_figure = None
 
         else:
@@ -472,8 +472,9 @@ def _different_canvas(self, event):
                 return False, {}
             # subclass-specific implementation follows
         """
-        return (getattr(event, "canvas", None) is not None and self.figure is not None
-                and event.canvas is not self.figure.canvas)
+        return (getattr(event, "canvas", None) is not None
+                and (fig := self.get_figure(root=True)) is not None
+                and event.canvas is not fig.canvas)
 
     def contains(self, mouseevent):
         """
@@ -503,7 +504,7 @@ def pickable(self):
         --------
         .Artist.set_picker, .Artist.get_picker, .Artist.pick
         """
-        return self.figure is not None and self._picker is not None
+        return self.get_figure(root=False) is not None and self._picker is not None
 
     def pick(self, mouseevent):
         """
@@ -525,7 +526,7 @@ def pick(self, mouseevent):
             else:
                 inside, prop = self.contains(mouseevent)
             if inside:
-                PickEvent("pick_event", self.figure.canvas,
+                PickEvent("pick_event", self.get_figure(root=True).canvas,
                           mouseevent, self, **prop)._process()
 
         # Pick children

lib/matplotlib/artist.pyi

@@ -15,7 +15,7 @@ from .transforms import (
 import numpy as np
 
 from collections.abc import Callable, Iterable
-from typing import Any, NamedTuple, TextIO, overload, TypeVar
+from typing import Any, Literal, NamedTuple, TextIO, overload, TypeVar
 from numpy.typing import ArrayLike
 
 _T_Artist = TypeVar("_T_Artist", bound=Artist)
@@ -88,6 +88,11 @@ class Artist:
     ) -> None: ...
     def set_path_effects(self, path_effects: list[AbstractPathEffect]) -> None: ...
     def get_path_effects(self) -> list[AbstractPathEffect]: ...
+    @overload
+    def get_figure(self, root: Literal[True]) -> Figure | None: ...
+    @overload
+    def get_figure(self, root: Literal[False]) -> Figure | SubFigure | None: ...
+    @overload
     def get_figure(self, root: bool = ...) -> Figure | SubFigure | None: ...
     def set_figure(self, fig: Figure | SubFigure) -> None: ...
     def set_clip_box(self, clipbox: BboxBase | None) -> None: ...

lib/matplotlib/axes/_axes.py

@@ -406,8 +406,9 @@ def inset_axes(self, bounds, *, transform=None, zorder=5, **kwargs):
         # This puts the rectangle into figure-relative coordinates.
         inset_locator = _TransformedBoundsLocator(bounds, transform)
         bounds = inset_locator(self, None).bounds
-        projection_class, pkw = self.figure._process_projection_requirements(**kwargs)
-        inset_ax = projection_class(self.figure, bounds, zorder=zorder, **pkw)
+        fig = self.get_figure(root=False)
+        projection_class, pkw = fig._process_projection_requirements(**kwargs)
+        inset_ax = projection_class(fig, bounds, zorder=zorder, **pkw)
 
         # this locator lets the axes move if in data coordinates.
         # it gets called in `ax.apply_aspect() (of all places)
@@ -517,7 +518,7 @@ def indicate_inset(self, bounds, inset_ax=None, *, transform=None,
 
             # decide which two of the lines to keep visible....
             pos = inset_ax.get_position()
-            bboxins = pos.transformed(self.figure.transSubfigure)
+            bboxins = pos.transformed(self.get_figure(root=False).transSubfigure)
             rectbbox = mtransforms.Bbox.from_bounds(
                 *bounds
             ).transformed(transform)

lib/matplotlib/axes/_base.py

@@ -115,7 +115,7 @@ def __call__(self, ax, renderer):
         # time as transSubfigure may otherwise change after this is evaluated.
         return mtransforms.TransformedBbox(
             mtransforms.Bbox.from_bounds(*self._bounds),
-            self._transform - ax.figure.transSubfigure)
+            self._transform - ax.get_figure(root=False).transSubfigure)
 
 
 def _process_plot_format(fmt, *, ambiguous_fmt_datakey=False):
@@ -788,7 +788,7 @@ def get_subplotspec(self):
     def set_subplotspec(self, subplotspec):
         """Set the `.SubplotSpec`. associated with the subplot."""
         self._subplotspec = subplotspec
-        self._set_position(subplotspec.get_position(self.figure))
+        self._set_position(subplotspec.get_position(self.get_figure(root=False)))
 
     def get_gridspec(self):
         """Return the `.GridSpec` associated with the subplot, or None."""
@@ -959,8 +959,9 @@ def get_xaxis_text1_transform(self, pad_points):
         """
         labels_align = mpl.rcParams["xtick.alignment"]
         return (self.get_xaxis_transform(which='tick1') +
-                mtransforms.ScaledTranslation(0, -1 * pad_points / 72,
-                                              self.figure.dpi_scale_trans),
+                mtransforms.ScaledTranslation(
+                    0, -1 * pad_points / 72,
+                    self.get_figure(root=False).dpi_scale_trans),
                 "top", labels_align)
 
     def get_xaxis_text2_transform(self, pad_points):
@@ -985,8 +986,9 @@ def get_xaxis_text2_transform(self, pad_points):
         """
         labels_align = mpl.rcParams["xtick.alignment"]
         return (self.get_xaxis_transform(which='tick2') +
-                mtransforms.ScaledTranslation(0, pad_points / 72,
-                                              self.figure.dpi_scale_trans),
+                mtransforms.ScaledTranslation(
+                    0, pad_points / 72,
+                    self.get_figure(root=False).dpi_scale_trans),
                 "bottom", labels_align)
 
     def get_yaxis_transform(self, which='grid'):
@@ -1039,8 +1041,9 @@ def get_yaxis_text1_transform(self, pad_points):
         """
         labels_align = mpl.rcParams["ytick.alignment"]
         return (self.get_yaxis_transform(which='tick1') +
-                mtransforms.ScaledTranslation(-1 * pad_points / 72, 0,
-                                              self.figure.dpi_scale_trans),
+                mtransforms.ScaledTranslation(
+                    -1 * pad_points / 72, 0,
+                    self.get_figure(root=False).dpi_scale_trans),
                 labels_align, "right")
 
     def get_yaxis_text2_transform(self, pad_points):
@@ -1065,8 +1068,9 @@ def get_yaxis_text2_transform(self, pad_points):
         """
         labels_align = mpl.rcParams["ytick.alignment"]
         return (self.get_yaxis_transform(which='tick2') +
-                mtransforms.ScaledTranslation(pad_points / 72, 0,
-                                              self.figure.dpi_scale_trans),
+                mtransforms.ScaledTranslation(
+                    pad_points / 72, 0,
+                    self.get_figure(root=False).dpi_scale_trans),
                 labels_align, "left")
 
     def _update_transScale(self):
@@ -1173,7 +1177,7 @@ def get_axes_locator(self):
 
     def _set_artist_props(self, a):
         """Set the boilerplate props for artists added to Axes."""
-        a.set_figure(self.figure)
+        a.set_figure(self.get_figure(root=False))
         if not a.is_transform_set():
             a.set_transform(self.transData)
 
@@ -1347,7 +1351,7 @@ def __clear(self):
         # the other artists.  We use the frame to draw the edges so we are
         # setting the edgecolor to None.
         self.patch = self._gen_axes_patch()
-        self.patch.set_figure(self.figure)
+        self.patch.set_figure(self.get_figure(root=False))
         self.patch.set_facecolor(self._facecolor)
         self.patch.set_edgecolor('none')
         self.patch.set_linewidth(0)
@@ -1522,7 +1526,7 @@ def _set_title_offset_trans(self, title_offset_points):
         """
         self.titleOffsetTrans = mtransforms.ScaledTranslation(
                 0.0, title_offset_points / 72,
-                self.figure.dpi_scale_trans)
+                self.get_figure(root=False).dpi_scale_trans)
         for _title in (self.title, self._left_title, self._right_title):
             _title.set_transform(self.transAxes + self.titleOffsetTrans)
             _title.set_clip_box(None)
@@ -1937,7 +1941,7 @@ def apply_aspect(self, position=None):
             self._set_position(position, which='active')
             return
 
-        trans = self.get_figure().transSubfigure
+        trans = self.get_figure(root=False).transSubfigure
         bb = mtransforms.Bbox.unit().transformed(trans)
         # this is the physical aspect of the panel (or figure):
         fig_aspect = bb.height / bb.width
@@ -2274,7 +2278,7 @@ def add_child_axes(self, ax):
 
         self.child_axes.append(ax)
         ax._remove_method = functools.partial(
-            self.figure._remove_axes, owners=[self.child_axes])
+            self.get_figure(root=False)._remove_axes, owners=[self.child_axes])
         self.stale = True
         return ax
 
@@ -3022,7 +3026,8 @@ def _update_title_position(self, renderer):
         axs = set()
         axs.update(self.child_axes)
         axs.update(self._twinned_axes.get_siblings(self))
-        axs.update(self.figure._align_label_groups['title'].get_siblings(self))
+        axs.update(
+            self.get_figure(root=False)._align_label_groups['title'].get_siblings(self))
 
         for ax in self.child_axes:  # Child positions must be updated first.
             locator = ax.get_axes_locator()
@@ -3108,7 +3113,7 @@ def draw(self, renderer):
             for _axis in self._axis_map.values():
                 artists.remove(_axis)
 
-        if not self.figure.canvas.is_saving():
+        if not self.get_figure(root=True).canvas.is_saving():
             artists = [
                 a for a in artists
                 if not a.get_animated() or isinstance(a, mimage.AxesImage)]
@@ -3136,10 +3141,10 @@ def draw(self, renderer):
                 artists = [self.patch] + artists
 
         if artists_rasterized:
-            _draw_rasterized(self.figure, artists_rasterized, renderer)
+            _draw_rasterized(self.get_figure(root=True), artists_rasterized, renderer)
 
         mimage._draw_list_compositing_images(
-            renderer, self, artists, self.figure.suppressComposite)
+            renderer, self, artists, self.get_figure(root=True).suppressComposite)
 
         renderer.close_group('axes')
         self.stale = False
@@ -3148,7 +3153,7 @@ def draw_artist(self, a):
         """
         Efficiently redraw a single artist.
         """
-        a.draw(self.figure.canvas.get_renderer())
+        a.draw(self.get_figure(root=True).canvas.get_renderer())
 
     def redraw_in_frame(self):
         """
@@ -3158,7 +3163,7 @@ def redraw_in_frame(self):
             for artist in [*self._axis_map.values(),
                            self.title, self._left_title, self._right_title]:
                 stack.enter_context(artist._cm_set(visible=False))
-            self.draw(self.figure.canvas.get_renderer())
+            self.draw(self.get_figure(root=True).canvas.get_renderer())
 
     # Axes rectangle characteristics
 
@@ -4466,7 +4471,7 @@ def get_tightbbox(self, renderer=None, call_axes_locator=True,
 
         bb = []
         if renderer is None:
-            renderer = self.figure._get_renderer()
+            renderer = self.get_figure(root=True)._get_renderer()
 
         if not self.get_visible():
             return None
@@ -4517,9 +4522,9 @@ def _make_twin_axes(self, *args, **kwargs):
                 raise ValueError("Twinned Axes may share only one axis")
         ss = self.get_subplotspec()
         if ss:
-            twin = self.figure.add_subplot(ss, *args, **kwargs)
+            twin = self.get_figure(root=False).add_subplot(ss, *args, **kwargs)
         else:
-            twin = self.figure.add_axes(
+            twin = self.get_figure(root=False).add_axes(
                 self.get_position(True), *args, **kwargs,
                 axes_locator=_TransformedBoundsLocator(
                     [0, 0, 1, 1], self.transAxes))
@@ -4748,6 +4753,12 @@ def __init__(self, figure, artists):
             self.figure = figure
             self.artists = artists
 
+        def get_figure(self, root=False):
+            if root:
+                return self.figure.get_figure(root=True)
+            else:
+                return self.figure
+
         @martist.allow_rasterization
         def draw(self, renderer):
             for a in self.artists:

lib/matplotlib/axes/_secondary_axes.py

@@ -27,13 +27,14 @@ def __init__(self, parent, orientation, location, functions, transform=None,
         self._orientation = orientation
         self._ticks_set = False
 
+        fig = self._parent.get_figure(root=False)
         if self._orientation == 'x':
-            super().__init__(self._parent.figure, [0, 1., 1, 0.0001], **kwargs)
+            super().__init__(fig, [0, 1., 1, 0.0001], **kwargs)
             self._axis = self.xaxis
             self._locstrings = ['top', 'bottom']
             self._otherstrings = ['left', 'right']
         else:  # 'y'
-            super().__init__(self._parent.figure, [0, 1., 0.0001, 1], **kwargs)
+            super().__init__(fig, [0, 1., 0.0001, 1], **kwargs)
             self._axis = self.yaxis
             self._locstrings = ['right', 'left']
             self._otherstrings = ['top', 'bottom']