Skip to content

Fix SubFigure wspace/hspace None defaulting to subplot rc spacing #32080

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Fstarnb wants to merge 1 commit into
base: main
Choose a base branch
from
+65 −0
Open

Fix SubFigure wspace/hspace None defaulting to subplot rc spacing #32080

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions lib/matplotlib/figure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1648,6 +1648,15 @@ def subfigures(self, nrows=1, ncols=1, squeeze=True,
relative height of ``height_ratios[i] / sum(height_ratios)``.
If not given, all rows will have the same height.
"""
# Without a layout engine, unspecified spacing is documented as zero.
# GridSpec falls back to figure.subplot.{w,h}space (rc default 0.2)
# when given None, so coerce missing values here (issue #32076).
if self.get_layout_engine() is None:
if wspace is None:
wspace = 0.0
if hspace is None:
hspace = 0.0

gs = GridSpec(nrows=nrows, ncols=ncols, figure=self,
wspace=wspace, hspace=hspace,
width_ratios=width_ratios,
Expand Down
56 changes: 56 additions & 0 deletions lib/matplotlib/tests/test_figure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1569,6 +1569,62 @@ def test_subfigures_wspace_hspace():
np.testing.assert_allclose(sub_figs[1, 2].bbox.max, [w, h * 0.4])


def test_subfigures_partial_spacing_none_is_zero():
"""Unspecified wspace/hspace is zero when no layout engine is active.

Regression for #32076: passing only one of wspace/hspace used to fall
back to figure.subplot.* rc defaults (0.2) for the unspecified axis.
"""
fig = plt.figure(figsize=(6, 4), dpi=100)
# Both None: no spacing (tile the figure).
sfs = fig.subfigures(2, 2, wspace=None, hspace=None)
for row in sfs:
for sf in row:
sf.add_subplot().plot([0, 1], [0, 1])
fig.canvas.draw()
# Display coords at dpi=100, figsize 6x4 → 600x400.
np.testing.assert_allclose(sfs[0, 0].bbox.bounds, [0.0, 200.0, 300.0, 200.0])
np.testing.assert_allclose(sfs[0, 1].bbox.bounds, [300.0, 200.0, 300.0, 200.0])
np.testing.assert_allclose(sfs[1, 0].bbox.bounds, [0.0, 0.0, 300.0, 200.0])
np.testing.assert_allclose(sfs[1, 1].bbox.bounds, [300.0, 0.0, 300.0, 200.0])
plt.close(fig)

fig = plt.figure(figsize=(6, 4), dpi=100)
# Only wspace set: horizontal gap, no vertical gap.
sfs = fig.subfigures(2, 2, wspace=0.2, hspace=None)
for row in sfs:
for sf in row:
sf.add_subplot().plot([0, 1], [0, 1])
fig.canvas.draw()
# cell_w = 1 / (2 + 0.2) = 1/2.2; sep = 0.2/2.2
cell = 1 / 2.2
sep = 0.2 * cell
w_px, h_px = 600.0, 400.0
np.testing.assert_allclose(
sfs[0, 0].bbox.bounds, [0.0, h_px / 2, cell * w_px, h_px / 2], rtol=1e-5)
np.testing.assert_allclose(
sfs[0, 1].bbox.bounds,
[(cell + sep) * w_px, h_px / 2, cell * w_px, h_px / 2], rtol=1e-5)
np.testing.assert_allclose(
sfs[1, 0].bbox.bounds, [0.0, 0.0, cell * w_px, h_px / 2], rtol=1e-5)
# Heights must be half the figure (no vertical spacing).
assert sfs[0, 0].bbox.height == pytest.approx(h_px / 2)
assert sfs[1, 0].bbox.y1 == pytest.approx(sfs[0, 0].bbox.y0)
plt.close(fig)

fig = plt.figure(figsize=(6, 4), dpi=100)
# Only hspace set: vertical gap, no horizontal gap.
sfs = fig.subfigures(2, 2, wspace=None, hspace=0.2)
for row in sfs:
for sf in row:
sf.add_subplot().plot([0, 1], [0, 1])
fig.canvas.draw()
assert sfs[0, 0].bbox.width == pytest.approx(w_px / 2)
assert sfs[0, 1].bbox.x0 == pytest.approx(sfs[0, 0].bbox.x1)
assert sfs[0, 0].bbox.height == pytest.approx(cell * h_px, rel=1e-5)
plt.close(fig)


def test_subfigure_remove():
fig = plt.figure()
sfs = fig.subfigures(2, 2)
Expand Down
Loading