Programmatically generate signature of Figure.savefig. #24405
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
Note that the previously documented "Call signature" did not mention "transparent". Also adjust tools/boilerplate.py so that pyplot.savefig can also benefit from this change; this implies generalizing axes_cmappable_method_template to support general postambles, also for Figure methods. See the new signature of pyplot.savefig for the end result.
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.
Note that the previously documented "Call signature" did not mention "transparent".
Also adjust tools/boilerplate.py so that pyplot.savefig can also benefit from this change; this implies generalizing
axes_cmappable_method_template to support general postambles, also for Figure methods.
See the new signature of pyplot.savefig for the end result.
Edit: This currently fails test_agg.py::test_webp_alpha because facecolor=None is now explicitly passed to Figure.savefig, which prevents
kwargs.setdefault("facecolor", "none")from taking effect, andfacecolor=Noneis instead interpreted as "use the rcparam" :/ Probably easy to fix, but needs some thought about strict backcompat.PR Summary
PR Checklist
Tests and Styling
pytestpasses).flake8-docstringsand runflake8 --docstring-convention=all).Documentation
Release Notes
.. versionadded::directive in the docstring and documented indoc/users/next_whats_new/.. versionchanged::directive in the docstring and documented indoc/api/next_api_changes/next_whats_new/README.rstornext_api_changes/README.rst