Fixes#22625. The problem was that_ColorbarAxesLocator was not used to set the aspect ratio beforeadjust_bbox stripped it off. A simpler but presumably less efficient fix might be to trigger a draw before callingadjust_bbox. We already do that ifbbox_inches == "tight".

matplotlib/lib/matplotlib/backend_bases.py

Lines 2358 to 2361 in78bf53c

	iflayout_engineisnotNoneorbbox_inches=="tight":
	# we need to trigger a draw before printing to make sure
	# CL works. "tight" also needs a draw to get the right
	# locations:

PR Checklist

Documentation and Tests

Has pytest style unit tests (andpytest passes)
[N/A] Documentation is sphinx and numpydoc compliant (the docs shouldbuild without error).
[N/A] New plotting related features are documented with examples.

Release Notes

[N/A] New features are marked with a.. versionadded:: directive in the docstring and documented indoc/users/next_whats_new/
[N/A] API changes are marked with a.. versionchanged:: directive in the docstring and documented indoc/api/next_api_changes/
[N/A] Release notes conform with instructions innext_whats_new/README.rst ornext_api_changes/README.rst

rcomer added this to thev3.7.2 milestone

Mar 18, 2023

rcomer added the PR: bugfixPull requests that fix identified bugs label

Mar 18, 2023

rcomer force-pushed thecolorbar-bbox_inches branch fromf0db686 to9df8594Compare

March 18, 2023 18:36

greglucas approved these changes

Mar 19, 2023

View reviewed changes

lib/matplotlib/tests/test_figure.py Outdated

		fig, ax = plt.subplots()
		pc = ax.pcolormesh(np.random.randn(2, 2))
		cbar = fig.colorbar(pc, aspect=40)
		fig.savefig(tmp_path / 'foo.png', bbox_inches=mpl.transforms.Bbox([[0, 0], [4, 4]]))

Copy link

Contributor

greglucasMar 19, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

	fig.savefig(tmp_path/'foo.png',bbox_inches=mpl.transforms.Bbox([[0,0], [4,4]]))
	fig.savefig(io.BytesIO(),bbox_inches=mpl.transforms.Bbox([[0,0], [4,4]]))

Copy link

MemberAuthor

rcomerMar 19, 2023•
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Thanks, I didn't know you could do this but I see it is the convention through this module. So I took the liberty of also updating the test I added at#24971.

Copy link

Contributor

greglucasMar 19, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

It is likely faster to stay in memory when saving if possible rather than thrashing the hard drive, which I think is why this would be preferred.

lib/matplotlib/tests/test_figure.py

		cbar = fig.colorbar(pc, aspect=40)
		fig.savefig(tmp_path / 'foo.png', bbox_inches=mpl.transforms.Bbox([[0, 0], [4, 4]]))

		# Check that an aspect ratio has been applied.

Copy link

Contributor

greglucasMar 19, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Are you able to assert against the aspect ratio too?

Copy link

MemberAuthor

rcomerMar 19, 2023•
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I couldn't figure out how to check the aspect ratio directly.get_aspect() returns "auto" before and after save.get_box_aspect() returns 40 before and after save. Is there something else I've missed?

Copy link

Contributor

greglucasMar 19, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I didn't know either, I just figured since it was the aspect that was wrong that is better to test against, so figured I would ask if you tried :) but colorbars are never straightforward and there is still an open issue with the get/set aspect on them.#22103

Although here it could also be that the aspect is only changed in the setattr context manager while saving the figure, so you don't get it except while in that context manager?

This still looks good to me!

FIX: use locators in adjust_bbox

50aa98a

rcomer force-pushed thecolorbar-bbox_inches branch from9df8594 to50aa98aCompare

March 19, 2023 19:22

oscargus merged commit8ef978d intomatplotlib:main

Mar 20, 2023

Copy link

lumberbot-appbot commentedMar 20, 2023

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

Checkout backport branch and update it.

git checkout v3.7.xgit pull

Cherry pick the first parent branch of the this PR on top of the older branch:

git cherry-pick -x -m1 8ef978d3c3c9461cacb69bb222955c436ad65088

You will likely have some merge/cherry-pick conflict here, fix them and commit:

git commit -am 'Backport PR #25499: FIX: use locators in adjust_bbox'

Push to a named branch:

git push YOURFORK v3.7.x:auto-backport-of-pr-25499-on-v3.7.x

Create a PR against branch v3.7.x, I would have named this PR:

"Backport PR#25499 on branch v3.7.x (FIX: use locators in adjust_bbox)"

And apply the correct labels and milestones.

Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon!

Remember to remove theStill Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free tosuggest an improvement.

lumberbot-appbot added the Still Needs Manual Backport label

Mar 20, 2023

rcomer deleted the colorbar-bbox_inches branch

March 20, 2023 21:05

rcomer pushed a commit to rcomer/matplotlib that referenced this pull request

Mar 21, 2023

Backport PRmatplotlib#25499: FIX: use locators in adjust_bbox

b5e3ef8

Conflict was caused by the new test being right above the test fromFIX: use locators in adjust_bbox(cherry picked from commit8ef978d)

rcomer pushed a commit to rcomer/matplotlib that referenced this pull request

Mar 21, 2023

Backport PRmatplotlib#25499: FIX: use locators in adjust_bbox

a42649e

Conflict was caused by the new test being right above the test frommatplotlib#24816, which is not in the v3.7.x branch.FIX: use locators in adjust_bbox(cherry picked from commit8ef978d)

rcomer mentioned this pull request

Mar 21, 2023

Backport PR #25499: FIX: use locators in adjust_bbox#25520

Merged

6 tasks

rcomer removed the Still Needs Manual Backport label

Mar 21, 2023

ksunden added a commit that referenced this pull request

Mar 21, 2023

Merge pull request#25520from rcomer/backport-25499

e0de606

Backport PR#25499: FIX: use locators in adjust_bbox

rcomer mentioned this pull request

Sep 23, 2023

[Bug]: Error while creating inset axes usingmpl_toolkits.axes_grid1.inset_locator.inset_axes#26287

Closed

rcomer mentioned this pull request

Feb 9, 2024

[Bug]: colorbar doesn't register inset_axis as cax#27763

Closed

Labels

PR: bugfix

Pull requests that fix identified bugs

3 participants

Movatterモバイル変換

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

FIX: use locators in adjust_bbox#25499

FIX: use locators in adjust_bbox#25499

Uh oh!

Conversation

rcomer commentedMar 18, 2023

PR Summary

PR Checklist

Uh oh!

greglucasMar 19, 2023

Choose a reason for hiding this comment

Uh oh!

rcomerMar 19, 2023•
edited
Loading

Uh oh!

Choose a reason for hiding this comment

Uh oh!

greglucasMar 19, 2023

Choose a reason for hiding this comment

Uh oh!

greglucasMar 19, 2023

Choose a reason for hiding this comment

Uh oh!

rcomerMar 19, 2023•
edited
Loading

Uh oh!

Choose a reason for hiding this comment

Uh oh!

greglucasMar 19, 2023

Choose a reason for hiding this comment

Uh oh!

lumberbot-appbot commentedMar 20, 2023

Uh oh!

Uh oh!

Movatterモバイル変換

Uh oh!

FIX: use locators in adjust_bbox#25499

FIX: use locators in adjust_bbox#25499

Uh oh!

Conversation

rcomer commentedMar 18, 2023

PR Summary

PR Checklist

Uh oh!

greglucasMar 19, 2023

Choose a reason for hiding this comment

Uh oh!

rcomerMar 19, 2023• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

greglucasMar 19, 2023

Choose a reason for hiding this comment

Uh oh!

greglucasMar 19, 2023

Choose a reason for hiding this comment

Uh oh!

rcomerMar 19, 2023• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

greglucasMar 19, 2023

Choose a reason for hiding this comment

Uh oh!

lumberbot-appbot commentedMar 20, 2023

Uh oh!

Uh oh!

rcomerMar 19, 2023•
edited
Loading

rcomerMar 19, 2023•
edited
Loading