FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

FIX: adjust_bbox should not modify layout engine by rcomer · Pull Request #24971 · matplotlib/matplotlib · GitHub

  1. matplotlib
  2. matplotlib

Repository navigation

FIX: adjust_bbox should not modify layout engine - #24971

Merged
tacaswell merged 1 commit into
matplotlib:mainfrom
rcomer:adjust_bbox-layout-engine
Jan 13, 2023
ConversationCommits (1)ChecksFiles changed
Merged

FIX: adjust_bbox should not modify layout engine#24971
tacaswell merged 1 commit into
matplotlib:mainfrom
rcomer:adjust_bbox-layout-engine

Conversation

rcomer commented Jan 13, 2023 •
edited
Loading

Copy link
Copy Markdown
Member

PR Summary

Fixes #24954 (I think!) I don't claim to fully understand everything that's going on here, but it seems to me that these lines are doing the same job as

matplotlib/lib/matplotlib/backend_bases.py

Lines 2356 to 2357 in 018c5ef

# we have already done layout above, so turn it off:
stack.enter_context(self.figure._cm_set(layout_engine='none'))

Since restore_bbox gets called within the above context manager, the final result is the layout engine continues to be what was set with fig.set_layout_engine(None).

PR Checklist

Documentation and Tests

  • Has pytest style unit tests (and pytest passes)
  • [N/A] Documentation is sphinx and numpydoc compliant (the docs should build 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 in doc/users/next_whats_new/
  • [N/A] API changes are marked with a .. versionchanged:: directive in the docstring and documented in doc/api/next_api_changes/
  • [N/A] Release notes conform with instructions in next_whats_new/README.rst or next_api_changes/README.rst

rcomer force-pushed the adjust_bbox-layout-engine branch from 6e4153c to e93b150 Compare January 13, 2023 14:56
rcomer force-pushed the adjust_bbox-layout-engine branch from e93b150 to 3c28528 Compare January 13, 2023 15:12
jklymak reviewed Jan 13, 2023
View reviewed changes
Comment thread lib/matplotlib/tests/test_figure.py
assert ratio1 == ratio2


def test_savefig_preserve_layout_engine(tmp_path):

jklymak Jan 13, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

This worked before didn't it? It was when the rcParam was set that the problem was? Or was the layout still getting set to None, and then falling back to the rcParam?

Otherwise if this works, I'm all for it! I do wish all the context switching were simpler to debug, but...

rcomer Jan 13, 2023

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

On main this test throws an AttributeError because the layout engine got set to None. If we set the rcParam then we would get an assertion error on main. I'm happy to test either or both.

tacaswell added this to the v3.7.0 milestone Jan 13, 2023
tacaswell merged commit 235b01f into matplotlib:main Jan 13, 2023
meeseeksmachine mentioned this pull request Jan 13, 2023
Merged
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Jan 13, 2023
Backport PR matplotlib#24971: FIX: adjust_bbox should not modify layo…
11fdbbd 
…ut engine

jklymak commented Jan 13, 2023

Copy link
Copy Markdown
Member

Thanks for tracking this down @rcomer ! Great detective work....

rcomer commented Jan 13, 2023

Copy link
Copy Markdown
Member Author

@jklymak thanks to you and @QuLogic for pointing me in the right direction!

oscargus added a commit that referenced this pull request Jan 13, 2023
Merge pull request #24975 from meeseeksmachine/auto-backport-of-pr-24…
d13a5cd 
…971-on-v3.7.x

Backport PR #24971 on branch v3.7.x (FIX: adjust_bbox should not modify layout engine)
rcomer deleted the adjust_bbox-layout-engine branch January 16, 2023 17:57
anntzer mentioned this pull request Jan 24, 2023
Merged
ksunden mentioned this pull request Feb 20, 2023
Merged
6 tasks
rcomer added the PR: bugfix Pull requests that fix identified bugs label Mar 1, 2023
rcomer mentioned this pull request Mar 19, 2023
Merged
1 task done
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

jklymak jklymak approved these changes

Assignees

No one assigned

Labels

PR: bugfix Pull requests that fix identified bugs

Projects

None yet

Milestone

v3.7.0

Development

Successfully merging this pull request may close these issues.

[Bug]: compressed layout setting can be forgotten on second save

3 participants

Back | FazBrowse Home | New Git URL