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 tosetup, which means the idea from#16082 to "just passframe_prefix if you want to save the temporary files" was never possible.

PR checklist

[n/a] "closes #0000" is in the body of the PR description tolink the related issue
new and changed code istested
[n/a]Plotting related features are demonstrated in anexample
New Features andAPI Changes are noted with adirective and release note
Documentation complies withgeneral anddocstring guidelines

github-actionsbot added the topic: animation label

Sep 14, 2024

github-actionsbot added the status: needs rebase label

Dec 5, 2024

QuLogic force-pushed theanim-save-kwargs branch from7fd735e to2ea7dd3Compare

June 2, 2025 18:57

github-actionsbot removed the status: needs rebase label

Jun 2, 2025

timhoffm reviewed

Jun 2, 2025

View reviewed changes

lib/matplotlib/animation.py OutdatedShow resolvedHide resolved

Pass AbstractMovieWriter.setup kwargs through Animation.save

f6dc4e0

QuLogic force-pushed theanim-save-kwargs branch from2ea7dd3 tof6dc4e0Compare

June 2, 2025 20:51

timhoffm reviewed

Jun 2, 2025

View reviewed changes

Copy link

Member

timhoffm left a comment

Choose a reason for hiding this comment

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

The idea is fundamentally reasonable. However, I think we should do a bit:

inAbstractMovieWriter.setup docstring 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 ownsetup() 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 singlesetup_kwargs parameter - or if we want to be very explicitwriter_setup_kwargs. This better rhymes with the existingsavefig_kwargs and generally, with the patternfoo_kwargs (or sometimes spelledfoo_kw) that we use to pass on a set of kwargs for a specific purpose.