Deprecate Figure.frameon.

anntzer · anntzer · commit dca5207cd458 · 2018-07-23T02:44:25.000+02:00
Directly manipulating the visibility of Figure.patch is just as good.
diff --git a/doc/users/next_whats_new/2018-07-18-AL-deprecations.rst b/doc/users/next_whats_new/2018-07-18-AL-deprecations.rst
@@ -0,0 +1,7 @@
+Deprecations
+````````````
+
+The following API elements are deprecated:
+
+- ``Figure.frameon``, ``Figure.get_frameon``, ``Figure.set_frameon`` (directly
+  manipulate the visibility of ``Figure.patch`` instead),
diff --git a/doc/users/whats_new.rst b/doc/users/whats_new.rst
@@ -15,12 +15,13 @@ revision, see the :ref:`github-stats`.
    For a release, add a new section after this, then comment out the include
    and toctree below by indenting them. Uncomment them after the release.
 
-  .. include:: next_whats_new/README.rst
-   .. toctree::
-      :glob:
-      :maxdepth: 1
+.. include:: next_whats_new/README.rst
 
-      next_whats_new/*
+.. toctree::
+   :glob:
+   :maxdepth: 1
+
+   next_whats_new/*
 
 Ability to scale axis by a fixed order of magnitude
 ---------------------------------------------------
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -360,13 +360,12 @@ def __init__(self,
         self._dpi = dpi
         self.bbox = TransformedBbox(self.bbox_inches, self.dpi_scale_trans)
 
-        self.frameon = frameon
-
         self.transFigure = BboxTransformTo(self.bbox)
 
         self.patch = Rectangle(
             xy=(0, 0), width=1, height=1,
-            facecolor=facecolor, edgecolor=edgecolor, linewidth=linewidth)
+            facecolor=facecolor, edgecolor=edgecolor, linewidth=linewidth,
+            visible=frameon)
         self._set_artist_props(self.patch)
         self.patch.set_aa(False)
 
@@ -649,15 +648,14 @@ def autofmt_xdate(self, bottom=0.2, rotation=30, ha='right', which=None):
 
     def get_children(self):
         """Get a list of artists contained in the figure."""
-        children = [self.patch]
-        children.extend(self.artists)
-        children.extend(self.axes)
-        children.extend(self.lines)
-        children.extend(self.patches)
-        children.extend(self.texts)
-        children.extend(self.images)
-        children.extend(self.legends)
-        return children
+        return [self.patch,
+                *self.artists,
+                *self.axes,
+                *self.lines,
+                *self.patches,
+                *self.texts,
+                *self.images,
+                *self.legends]
 
     def contains(self, mouseevent):
         """
@@ -946,9 +944,10 @@ def get_dpi(self):
         """Return the resolution in dots per inch as a float."""
         return self.dpi
 
+    @cbook.deprecated("3.1", alternative="figure.patch.get_visible")
     def get_frameon(self):
         """Return whether the figure frame will be drawn."""
-        return self.frameon
+        return self.patch.get_visible()
 
     def set_edgecolor(self, color):
         """
@@ -997,6 +996,7 @@ def set_figheight(self, val, forward=True):
         """
         self.set_size_inches(self.get_figwidth(), val, forward=forward)
 
+    @cbook.deprecated("3.1", alternative="figure.patch.set_visible")
     def set_frameon(self, b):
         """
         Set whether the figure frame (background) is displayed or invisible.
@@ -1005,9 +1005,11 @@ def set_frameon(self, b):
         ----------
         b : bool
         """
-        self.frameon = b
+        self.patch.set_visible(b)
         self.stale = True
 
+    frameon = property(get_frameon, set_frameon)
+
     def delaxes(self, ax):
         """
         Remove the `~matplotlib.axes.Axes` *ax* from the figure and update the
@@ -1590,11 +1592,10 @@ def draw(self, renderer):
         if not self.get_visible():
             return
 
+        artists = self.get_children()
+        artists.remove(self.patch)
         artists = sorted(
-            (artist for artist in (self.patches + self.lines + self.artists
-                                   + self.images + self.axes + self.texts
-                                   + self.legends)
-             if not artist.get_animated()),
+            (artist for artist in artists if not artist.get_animated()),
             key=lambda artist: artist.get_zorder())
 
         try:
@@ -1609,9 +1610,7 @@ def draw(self, renderer):
                     pass
                     # ValueError can occur when resizing a window.
 
-            if self.frameon:
-                self.patch.draw(renderer)
-
+            self.patch.draw(renderer)
             mimage._draw_list_compositing_images(
                 renderer, self, artists, self.suppressComposite)
 
@@ -2045,13 +2044,13 @@ def savefig(self, fname, *, frameon=None, transparent=None, **kwargs):
             kwargs.setdefault('edgecolor', rcParams['savefig.edgecolor'])
 
         if frameon:
-            original_frameon = self.get_frameon()
-            self.set_frameon(frameon)
+            original_frameon = self.patch.get_visible()
+            self.patch.set_visible(frameon)
 
         self.canvas.print_figure(fname, **kwargs)
 
         if frameon:
-            self.set_frameon(original_frameon)
+            self.patch.set_visible(original_frameon)
 
         if transparent:
             for ax, cc in zip(self.axes, original_axes_colors):
