Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add an option to log progress while saving animations #13564

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 29, 2019
Merged

Add an option to log progress while saving animations #13564

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8bf2bef
added a parameter progress_callback to sanimate.save
SBCV Mar 23, 2019
24420e9
Added progress_callback as kwarg argument
SBCV Mar 25, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions doc/users/next_whats_new/2019-03-18-SB.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
*progress_callback* argument to ani.save()
-------------------------------------------------

The method .FuncAnimation.save() gained an optional
*progress_callback* argument to notify the saving progress.
27 changes: 26 additions & 1 deletion lib/matplotlib/animation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -957,7 +957,7 @@ def _stop(self, *args):

def save(self, filename, writer=None, fps=None, dpi=None, codec=None,
bitrate=None, extra_args=None, metadata=None, extra_anim=None,
savefig_kwargs=None):
savefig_kwargs=None, *, progress_callback=None):
"""
Save the animation as a movie file by drawing every frame.

Expand Down Expand Up @@ -1013,6 +1013,22 @@ class to use, such as 'ffmpeg'. If ``None``, defaults to
on to the `savefig` command which is called repeatedly to
save the individual frames.

progress_callback : function, optional
A callback function that will be called for every frame to notify
the saving progress. It must have the signature ::

def func(current_frame: int, total_frames: int) -> Any

where *current_frame* is the current frame number and
*total_frames* is the total number of frames to be saved.
*total_frames* is set to None, if the total number of frames can
not be determined. Return values may exist but are ignored.

Example code to write the progress to stdout::

progress_callback =\
lambda i, n: print(f'Saving frame {i} of {n}')

Notes
-----
*fps*, *codec*, *bitrate*, *extra_args* and *metadata* are used to
Expand Down Expand Up @@ -1111,10 +1127,19 @@ class to use, such as 'ffmpeg'. If ``None``, defaults to
for anim in all_anim:
# Clear the initial frame
anim._init_draw()
frame_number = 0
save_count_list = [a.save_count for a in all_anim]
if None in save_count_list:
total_frames = None
else:
total_frames = sum(save_count_list)
for data in zip(*[a.new_saved_frame_seq() for a in all_anim]):
for anim, d in zip(all_anim, data):
# TODO: See if turning off blit is really necessary
anim._draw_next_frame(d, blit=False)
if progress_callback is not None:
progress_callback(frame_number, total_frames)
frame_number += 1
writer.grab_frame(**savefig_kwargs)

# Reconnect signal for first draw if necessary
Expand Down