FIX: revert change to signature so we can test if kwargs used

jklymak · jklymak · commit 55f22d9c967f · 2018-04-23T21:55:45.000-07:00
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -677,7 +677,7 @@ def get_window_extent(self, *args, **kwargs):
         """
         return self.bbox
 
-    def suptitle(self, t, *, x=.5, y=.98, **kwargs):
+    def suptitle(self, t, **kwargs):
         """
         Add a centered title to the figure.
 
diff --git a/lib/matplotlib/tests/test_constrainedlayout.py b/lib/matplotlib/tests/test_constrainedlayout.py
@@ -348,3 +348,44 @@ def test_constrained_layout20():
     ax = fig.add_axes([0, 0, 1, 1])
     mesh = ax.pcolormesh(gx, gx, img)
     fig.colorbar(mesh)
+
+def test_constrained_layout21():
+    '#11035: repeated calls to suptitle should not alter the layout'
+    fig, ax = plt.subplots(constrained_layout=True)
+
+    fig.suptitle(f"Suptitle #0")
+    fig.canvas.draw()
+    extents0 = np.copy(ax.get_position().extents)
+
+    fig.suptitle(f"Suptitle #1")
+    fig.canvas.draw()
+    extents1 = np.copy(ax.get_position().extents)
+
+    np.testing.assert_allclose(extents0, extents1)
+
+
+def test_constrained_layout22():
+    '#11035: suptitle should not be include in CL if manually positioned'
+    fig, ax = plt.subplots(constrained_layout=True)
+
+    fig.canvas.draw()
+    fig.canvas.draw()
+    extents0 = np.copy(ax.get_position().extents)
+
+    fig.suptitle(f"Suptitle", y=0.5)
+    fig.canvas.draw()
+    fig.canvas.draw()
+    extents1 = np.copy(ax.get_position().extents)
+
+    np.testing.assert_allclose(extents0, extents1)
+
+
+def test_constrained_layout23():
+    '''
+    Comment in #11035: suptitle used to cause an exception when
+    reusing a figure w/ CL with ``clear=True``.
+    '''
+
+    for i in range(2):
+        fig, ax = plt.subplots(num="123", constrained_layout=True, clear=True)
+        fig.suptitle(f"Suptitle {i}".format(i))
