matplotlib · QuLogic · Apr 23, 2025 · Oct 24, 2023 · Oct 24, 2023 · Oct 24, 2023
diff --git a/doc/users/next_whats_new/subplots_adjust.rst b/doc/users/next_whats_new/subplots_adjust.rst
@@ -0,0 +1,10 @@
+Resetting the subplot parameters for figure.clear()
+---------------------------------------------------
+
+When calling `.Figure.clear()` the settings for `.gridspec.SubplotParams` are restored to the default values.
+
+The `.gridspec.SubplotParams` object has a new get method :meth:`~.SubplotParams.get_subplot_params` and a
+method to reset the parameters to the defaults :meth:`~.SubplotParams.reset`
+
+
+(contributed by @eendebakpt based on work by @fredrik-1)
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -989,6 +989,7 @@ def clear(self, keep_observers=False):
        self.texts = []
        self.images = []
        self.legends = []
+        self.subplotpars.reset()
        if not keep_observers:
            self._axobservers = cbook.CallbackRegistry()
        self._suptitle = None

diff --git a/lib/matplotlib/gridspec.py b/lib/matplotlib/gridspec.py
@@ -9,7 +9,7 @@
 methods like `~.pyplot.subplots`, `~.pyplot.subplot_mosaic` and
 `~.Figure.subfigures`. See the tutorial :ref:`arranging_axes` for a guide.
 """
-
+from typing import Any
 import copy
 import logging
 from numbers import Integral
@@ -740,29 +740,36 @@ def __init__(self, left=None, bottom=None, right=None, top=None,

        Parameters
        ----------
-        left : float
+        left : float, optional
            The position of the left edge of the subplots,
            as a fraction of the figure width.
-        right : float
+        right : float, optional
            The position of the right edge of the subplots,
            as a fraction of the figure width.
-        bottom : float
+        bottom : float, optional
            The position of the bottom edge of the subplots,
            as a fraction of the figure height.
-        top : float
+        top : float, optional
            The position of the top edge of the subplots,
            as a fraction of the figure height.
-        wspace : float
+        wspace : float, optional
            The width of the padding between subplots,
            as a fraction of the average Axes width.
-        hspace : float
+        hspace : float, optional
            The height of the padding between subplots,
            as a fraction of the average Axes height.
        """
        for key in ["left", "bottom", "right", "top", "wspace", "hspace"]:
            setattr(self, key, mpl.rcParams[f"figure.subplot.{key}"])
        self.update(left, bottom, right, top, wspace, hspace)

+    def _repr_pretty_(self, p: Any, cycle: bool) -> None:
+        del cycle
+        name = self.__class__.__name__
+        s = f"{name}(left={self.left}, bottom={self.bottom}, right={self.right}, "
+        s += f" top={self.top}, wspace={self.wspace}, hspace={self.hspace})"
+        p.text(s)
+
    def update(self, left=None, bottom=None, right=None, top=None,
               wspace=None, hspace=None):
        """
@@ -774,15 +781,23 @@ def update(self, left=None, bottom=None, right=None, top=None,
        if ((bottom if bottom is not None else self.bottom)
                >= (top if top is not None else self.top)):
            raise ValueError('bottom cannot be >= top')
-        if left is not None:
-            self.left = left
-        if right is not None:
-            self.right = right
-        if bottom is not None:
-            self.bottom = bottom
-        if top is not None:
-            self.top = top
-        if wspace is not None:
-            self.wspace = wspace
-        if hspace is not None:
-            self.hspace = hspace
+
+        attributes = {'left': left, 'right': right, 'bottom': bottom, 'top': top,
+                          'hspace': hspace, 'wspace': wspace}
+        for key, value in attributes.items():
+            if value is not None:
+                setattr(self, key, value)
+
+    def reset(self):
+        """Restore the positioning parameters to the default values"""
+        for key in self.get_subplot_params().keys():
+            setattr(self, key, mpl.rcParams[f'figure.subplot.{key}'])
+
+    def get_subplot_params(self) -> dict[str, float]:
+        """
+        Returns
+        -------
+        subplot_params : dictionary
+            A dictionary with the subplot parameters
+        """
+        return self.__dict__.copy()
diff --git a/lib/matplotlib/gridspec.pyi b/lib/matplotlib/gridspec.pyi
@@ -158,3 +158,7 @@ class SubplotParams:
        wspace: float | None = ...,
        hspace: float | None = ...,
    ) -> None: ...
+    def get_subplot_params(
+        self,
+    ) -> dict[str, float]: ...
+    def reset(self) -> None: ...
diff --git a/lib/matplotlib/tests/test_figure.py b/lib/matplotlib/tests/test_figure.py
@@ -1770,6 +1770,44 @@ def test_warn_colorbar_mismatch():
        subfig3_1.colorbar(im4_1)


+def test_clf_subplotpars():
+    keys = ('left', 'right', 'bottom', 'top', 'wspace', 'hspace')
+    rc_params = {key: plt.rcParams['figure.subplot.'+key] for key in keys}
+
+    fig = plt.figure(1)
+    fig.subplots_adjust(left=0.1)
+    fig.clf()
+    assert fig.subplotpars.get_subplot_params() == rc_params
+
+
+def test_suplots_adjust_1():
+    fig = plt.figure(1)
+    wspace = 0
+    fig.subplots_adjust(wspace=wspace)
+    inDict = dict(left=0.1, right=0.7, bottom=0, top=0.9, hspace=0.05)
+    fig.subplots_adjust(**inDict)
+    inDict['wspace'] = wspace
+    assert fig.subplotpars.get_subplot_params() == inDict
+
+
+def test_suplots_adjust_2():
+    fig = plt.figure(1)
+    fig.subplots_adjust(wspace=0)
+    inDict = dict(left=0.1, right=0.7, bottom=0, top=0.9, hspace=0.05)
+    fig.subplots_adjust(**inDict)
+    inDict['wspace'] = plt.rcParams['figure.subplot.wspace']
+    assert fig.subplotpars.get_subplot_params() == inDict
+
+
+def test_suplots_adjust_plt():
+    plt.figure(1)
+    plt.subplots_adjust(wspace=0)
+    inDict = dict(left=0.1, right=0.7, bottom=0, top=0.9, hspace=0.05)
+    plt.subplots_adjust(**inDict)
+    inDict['wspace'] = plt.rcParams['figure.subplot.wspace']
+    assert plt.gcf().subplotpars.get_subplot_params() == inDict
+
+
 def test_set_figure():
    fig = plt.figure()
    sfig1 = fig.subfigures()

diff --git a/lib/matplotlib/tests/test_gridspec.py b/lib/matplotlib/tests/test_gridspec.py
@@ -1,3 +1,5 @@
+import unittest
+import matplotlib
 import matplotlib.gridspec as gridspec
 import matplotlib.pyplot as plt
 import pytest
@@ -9,6 +11,16 @@ def test_equal():
    assert gs[:, 0] == gs[:, 0]


+def test_update():
+    gs = gridspec.GridSpec(2, 1)
+
+    gs.update(left=.1)
+    assert gs.left == .1
+
+    with pytest.raises(AttributeError):
+        gs.update(lleft=.1)
+
+
 def test_width_ratios():
    """
    Addresses issue #5835.
@@ -27,6 +39,22 @@ def test_height_ratios():
        gridspec.GridSpec(1, 1, height_ratios=[2, 1, 3])


+def test_SubplotParams():
+    s = gridspec.SubplotParams(.1, .1, .9, .9)
+    assert s.left == 0.1
+
+    with pytest.raises(ValueError):
+        s.update(left=s.right + .01)
+
+    with pytest.raises(ValueError):
+        s.update(bottom=s.top + .01)
+
+    with pytest.raises(ValueError):
+        s = gridspec.SubplotParams(.1, .1, .09, .9)
+
+    s.reset()
+    assert s.left == matplotlib.rcParams['figure.subplot.left']
+
 def test_repr():
    ss = gridspec.GridSpec(3, 3)[2, 1:3]
    assert repr(ss) == "GridSpec(3, 3)[2:3, 1:3]"
@@ -48,3 +76,8 @@ def test_subplotspec_args():
        gs = gridspec.GridSpecFromSubplotSpec(2, 1, subplot_spec=axs[0])
    with pytest.raises(TypeError, match="subplot_spec must be type SubplotSpec"):
        gs = gridspec.GridSpecFromSubplotSpec(2, 1, subplot_spec=axs)
+
+    s = gridspec.SubplotParams(.1, .1, .9, .9)
+    p = unittest.mock.MagicMock()
+    s._repr_pretty_(p, False)
+    assert 'SubplotParams' in p.method_calls[0].args[0]