Add Artist._cm_set for temporarily setting an Artist property. #19369
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
QuLogic
reviewed
May 1, 2021
This corresponds to _setattr_cm, but for Artist properties. (Calling it `_set_cm` sounded too much like setting a "cm" property. Perhaps `_setattr_cm` should have been `_cm_setattr`...)
timhoffm
approved these changes
May 2, 2021
QuLogic
reviewed
May 4, 2021
Comment on lines
2258
to
+2261
| with cbook._setattr_cm(self, manager=None), \ | ||
| cbook._setattr_cm(self.figure, dpi=dpi), \ | ||
| cbook._setattr_cm(canvas, _is_saving=True): | ||
| origfacecolor = self.figure.get_facecolor() | ||
| origedgecolor = self.figure.get_edgecolor() | ||
|
|
||
| if facecolor is None: | ||
| facecolor = rcParams['savefig.facecolor'] | ||
| if cbook._str_equal(facecolor, 'auto'): | ||
| facecolor = origfacecolor | ||
| if edgecolor is None: | ||
| edgecolor = rcParams['savefig.edgecolor'] | ||
| if cbook._str_equal(edgecolor, 'auto'): | ||
| edgecolor = origedgecolor | ||
|
|
||
| self.figure.set_facecolor(facecolor) | ||
| self.figure.set_edgecolor(edgecolor) | ||
| cbook._setattr_cm(self.figure, dpi=dpi), \ | ||
| cbook._setattr_cm(canvas, _is_saving=True), \ | ||
| ExitStack() as stack: |
There was a problem hiding this comment.
Perhaps we could re-arrange this to avoid the escaped newlines:
Suggested change
| with cbook._setattr_cm(self, manager=None), \ | |
| cbook._setattr_cm(self.figure, dpi=dpi), \ | |
| cbook._setattr_cm(canvas, _is_saving=True): | |
| origfacecolor = self.figure.get_facecolor() | |
| origedgecolor = self.figure.get_edgecolor() | |
| if facecolor is None: | |
| facecolor = rcParams['savefig.facecolor'] | |
| if cbook._str_equal(facecolor, 'auto'): | |
| facecolor = origfacecolor | |
| if edgecolor is None: | |
| edgecolor = rcParams['savefig.edgecolor'] | |
| if cbook._str_equal(edgecolor, 'auto'): | |
| edgecolor = origedgecolor | |
| self.figure.set_facecolor(facecolor) | |
| self.figure.set_edgecolor(edgecolor) | |
| cbook._setattr_cm(self.figure, dpi=dpi), \ | |
| cbook._setattr_cm(canvas, _is_saving=True), \ | |
| ExitStack() as stack: | |
| with ExitStack() as stack: | |
| stack.enter_context(cbook._setattr_cm(self, manager=None)) | |
| stack.enter_context(cbook._setattr_cm(self.figure, dpi=dpi)) | |
| stack.enter_context(cbook._setattr_cm(canvas, _is_saving=True)) |
and maybe move the comment in.
There was a problem hiding this comment.
I think having syntactic context managers remains more readable; also note that in Py3.10+ we'll be able to parenthesize the multiple contextmanagers to avoid the backslashes anyways.
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.
This corresponds to _setattr_cm, but for Artist properties.
(Calling it
_set_cmsounded too much like setting a "cm" property.Perhaps
_setattr_cmshould have been_cm_setattr...)See #19342 (comment) and discussion above.
PR Summary
PR Checklist
pytestpasses).flake8on changed files to check).flake8-docstringsand runflake8 --docstring-convention=all).doc/users/next_whats_new/(follow instructions in README.rst there).doc/api/next_api_changes/(follow instructions in README.rst there).