Pass AbstractMovieWriter.setup kwargs through Animation.save#28822
Open
QuLogic wants to merge 1 commit intomatplotlib:mainfrom
Open
Pass AbstractMovieWriter.setup kwargs through Animation.save#28822QuLogic wants to merge 1 commit intomatplotlib:mainfrom
QuLogic wants to merge 1 commit intomatplotlib:mainfrom
Conversation
timhoffm
reviewed
Jun 2, 2025
timhoffm
reviewed
Jun 2, 2025
Member
timhoffm
left a comment
timhoffm
left a comment
There was a problem hiding this comment.
The idea is fundamentally reasonable. However, I think we should do a bit:
- in
AbstractMovieWriter.setupdocstring clarify that subclasses may specify additional parameters. - optional: should we require/recommend that these additional parameters are kwonly? Should dpi even be kwonly? If either we should migrate our own
setup()APIs via@make_keyword_only. - To be checked are there third-party movie writers and would we need to take extra cater for compatibility. - I'm very much considering putting all the additional setup paramters in a single
setup_kwargsparameter - or if we want to be very explicitwriter_setup_kwargs. This better rhymes with the existingsavefig_kwargsand generally, with the patternfoo_kwargs(or sometimes spelledfoo_kw) that we use to pass on a set of kwargs for a specific purpose.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
PR summary
This is a rebase of #11863 with the addition of a test. That PR was closed because #16082 defaulted animations to save intermediate files to a temporary directory. However, that didn't actually fix the ability to pass arguments to
setup, which means the idea from #16082 to "just passframe_prefixif you want to save the temporary files" was never possible.PR checklist