FIX: make suptitle be in CL only if placed automatically

jklymak · jklymak · commit b9da1f618691 · 2018-04-23T20:58:56.000-07:00
diff --git a/lib/matplotlib/_constrained_layout.py b/lib/matplotlib/_constrained_layout.py
@@ -238,7 +238,7 @@ def do_constrained_layout(fig, renderer, h_pad, w_pad,
                 ax._poslayoutbox.constrain_left_margin(0, strength='weak')
 
     # do layout for suptitle.
-    if fig._suptitle is not None:
+    if fig._suptitle is not None and fig._suptitle._layoutbox is not None:
         sup = fig._suptitle
         bbox = invTransFig(sup.get_window_extent(renderer=renderer))
         height = bbox.y1 - bbox.y0
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -731,6 +731,11 @@ def suptitle(self, t, *, x=.5, y=.98, **kwargs):
 
         >>> fig.suptitle('This is the figure title', fontsize=12)
         """
+        manual_position = ('x' in kwargs or 'y' in kwargs)
+
+        x = kwargs.pop('x', 0.5)
+        y = kwargs.pop('y', 0.98)
+
         if ('horizontalalignment' not in kwargs) and ('ha' not in kwargs):
             kwargs['horizontalalignment'] = 'center'
         if ('verticalalignment' not in kwargs) and ('va' not in kwargs):
@@ -751,17 +756,22 @@ def suptitle(self, t, *, x=.5, y=.98, **kwargs):
         else:
             self._suptitle = sup
             if self._layoutbox is not None:
-                figlb = self._layoutbox
-                self._suptitle._layoutbox = layoutbox.LayoutBox(
-                                                parent=figlb,
+                if not manual_position:
+                    figlb = self._layoutbox
+                    self._suptitle._layoutbox = \
+                            layoutbox.LayoutBox(parent=figlb,
                                                 name=figlb.name+'.suptitle')
-                for child in figlb.children:
-                    if not (child == self._suptitle._layoutbox):
-                        w_pad, h_pad, wspace, hspace =  \
-                                self.get_constrained_layout_pads(
-                                        relative=True)
-                        layoutbox.vstack([self._suptitle._layoutbox, child],
-                                         padding=h_pad*2., strength='required')
+                    for child in figlb.children:
+                        if not (child == self._suptitle._layoutbox):
+                            w_pad, h_pad, wspace, hspace =  \
+                                    self.get_constrained_layout_pads(
+                                            relative=True)
+                            layoutbox.vstack([self._suptitle._layoutbox,
+                                                child],
+                                                padding=h_pad*2.,
+                                                strength='required')
+                else:
+                    self._suptitle._layoutbox = None
         self.stale = True
         return self._suptitle
 
