ENH: change inbbox to in_layout and add setters/getters

jklymak · jklymak · commit 7e5a28e6de67 · 2018-04-30T13:45:24.000-07:00
diff --git a/doc/api/next_api_changes/2018-04-29-JMK.rst b/doc/api/next_api_changes/2018-04-29-JMK.rst
@@ -17,5 +17,5 @@ is to make the artist a child of the figure, not the axes.  i.e. calling
 `~.matplotlib.Axes.get_legend_handles_labels` to gather handles and labels
 from the parent axes).
 
-The second way is to set the artist property ``artist.inbbox`` to ``False`` to
-make the artist not be included in the bounding box calculation.   
+The second way is to set the artist property ``artist.set_in_layout(False)``
+to make the artist not be included in the bounding box calculation.   
diff --git a/lib/matplotlib/artist.py b/lib/matplotlib/artist.py
@@ -119,7 +119,7 @@ def __init__(self):
         self._sketch = rcParams['path.sketch']
         self._path_effects = rcParams['path.effects']
         self._sticky_edges = _XYPair([], [])
-        self.inbbox = True
+        self._in_layout = True
 
     def __getstate__(self):
         d = self.__dict__.copy()
@@ -743,6 +743,14 @@ def get_animated(self):
         "Return the artist's animated state"
         return self._animated
 
+    def get_in_layout(self):
+        """"
+        Return if artist is to be included in layout calculations
+        like `.Figure.tight_layout` and constrained layout.  Also
+        for ``fig.savefig(fname, bbox_inches='tight').
+        """
+        return self._in_layout
+
     def get_clip_on(self):
         'Return whether artist uses clipping'
         return self._clipon
@@ -878,6 +886,18 @@ def set_animated(self, b):
             self._animated = b
             self.pchanged()
 
+    def set_in_layout(in_layout):
+        """"
+        Set if artist is to be included in layout calculations
+        like `.Figure.tight_layout` and constrained layout.  Also
+        for ``fig.savefig(fname, bbox_inches='tight').
+
+        Parameters
+        ----------
+        in_layout : bool
+        """
+        self._in_layout = in_layout
+
     def update(self, props):
         """
         Update this artist's properties from the dictionary *prop*.
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -4099,18 +4099,18 @@ def get_default_bbox_extra_artists(self):
         """
         Return a default list of artists that are used for the bounding box
         calculation.  Artists are excluded either by not being visible
-        or ``artist.inbbox = False``.
+        or ``artist.set_in_layout(False)``.
         """
         return [artist for artist in self.get_children()
-                if (artist.get_visible() and artist.inbbox)]
+                if (artist.get_visible() and artist.get_in_layout())]
 
     def get_tightbbox(self, renderer, call_axes_locator=True,
             bbox_extra_artists=None):
         """
         Return the tight bounding box of the axes, including axis and their
         decorators (xlabel, title, etc).
 
-        Artists that have ``artist.inbbox = False`` are not included
+        Artists that have ``artist.set_in_layout(False)`` are not included
         in the bbox.
 
         Parameters
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -1990,7 +1990,7 @@ def waitforbuttonpress(self, timeout=-1):
 
     def get_default_bbox_extra_artists(self):
         bbox_artists = [artist for artist in self.get_children()
-                        if (artist.get_visible() and artist.inbbox)]
+                        if (artist.get_visible() and artist.get_in_layout())]
         for ax in self.axes:
             if ax.get_visible():
                 bbox_artists.extend(ax.get_default_bbox_extra_artists())
diff --git a/lib/matplotlib/tests/test_figure.py b/lib/matplotlib/tests/test_figure.py
@@ -399,12 +399,12 @@ def test_tightbbox():
     assert np.abs(fig.get_tightbbox(renderer).x0 - 0.679) < 0.05
     # now exclude t from the tight bbox so now the bbox is quite a bit
     # smaller
-    t.inbbox = False
+    t.set_in_layout(False)
     x1Nom = 7.333
     assert np.abs(ax.get_tightbbox(renderer).x1 - x1Nom * fig.dpi) < 2
     assert np.abs(fig.get_tightbbox(renderer).x1 - x1Nom) < 0.05
 
-    t.inbbox = True
+    t.set_in_layout(True)
     x1Nom = 7.333
     assert np.abs(ax.get_tightbbox(renderer).x1 - x1Nom0 * fig.dpi) < 2
     # test bbox_extra_artists method...
diff --git a/tutorials/intermediate/constrainedlayout_guide.py b/tutorials/intermediate/constrainedlayout_guide.py
@@ -185,22 +185,22 @@ def example_plot(ax, fontsize=12, nodec=False):
 
 #############################################
 # In order for a legend or other artist to *not* steal space
-# from the subplot layout, it can have its ``inbbox`` property
-# set to ``False``.  Of course this can mean the legend ends up
+# from the subplot layout, we can ``leg.set_in_layout(False)``.
+# Of course this can mean the legend ends up
 # cropped, but can be useful if the plot is subsequently called
 # with ``fig.savefig('outname.png', bbox_inches='tight')``.  Note,
-# however, that the legend's inbbox status will have to be
+# however, that the legend's ``get_in_layout`` status will have to be
 # toggled again to make the saved file work:
 
 fig, axs = plt.subplots(2, 2, constrained_layout=True)
 for ax in axs.flatten()[:-1]:
     ax.plot(np.arange(10))
 axs[1, 1].plot(np.arange(10), label='This is a plot')
 leg = axs[1, 1].legend(loc='center left', bbox_to_anchor=(0.8, 0.5))
-leg.inbbox = False
+leg.set_in_layout(False)
 wanttoprint = False
 if wanttoprint:
-    leg.inbbox = True
+    leg.set_in_layout(True)
     fig.do_constrained_layout(False)
     fig.savefig('outname.png', bbox_inches='tight')
 
diff --git a/tutorials/intermediate/tight_layout_guide.py b/tutorials/intermediate/tight_layout_guide.py
@@ -304,12 +304,12 @@ def example_plot(ax, fontsize=12):
 # However, sometimes this is not desired (quite often when using
 # ``fig.savefig('outname.png', bbox_inches='tight')``).  In order to
 # remove the legend from the bounding box calculation, we simply set its
-# bounding ``inbbox=False`` and the legend will be ignored.
+# bounding ``leg.set_in_layout(False)`` and the legend will be ignored.
 
 fig, ax = plt.subplots(figsize=(4, 3))
 lines = ax.plot(range(10), label='B simple plot')
 leg = ax.legend(bbox_to_anchor=(0.7, 0.5), loc='center left',)
-leg.inbbox = False
+leg.set_in_layout(False)
 fig.tight_layout()
 plt.show()
 
