Commitf6dc4e0

fredrik-1

authored and

QuLogic

committed

Pass AbstractMovieWriter.setup kwargs through Animation.save

1 parent6083ecd commitf6dc4e0Copy full SHA for f6dc4e0

File tree

2 files changed

+24

-6

lines changed

lib/matplotlib
- animation.py
- tests
  - test_animation.py

2 files changed

+24

-6

lines changed

`‎lib/matplotlib/animation.py`

Lines changed: 8 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -210,7 +210,7 @@ def saving(self, fig, outfile, dpi, args, *kwargs):`
`210`	`210`	`"""`
`211`	`211`	`Context manager to facilitate writing the movie file.`
`212`	`212`
`213`		- ``args, *kw`` are any parameters that should be passed to `setup`.
	`213`	+ ``args, *kwargs`` are any parameters that should be passed to `setup`.
`214`	`214`	`"""`
`215`	`215`	`ifmpl.rcParams['savefig.bbox']=='tight':`
`216`	`216`	`_log.info("Disabling savefig.bbox = 'tight', as it may cause "`
`@@ -939,7 +939,7 @@ def _stop(self, *args):`
`939`	`939`
`940`	`940`	`defsave(self,filename,writer=None,fps=None,dpi=None,codec=None,`
`941`	`941`	`bitrate=None,extra_args=None,metadata=None,extra_anim=None,`
`942`		`-savefig_kwargs=None,*,progress_callback=None):`
	`942`	`+savefig_kwargs=None,,progress_callback=None,*kwargs):`
`943`	`943`	`"""`
`944`	`944`	`Save the animation as a movie file by drawing every frame.`
`945`	`945`
`@@ -1006,6 +1006,11 @@ def func(current_frame: int, total_frames: int) -> Any`
`1006`	`1006`
`1007`	`1007`	`progress_callback = lambda i, n: print(f'Saving frame {i}/{n}')`
`1008`	`1008`
	`1009`	`+ **kwargs :`
	`1010`	+ `AbstractMovieWriter` subclasses can specify additional parameters in their
	`1011`	+ `~.AbstractMovieWriter.setup` methods. Additional keyword arguments
	`1012`	`+ are passed to these setup functions.`
	`1013`	`+`
`1009`	`1014`	`Notes`
`1010`	`1015`	`-----`
`1011`	`1016`	`fps, codec, bitrate, extra_args and metadata are used to`
`@@ -1092,7 +1097,7 @@ def _pre_composite_to_white(color):`
`1092`	`1097`	`# canvas._is_saving = True makes the draw_event animation-starting`
`1093`	`1098`	`# callback a no-op; canvas.manager = None prevents resizing the GUI`
`1094`	`1099`	`# widget (both are likewise done in savefig()).`
`1095`		`-with (writer.saving(self._fig,filename,dpi),`
	`1100`	`+with (writer.saving(self._fig,filename,dpi,**kwargs),`
`1096`	`1101`	`cbook._setattr_cm(self._fig.canvas,_is_saving=True,manager=None)):`
`1097`	`1102`	`ifnotwriter._supports_transparency():`
`1098`	`1103`	`facecolor=savefig_kwargs.get('facecolor',`

`‎lib/matplotlib/tests/test_animation.py`

Lines changed: 16 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -56,11 +56,12 @@ class NullMovieWriter(animation.AbstractMovieWriter):`
`56`	`56`	`it cannot be added to the 'writers' registry.`
`57`	`57`	`"""`
`58`	`58`
`59`		`-defsetup(self,fig,outfile,dpi,*args):`
	`59`	`+defsetup(self,fig,outfile,dpi,args,*kwargs):`
`60`	`60`	`self.fig=fig`
`61`	`61`	`self.outfile=outfile`
`62`	`62`	`self.dpi=dpi`
`63`	`63`	`self.args=args`
	`64`	`+self.kwargs=kwargs`
`64`	`65`	`self._count=0`
`65`	`66`
`66`	`67`	`defgrab_frame(self,**savefig_kwargs):`
`@@ -79,15 +80,17 @@ def test_null_movie_writer(anim):`
`79`	`80`	`filename="unused.null"`
`80`	`81`	`dpi=50`
`81`	`82`	`savefig_kwargs=dict(foo=0)`
	`83`	`+setup_kwargs=dict(bar=1)`
`82`	`84`	`writer=NullMovieWriter()`
`83`	`85`
`84`	`86`	`anim.save(filename,dpi=dpi,writer=writer,`
`85`		`-savefig_kwargs=savefig_kwargs)`
	`87`	`+savefig_kwargs=savefig_kwargs,**setup_kwargs)`
`86`	`88`
`87`	`89`	`assertwriter.fig==plt.figure(1)# The figure used by anim fixture`
`88`	`90`	`assertwriter.outfile==filename`
`89`	`91`	`assertwriter.dpi==dpi`
`90`	`92`	`assertwriter.args== ()`
	`93`	`+assertwriter.kwargs==setup_kwargs`
`91`	`94`	`# we enrich the savefig kwargs to ensure we composite transparent`
`92`	`95`	`# output to an opaque background`
`93`	`96`	`fork,vinsavefig_kwargs.items():`
`@@ -187,8 +190,18 @@ def test_save_animation_smoketest(tmp_path, writer, frame_format, output, anim):`
`187`	`190`	`dpi=100.`
`188`	`191`	`codec='h264'`
`189`	`192`
	`193`	`+setup_kwargs= {}`
	`194`	`+ifwriter.endswith('_file'):`
	`195`	`+assertlen([tmp_path.glob('example')])==0`
	`196`	+# Test that kwargs are passed to `MovieFileWriter.setup` so that the automatic
	`197`	`+# temporary directory isn't used.`
	`198`	`+setup_kwargs['frame_prefix']=str(tmp_path/'example')`
	`199`	`+`
`190`	`200`	`anim.save(tmp_path/output,fps=30,writer=writer,bitrate=500,dpi=dpi,`
`191`		`-codec=codec)`
	`201`	`+codec=codec,**setup_kwargs)`
	`202`	`+`
	`203`	`+ifwriter.endswith('_file'):`
	`204`	`+assertlen([tmp_path.glob('example')])==anim._save_count`
`192`	`205`
`193`	`206`	`delanim`
`194`	`207`

0 commit comments

Comments

(0)

Movatterモバイル変換

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Commitf6dc4e0

File tree

2 files changed

2 files changed

`‎lib/matplotlib/animation.py`

`‎lib/matplotlib/tests/test_animation.py`

0 commit comments