René's URL Explorer Experiment

Title: Remove internal use of `Artist.figure` by rcomer · Pull Request #28550 · matplotlib/matplotlib · GitHub

Open Graph Title: Remove internal use of `Artist.figure` by rcomer · Pull Request #28550 · matplotlib/matplotlib

X Title: Remove internal use of `Artist.figure` by rcomer · Pull Request #28550 · matplotlib/matplotlib

Description: PR summary The Artist.figure attribute is inconsistent: on most artists, it is the figure the artist is attached to, which may be a SubFigure. OTOH SubFigure.figure is always the root Figure. A lot of the internal usage of this attribute was written before subfigures existed, so there would not have been any decision to make about which figure is required. This means that in places we could be getting hold of a SubFigure when we really need a Figure. At #28177 (comment), @timhoffm said Internally, we should not be using figure anymore. so here is my attempt to remove that internal usage. If I comment out the figure property in both figure.py and artist.py, the tests still pass locally (except the one that explicitly tests the property). get_figure parameter choices Wherever I use get_figure in the main code, I made a choice about the root parameter. In many places, the end result will be the same whether root is True or False: artist.get_figure(root=False) will be None if and only if artist.get_figure(root=True) is None In many cases we are just accessing an attribute on the figure, which for a subfigure is the same as its parent, and therefore the same as the root. matplotlib/lib/matplotlib/figure.py Lines 2290 to 2297 in 830361d self._axstack = parent._axstack self.subplotpars = parent.subplotpars self.dpi_scale_trans = parent.dpi_scale_trans self._axobservers = parent._axobservers self.transFigure = parent.transFigure self.bbox_relative = Bbox.null() self._redo_transform_rel_fig() self.figbbox = self._parent.figbbox or accessing a property which returns the equivalent property of the parent matplotlib/lib/matplotlib/figure.py Lines 2310 to 2316 in 830361d @property def canvas(self): return self._parent.canvas @property def dpi(self): return self._parent.dpi or calling _get_renderer which calls _get_renderer on the parent matplotlib/lib/matplotlib/figure.py Lines 2339 to 2340 in 830361d def _get_renderer(self): return self._parent._get_renderer() For the above cases, I set root=False as that avoids the call to _parent_figure.get_figure within Artist.get_figure, so seems more efficient for most cases. matplotlib/lib/matplotlib/artist.py Lines 733 to 736 in 830361d if root and self._parent_figure is not None: return self._parent_figure.get_figure(root=True) return self._parent_figure For tests that do not involve subfigures, I left the root parameter out, because there is no ambiguity about what we are getting hold of and it would seem like unnecessary clutter. PR checklist [n/a] "closes #0000" is in the body of the PR description to link the related issue new and changed code is tested [n/a] Plotting related features are demonstrated in an example [n/a] New Features and API Changes are noted with a directive and release note [n/a] Documentation complies with general and docstring guidelines

Open Graph Description: PR summary The Artist.figure attribute is inconsistent: on most artists, it is the figure the artist is attached to, which may be a SubFigure. OTOH SubFigure.figure is always the root Figure. A l...

X Description: PR summary The Artist.figure attribute is inconsistent: on most artists, it is the figure the artist is attached to, which may be a SubFigure. OTOH SubFigure.figure is always the root Figure. A l...

Opengraph URL: https://github.com/matplotlib/matplotlib/pull/28550

X: @github

direct link

Domain: github.com

Links:

Viewport: width=device-width