Skip to content

Inline MovieWriter._frame_sink. #19045

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 1 commit into from
Dec 1, 2020
Merged

Inline MovieWriter._frame_sink. #19045

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
37 changes: 10 additions & 27 deletions lib/matplotlib/animation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -344,21 +344,16 @@ def grab_frame(self, **savefig_kwargs):
# All frames must have the same size to save the movie correctly.
self.fig.set_size_inches(self._w, self._h)
# Save the figure data to the sink, using the frame format and dpi.
self.fig.savefig(self._frame_sink(), format=self.frame_format,
self.fig.savefig(self._proc.stdin, format=self.frame_format,
dpi=self.dpi, **savefig_kwargs)

def _frame_sink(self):
"""Return the place to which frames should be written."""
return self._proc.stdin

def _args(self):
"""Assemble list of encoder-specific command-line arguments."""
return NotImplementedError("args needs to be implemented by subclass.")

def cleanup(self):
"""Clean-up and collect the process used to write the movie file."""
out, err = self._proc.communicate()
self._frame_sink().close()
# Use the encoding/errors that universal_newlines would use.
out = TextIOWrapper(BytesIO(out)).read()
err = TextIOWrapper(BytesIO(err)).read()
Expand Down Expand Up @@ -474,30 +469,18 @@ def _base_temp_name(self):
# for extension and the prefix.
return self.fname_format_str % (self.temp_prefix, self.frame_format)

def _frame_sink(self):
# Creates a filename for saving using the basename and the current
# counter.
path = Path(self._base_temp_name() % self._frame_counter)

# Save the filename so we can delete it later if necessary
self._temp_paths.append(path)
_log.debug('FileMovieWriter.frame_sink: saving frame %d to path=%s',
self._frame_counter, path)
self._frame_counter += 1 # Ensures each created name is 'unique'

# This file returned here will be closed once it's used by savefig()
# because it will no longer be referenced and will be gc-ed.
return open(path, 'wb')

def grab_frame(self, **savefig_kwargs):
# docstring inherited
# Overloaded to explicitly close temp file.
_log.debug('MovieWriter.grab_frame: Grabbing frame.')
# Tell the figure to save its data to the sink, using the
# frame format and dpi.
with self._frame_sink() as myframesink:
self.fig.savefig(myframesink, format=self.frame_format,
dpi=self.dpi, **savefig_kwargs)
# Creates a filename for saving using basename and counter.
path = Path(self._base_temp_name() % self._frame_counter)
self._temp_paths.append(path) # Record the filename for later cleanup.
self._frame_counter += 1 # Ensures each created name is unique.
_log.debug('FileMovieWriter.grab_frame: Grabbing frame %d to path=%s',
self._frame_counter, path)
with open(path, 'wb') as sink: # Save figure to the sink.
self.fig.savefig(sink, format=self.frame_format, dpi=self.dpi,
**savefig_kwargs)

def finish(self):
# Call run here now that all frame grabbing is done. All temp files
Expand Down