Merge pull request #24528 from j1642/warn-if-tight-layout

dstansby · web-flow · commit aa4af14fe8e5 · 2022-12-07T10:36:25.000Z
BUG: Warn when an existing layout manager changes to tight layout
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -3434,8 +3434,12 @@ def tight_layout(self, *, pad=1.08, h_pad=None, w_pad=None, rect=None):
         engine = TightLayoutEngine(pad=pad, h_pad=h_pad, w_pad=w_pad,
                                    rect=rect)
         try:
+            previous_engine = self.get_layout_engine()
             self.set_layout_engine(engine)
             engine.execute(self)
+            if not isinstance(previous_engine, TightLayoutEngine) \
+                    and previous_engine is not None:
+                _api.warn_external('The figure layout has changed to tight')
         finally:
             self.set_layout_engine(None)
 
diff --git a/lib/matplotlib/tests/test_figure.py b/lib/matplotlib/tests/test_figure.py
@@ -603,6 +603,17 @@ def test_invalid_layouts():
         fig.set_layout_engine("constrained")
 
 
+@pytest.mark.parametrize('layout', ['constrained', 'compressed'])
+def test_layout_change_warning(layout):
+    """
+    Raise a warning when a previously assigned layout changes to tight using
+    plt.tight_layout().
+    """
+    fig, ax = plt.subplots(layout=layout)
+    with pytest.warns(UserWarning, match='The figure layout has changed to'):
+        plt.tight_layout()
+
+
 @check_figures_equal(extensions=["png", "pdf"])
 def test_add_artist(fig_test, fig_ref):
     fig_test.dpi = 100
