Skip to content

Check if the mappable is in a different Figure than the one fig.color… #27458

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
merged 16 commits into from
Dec 20, 2023
Merged

Check if the mappable is in a different Figure than the one fig.color… #27458

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
d6b6504
Check if the mappable is in a different Figure than the one fig.color…
zoehcycy Dec 7, 2023
c7aac68
Add figure repr in warning message.
zoehcycy Dec 7, 2023
9339a19
Use _api.warn_external instead of _log.warning. Only warn when the mi…
zoehcycy Dec 7, 2023
ba97ec5
Delete test_colorbar::test_colorbar_wrong_figure.
zoehcycy Dec 7, 2023
742cd00
Warn in all mismatches, inferred or not.
zoehcycy Dec 8, 2023
78bce33
Revert deletion of test_colorbar_wrong_figure, with warning test.
zoehcycy Dec 8, 2023
10422fd
Linting fixes
zoehcycy Dec 8, 2023
3cbc90a
Catch newly added warning raised in other test cases.
zoehcycy Dec 8, 2023
2defbed
Catch warning in existing test cases.
zoehcycy Dec 8, 2023
c603a4b
edge case: subfigure. only warn when top level artist don't match.
zoehcycy Dec 8, 2023
c1d19ec
flake8 code style check fix
zoehcycy Dec 8, 2023
c14bf18
code style fix.
zoehcycy Dec 8, 2023
1c27ec1
subfigure test cases revert: no warning.
zoehcycy Dec 8, 2023
6308cb6
Fix edge case: axes.remove(); passing correct pcolormesh object in g…
zoehcycy Dec 8, 2023
ecddddd
remove redundant lines
zoehcycy Dec 14, 2023
998a924
code stylistic fix
zoehcycy Dec 20, 2023
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
4 changes: 2 additions & 2 deletions galleries/users_explain/axes/colorbar_placement.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
fig, axs = plt.subplots(2, 1, figsize=(4, 5), sharex=True)
X = np.random.randn(20, 20)
axs[0].plot(np.sum(X, axis=0))
axs[1].pcolormesh(X)
pcm = axs[1].pcolormesh(X)
fig.colorbar(pcm, ax=axs[1], shrink=0.6)

# %%
Expand All @@ -63,7 +63,7 @@

fig, axs = plt.subplots(2, 1, figsize=(4, 5), sharex=True, layout='constrained')
axs[0].plot(np.sum(X, axis=0))
axs[1].pcolormesh(X)
pcm = axs[1].pcolormesh(X)
fig.colorbar(pcm, ax=axs[1], shrink=0.6)

# %%
Expand Down
13 changes: 13 additions & 0 deletions lib/matplotlib/figure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1242,6 +1242,19 @@ def colorbar(
fig.sca(current_ax)
cax.grid(visible=False, which='both', axis='both')

if hasattr(mappable, "figure") and mappable.figure is not None:
# Get top level artists
mappable_host_fig = mappable.figure
if isinstance(mappable_host_fig, mpl.figure.SubFigure):
mappable_host_fig = mappable_host_fig.figure
# Warn in case of mismatch
if mappable_host_fig is not self.figure:
_api.warn_external(
f'Adding colorbar to a different Figure '
f'{repr(mappable.figure)} than '
f'{repr(self.figure)} which '
f'fig.colorbar is called on.')

NON_COLORBAR_KEYS = [ # remove kws that cannot be passed to Colorbar
'fraction', 'pad', 'shrink', 'aspect', 'anchor', 'panchor']
cb = cbar.Colorbar(cax, mappable, **{
Expand Down
3 changes: 2 additions & 1 deletion lib/matplotlib/tests/test_colorbar.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1228,7 +1228,8 @@ def test_colorbar_wrong_figure():
im = fig_cl.add_subplot().imshow([[0, 1]])
# Make sure this doesn't try to setup a gridspec-controlled colorbar on fig_cl,
# which would crash CL.
fig_tl.colorbar(im)
with pytest.warns(UserWarning, match="different Figure"):
fig_tl.colorbar(im)
fig_tl.draw_without_rendering()
fig_cl.draw_without_rendering()

Expand Down
37 changes: 36 additions & 1 deletion lib/matplotlib/tests/test_figure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1358,7 +1358,6 @@ def test_subfigure_double():
ax.set_xlabel('x-label', fontsize=fontsize)
ax.set_ylabel('y-label', fontsize=fontsize)
ax.set_title('Title', fontsize=fontsize)

subfigsnest[0].colorbar(pc, ax=axsnest0)

subfigsnest[1].suptitle('subfigsnest[1]')
Expand Down Expand Up @@ -1665,3 +1664,39 @@ def test_not_visible_figure():
fig.savefig(buf, format='svg')
buf.seek(0)
assert '<g ' not in buf.read()


def test_warn_colorbar_mismatch():
fig1, ax1 = plt.subplots()
fig2, (ax2_1, ax2_2) = plt.subplots(2)
im = ax1.imshow([[1, 2], [3, 4]])

fig1.colorbar(im) # should not warn
with pytest.warns(UserWarning, match="different Figure"):
fig2.colorbar(im)
# warn mismatch even when the host figure is not inferred
with pytest.warns(UserWarning, match="different Figure"):
fig2.colorbar(im, ax=ax1)
with pytest.warns(UserWarning, match="different Figure"):
fig2.colorbar(im, ax=ax2_1)
with pytest.warns(UserWarning, match="different Figure"):
fig2.colorbar(im, cax=ax2_2)

# edge case: only compare top level artist in case of subfigure
fig3 = plt.figure()
fig4 = plt.figure()
subfig3_1 = fig3.subfigures()
subfig3_2 = fig3.subfigures()
subfig4_1 = fig4.subfigures()
ax3_1 = subfig3_1.subplots()
ax3_2 = subfig3_1.subplots()
ax4_1 = subfig4_1.subplots()
im3_1 = ax3_1.imshow([[1, 2], [3, 4]])
im3_2 = ax3_2.imshow([[1, 2], [3, 4]])
im4_1 = ax4_1.imshow([[1, 2], [3, 4]])

fig3.colorbar(im3_1) # should not warn
subfig3_1.colorbar(im3_1) # should not warn
subfig3_1.colorbar(im3_2) # should not warn
with pytest.warns(UserWarning, match="different Figure"):
subfig3_1.colorbar(im4_1)