MNT: change name to _get_renderer

jklymak · jklymak · commit 24d92e1b5cfc · 2022-05-10T09:28:35.000-07:00
diff --git a/lib/matplotlib/_tight_layout.py b/lib/matplotlib/_tight_layout.py
@@ -198,10 +198,6 @@ def auto_adjust_subplotpars(
         ax_bbox_list, pad, h_pad, w_pad, rect)
 
 
-def get_renderer(fig):
-    fig._get_cached_renderer()
-
-
 def get_subplotspec_list(axes_list, grid_spec=None):
     """
     Return a list of subplotspec from the given list of axes.
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -4478,7 +4478,7 @@ def get_tightbbox(self, renderer=None, call_axes_locator=True,
 
         bb = []
         if renderer is None:
-            renderer = self.figure._get_cached_renderer()
+            renderer = self.figure._get_renderer()
 
         if not self.get_visible():
             return None
diff --git a/lib/matplotlib/axis.py b/lib/matplotlib/axis.py
@@ -1206,7 +1206,7 @@ def _update_ticks(self):
     def _get_ticklabel_bboxes(self, ticks, renderer=None):
         """Return lists of bboxes for ticks' label1's and label2's."""
         if renderer is None:
-            renderer = self.figure._get_cached_renderer()
+            renderer = self.figure._get_renderer()
         return ([tick.label1.get_window_extent(renderer)
                  for tick in ticks if tick.label1.get_visible()],
                 [tick.label2.get_window_extent(renderer)
@@ -1225,7 +1225,7 @@ def get_tightbbox(self, renderer=None, *, for_layout_only=False):
         if not self.get_visible():
             return
         if renderer is None:
-            renderer = self.figure._get_cached_renderer()
+            renderer = self.figure._get_renderer()
         ticks_to_draw = self._update_ticks()
 
         self._update_label_position(renderer)
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -1646,7 +1646,7 @@ def get_tightbbox(self, renderer=None, bbox_extra_artists=None):
         """
 
         if renderer is None:
-            renderer = self.figure._get_cached_renderer()
+            renderer = self.figure._get_renderer()
 
         bb = []
         if bbox_extra_artists is None:
@@ -2063,8 +2063,8 @@ def dpi(self):
     def dpi(self, value):
         self._parent.dpi = value
 
-    def _get_cached_renderer(self):
-        return self._parent._get_cached_renderer()
+    def _get_renderer(self):
+        return self._parent._get_renderer()
 
     def _redo_transform_rel_fig(self, bbox=None):
         """
@@ -2494,7 +2494,7 @@ def axes(self):
 
     get_axes = axes.fget
 
-    def _get_cached_renderer(self):
+    def _get_renderer(self):
         if self._cachedRenderer is not None:
             return self._cachedRenderer
         elif hasattr(self.canvas, 'get_renderer'):
@@ -2650,7 +2650,7 @@ def get_constrained_layout_pads(self, relative=False):
         hspace = info['hspace']
 
         if relative and (w_pad is not None or h_pad is not None):
-            renderer = self._get_cached_renderer()
+            renderer = self._get_renderer()
             dpi = renderer.dpi
             w_pad = w_pad * dpi / renderer.width
             h_pad = h_pad * dpi / renderer.height
diff --git a/lib/matplotlib/gridspec.py b/lib/matplotlib/gridspec.py
@@ -474,7 +474,7 @@ def tight_layout(self, figure, renderer=None,
                                "might be incorrect.")
 
         if renderer is None:
-            renderer = _tight_layout.get_renderer(figure)
+            renderer = figure._get_renderer()
 
         kwargs = _tight_layout.get_tight_layout_figure(
             figure, figure.axes, subplotspec_list, renderer,
diff --git a/lib/matplotlib/image.py b/lib/matplotlib/image.py
@@ -1425,7 +1425,7 @@ def __init__(self, bbox,
 
     def get_window_extent(self, renderer=None):
         if renderer is None:
-            renderer = self.get_figure()._get_cached_renderer()
+            renderer = self.get_figure()._get_renderer()
 
         if isinstance(self.bbox, BboxBase):
             return self.bbox
diff --git a/lib/matplotlib/layout_engine.py b/lib/matplotlib/layout_engine.py
@@ -152,7 +152,7 @@ def execute(self, fig):
             _api.warn_external("This figure includes Axes that are not "
                                "compatible with tight_layout, so results "
                                "might be incorrect.")
-        renderer = fig._get_cached_renderer()
+        renderer = fig._get_renderer()
         with getattr(renderer, "_draw_disabled", nullcontext)():
             kwargs = get_tight_layout_figure(
                 fig, fig.axes, subplotspec_list, renderer,
diff --git a/lib/matplotlib/legend.py b/lib/matplotlib/legend.py
@@ -882,7 +882,7 @@ def get_title(self):
     def get_window_extent(self, renderer=None):
         # docstring inherited
         if renderer is None:
-            renderer = self.figure._get_cached_renderer()
+            renderer = self.figure._get_renderer()
         return self._legend_box.get_window_extent(renderer=renderer)
 
     def get_tightbbox(self, renderer=None):
diff --git a/lib/matplotlib/offsetbox.py b/lib/matplotlib/offsetbox.py
@@ -348,7 +348,7 @@ def get_extent(self, renderer):
     def get_window_extent(self, renderer=None):
         # docstring inherited
         if renderer is None:
-            renderer = self.figure._get_cached_renderer()
+            renderer = self.figure._get_renderer()
         w, h, xd, yd, offsets = self.get_extent_offsets(renderer)
         px, py = self.get_offset(w, h, xd, yd, renderer)
         return mtransforms.Bbox.from_bounds(px - xd, py - yd, w, h)
@@ -636,7 +636,7 @@ def get_offset(self):
     def get_window_extent(self, renderer=None):
         # docstring inherited
         if renderer is None:
-            renderer = self.figure._get_cached_renderer()
+            renderer = self.figure._get_renderer()
         w, h, xd, yd = self.get_extent(renderer)
         ox, oy = self.get_offset()  # w, h, xd, yd)
 
@@ -798,7 +798,7 @@ def get_offset(self):
     def get_window_extent(self, renderer=None):
         # docstring inherited
         if renderer is None:
-            renderer = self.figure._get_cached_renderer()
+            renderer = self.figure._get_renderer()
         w, h, xd, yd = self.get_extent(renderer)
         ox, oy = self.get_offset()
         return mtransforms.Bbox.from_bounds(ox - xd, oy - yd, w, h)
@@ -901,7 +901,7 @@ def get_offset(self):
     def get_window_extent(self, renderer=None):
         # docstring inherited
         if renderer is None:
-            renderer = self.figure._get_cached_renderer()
+            renderer = self.figure._get_renderer()
         w, h, xd, yd = self.get_extent(renderer)
         ox, oy = self.get_offset()  # w, h, xd, yd)
         return mtransforms.Bbox.from_bounds(ox - xd, oy - yd, w, h)
@@ -1085,7 +1085,7 @@ def set_bbox_to_anchor(self, bbox, transform=None):
     def get_window_extent(self, renderer=None):
         # docstring inherited
         if renderer is None:
-            renderer = self.figure._get_cached_renderer()
+            renderer = self.figure._get_renderer()
 
         self._update_offset_func(renderer)
         w, h, xd, yd = self.get_extent(renderer)
@@ -1251,7 +1251,7 @@ def get_children(self):
     def get_window_extent(self, renderer=None):
         # docstring inherited
         if renderer is None:
-            renderer = self.figure._get_cached_renderer()
+            renderer = self.figure._get_renderer()
         w, h, xd, yd = self.get_extent(renderer)
         ox, oy = self.get_offset()
         return mtransforms.Bbox.from_bounds(ox - xd, oy - yd, w, h)
@@ -1432,7 +1432,7 @@ def get_fontsize(self):
     def get_window_extent(self, renderer=None):
         # docstring inherited
         if renderer is None:
-            renderer = self.figure._get_cached_renderer()
+            renderer = self.figure._get_renderer()
         return Bbox.union([child.get_window_extent(renderer)
                            for child in self.get_children()])
 
@@ -1553,7 +1553,7 @@ def on_motion(self, evt):
             if self._use_blit:
                 self.canvas.restore_region(self.background)
                 self.ref_artist.draw(
-                    self.ref_artist.figure._get_cached_renderer())
+                    self.ref_artist.figure._get_renderer())
                 self.canvas.blit()
             else:
                 self.canvas.draw()
@@ -1569,7 +1569,7 @@ def on_pick(self, evt):
                 self.background = \
                     self.canvas.copy_from_bbox(self.ref_artist.figure.bbox)
                 self.ref_artist.draw(
-                    self.ref_artist.figure._get_cached_renderer())
+                    self.ref_artist.figure._get_renderer())
                 self.canvas.blit()
             self._c1 = self.canvas.callbacks._connect_picklable(
                 "motion_notify_event", self.on_motion)
@@ -1619,7 +1619,7 @@ def __init__(self, ref_artist, offsetbox, use_blit=False):
 
     def save_offset(self):
         offsetbox = self.offsetbox
-        renderer = offsetbox.figure._get_cached_renderer()
+        renderer = offsetbox.figure._get_renderer()
         w, h, xd, yd = offsetbox.get_extent(renderer)
         offset = offsetbox.get_offset(w, h, xd, yd, renderer)
         self.offsetbox_x, self.offsetbox_y = offset
@@ -1631,7 +1631,7 @@ def update_offset(self, dx, dy):
 
     def get_loc_in_canvas(self):
         offsetbox = self.offsetbox
-        renderer = offsetbox.figure._get_cached_renderer()
+        renderer = offsetbox.figure._get_renderer()
         w, h, xd, yd = offsetbox.get_extent(renderer)
         ox, oy = offsetbox._offset
         loc_in_canvas = (ox - xd, oy - yd)
diff --git a/lib/matplotlib/table.py b/lib/matplotlib/table.py
@@ -398,7 +398,7 @@ def draw(self, renderer):
         # Need a renderer to do hit tests on mouseevent; assume the last one
         # will do
         if renderer is None:
-            renderer = self.figure._get_cached_renderer()
+            renderer = self.figure._get_renderer()
         if renderer is None:
             raise RuntimeError('No renderer defined')
 
@@ -432,7 +432,7 @@ def contains(self, mouseevent):
             return inside, info
         # TODO: Return index of the cell containing the cursor so that the user
         # doesn't have to bind to each one individually.
-        renderer = self.figure._get_cached_renderer()
+        renderer = self.figure._get_renderer()
         if renderer is not None:
             boxes = [cell.get_window_extent(renderer)
                      for (row, col), cell in self._cells.items()
@@ -449,7 +449,7 @@ def get_children(self):
     def get_window_extent(self, renderer=None):
         # docstring inherited
         if renderer is None:
-            renderer = self.figure._get_cached_renderer()
+            renderer = self.figure._get_renderer()
         self._update_positions(renderer)
         boxes = [cell.get_window_extent(renderer)
                  for cell in self._cells.values()]
diff --git a/lib/matplotlib/text.py b/lib/matplotlib/text.py
@@ -905,7 +905,7 @@ def get_window_extent(self, renderer=None, dpi=None):
         if renderer is not None:
             self._renderer = renderer
         if self._renderer is None:
-            self._renderer = self.figure._get_cached_renderer()
+            self._renderer = self.figure._get_renderer()
         if self._renderer is None:
             raise RuntimeError(
                 "Cannot get window extent of text w/o renderer. You likely "
@@ -1570,7 +1570,7 @@ def _get_position_xy(self, renderer):
     def _check_xy(self, renderer=None):
         """Check whether the annotation at *xy_pixel* should be drawn."""
         if renderer is None:
-            renderer = self.figure._get_cached_renderer()
+            renderer = self.figure._get_renderer()
         b = self.get_annotation_clip()
         if b or (b is None and self.xycoords == "data"):
             # check if self.xy is inside the axes.
@@ -2007,7 +2007,7 @@ def get_window_extent(self, renderer=None):
         if renderer is not None:
             self._renderer = renderer
         if self._renderer is None:
-            self._renderer = self.figure._get_cached_renderer()
+            self._renderer = self.figure._get_renderer()
         if self._renderer is None:
             raise RuntimeError('Cannot get window extent w/o renderer')
 
diff --git a/lib/matplotlib/widgets.py b/lib/matplotlib/widgets.py
@@ -1224,7 +1224,7 @@ def _rendercursor(self):
         # This causes a single extra draw if the figure has never been rendered
         # yet, which should be fine as we're going to repeatedly re-render the
         # figure later anyways.
-        if self.ax.figure._get_cached_renderer() is None:
+        if self.ax.figure._get_renderer() is None:
             self.ax.figure.canvas.draw()
 
         text = self.text_disp.get_text()  # Save value before overwriting it.
@@ -1946,7 +1946,7 @@ def ignore(self, event):
     def update(self):
         """Draw using blit() or draw_idle(), depending on ``self.useblit``."""
         if (not self.ax.get_visible() or
-                self.ax.figure._get_cached_renderer() is None):
+                self.ax.figure._get_renderer() is None):
             return False
         if self.useblit:
             if self.background is not None:
diff --git a/lib/mpl_toolkits/axisartist/axis_artist.py b/lib/mpl_toolkits/axisartist/axis_artist.py
@@ -252,7 +252,7 @@ def draw(self, renderer):
 
     def get_window_extent(self, renderer=None):
         if renderer is None:
-            renderer = self.figure._get_cached_renderer()
+            renderer = self.figure._get_renderer()
 
         # save original and adjust some properties
         tr = self.get_transform()
@@ -366,7 +366,7 @@ def draw(self, renderer):
 
     def get_window_extent(self, renderer=None):
         if renderer is None:
-            renderer = self.figure._get_cached_renderer()
+            renderer = self.figure._get_renderer()
         if not self.get_visible():
             return
 
@@ -520,7 +520,7 @@ def set_locs_angles_labels(self, locs_angles_labels):
 
     def get_window_extents(self, renderer=None):
         if renderer is None:
-            renderer = self.figure._get_cached_renderer()
+            renderer = self.figure._get_renderer()
 
         if not self.get_visible():
             self._axislabel_pad = self._external_pad
@@ -858,7 +858,7 @@ def _update_ticks(self, renderer=None):
         # majorticks even for minor ticks. not clear what is best.
 
         if renderer is None:
-            renderer = self.figure._get_cached_renderer()
+            renderer = self.figure._get_renderer()
 
         dpi_cor = renderer.points_to_pixels(1.)
         if self.major_ticks.get_visible() and self.major_ticks.get_tick_out():
