Skip to content

FIX: stale root Figure when adding/updating subfigures #28397

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

Merged
tacaswell merged 1 commit into from
Jun 26, 2024
Merged

FIX: stale root Figure when adding/updating subfigures #28397

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
2 changes: 2 additions & 0 deletions lib/matplotlib/figure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1636,6 +1636,8 @@ def add_subfigure(self, subplotspec, **kwargs):
sf = SubFigure(self, subplotspec, **kwargs)
self.subfigs += [sf]
sf._remove_method = self.subfigs.remove
sf.stale_callback = _stale_figure_callback
self.stale = True
return sf

def sca(self, a):
Expand Down
24 changes: 24 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 @@ -1741,3 +1741,27 @@ def test_subfigure_row_order():
sf_arr = fig.subfigures(4, 3)
for a, b in zip(sf_arr.ravel(), fig.subfigs):
assert a is b


def test_subfigure_stale_propagation():
fig = plt.figure()

fig.draw_without_rendering()
assert not fig.stale

sfig1 = fig.subfigures()
assert fig.stale

fig.draw_without_rendering()
assert not fig.stale
assert not sfig1.stale

sfig2 = sfig1.subfigures()
assert fig.stale

fig.draw_without_rendering()
assert not fig.stale
assert not sfig2.stale

sfig2.stale = True
assert fig.stale