Deprecate the renderer parameter to Figure.tight_layout.

anntzer · anntzer · commit 1b7454dd4a5e · 2019-09-06T10:30:26.000+02:00
We only ever use the renderer instance cached on the Figure anyways
(except that in `Figure.draw` we need to cache it earlier).

After the parameter is removed, the signature of Figure.tight_layout
will match the one of pyplot.tight_layout and we'll be able to dedupe
the latter by just adding tight_layout to the list of functions
autogenerated by boilerplate.py.
diff --git a/doc/api/next_api_changes/2018-09-06-AL.rst b/doc/api/next_api_changes/2018-09-06-AL.rst
@@ -0,0 +1,5 @@
+Deprecations
+````````````
+
+The ``renderer`` parameter to `.Figure.tight_layout` is deprecated; this method
+now always uses the renderer instance cached on the `.Figure`.
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -1695,6 +1695,7 @@ def draw(self, renderer):
         Render the figure using :class:`matplotlib.backend_bases.RendererBase`
         instance *renderer*.
         """
+        self._cachedRenderer = renderer
 
         # draw the figure bounding box, perhaps none for white figure
         if not self.get_visible():
@@ -1729,8 +1730,7 @@ def draw(self, renderer):
                 self.execute_constrained_layout(renderer)
             if self.get_tight_layout() and self.axes:
                 try:
-                    self.tight_layout(renderer,
-                                      **self._tight_parameters)
+                    self.tight_layout(**self._tight_parameters)
                 except ValueError:
                     pass
                     # ValueError can occur when resizing a window.
@@ -1743,7 +1743,6 @@ def draw(self, renderer):
         finally:
             self.stale = False
 
-        self._cachedRenderer = renderer
         self.canvas.draw_event(renderer)
 
     def draw_artist(self, a):
@@ -2450,6 +2449,7 @@ def execute_constrained_layout(self, renderer=None):
             renderer = layoutbox.get_renderer(fig)
         do_constrained_layout(fig, renderer, h_pad, w_pad, hspace, wspace)
 
+    @cbook._delete_parameter("3.2", "renderer")
     def tight_layout(self, renderer=None, pad=1.08, h_pad=None, w_pad=None,
                      rect=None):
         """
@@ -2462,8 +2462,7 @@ def tight_layout(self, renderer=None, pad=1.08, h_pad=None, w_pad=None,
         Parameters
         ----------
         renderer : subclass of `~.backend_bases.RendererBase`, optional
-            Defaults to the renderer for the figure.
-
+            Defaults to the renderer for the figure.  Deprecated.
         pad : float, optional
             Padding between the figure edge and the edges of subplots,
             as a fraction of the font size.
