Make it possible to use rc_context as a decorator. #15303
Merged
Conversation
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
1de49b3 to
44b8a4b
Compare
timhoffm
approved these changes
Sep 19, 2019
|
Even with the usage pattern staying the same, is this an API change ( |
|
Well, it's noted as an API change though that specific point is not made explicit; I'm not sure going more into the technical details is going to help legibility of the changelog, but can do so if you insist. |
|
We have never publicly mentioned that So from my point of view, this does not need additional documentation. |
dstansby
reviewed
Oct 11, 2019
QuLogic
approved these changes
Mar 23, 2020
|
so good to go, then? |
|
Yes, but I don't know what's wrong with tests as the link is broken. |
See changelog note. There are also other advantages with contextmanager, e.g. reusing a context multiple times works ``` ctx = rc_context(...) with ctx: ... # in the context ... # out of the context with ctx: ... # in the context again ``` (with a test for the decorator form, which is equivalent) but in practice this will often run into the issue of early/late resolution of rcParams, so I didn't mention it in the changelog. xkcd() still needs to be implemented manually in terms of `__enter__`/`__exit__` but at least we know that creation of the contextmanager cannot fail, so things are simpler. Also we don't need to check for whether the backend has been resolved because rcParams now just prevent re-setting the backend to auto_backend_sentinel.
|
I rebased and retriggered a build. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
See changelog note.
There are also other advantages with contextmanager, e.g. reusing a
context multiple times works
(with a test for the decorator form, which is equivalent) but in
practice this will often run into the issue of early/late resolution of
rcParams, so I didn't mention it in the changelog.
xkcd() still needs to be implemented manually in terms of
__enter__/__exit__but at least we know that creation of thecontextmanager cannot fail, so things are simpler.
Also we don't need to check for whether the backend has been
resolved because rcParams now just prevent re-setting the backend to
auto_backend_sentinel.
(https://github.com/matplotlib/matplotlib/pull/11896/files#diff-9ffb0d1db51a67ee4f37528e00715b3cR852)
PR Summary
PR Checklist