Merge pull request #15319 from anntzer/validate_movie_writer

dopplershift · web-flow · commit 90fba030f534 · 2019-09-24T14:23:10.000-06:00
Make validate_movie_writer actually check registered writers.
diff --git a/lib/matplotlib/animation.py b/lib/matplotlib/animation.py
@@ -34,7 +34,7 @@
 import matplotlib as mpl
 from matplotlib._animation_data import (
     DISPLAY_TEMPLATE, INCLUDED_FRAMES, JS_INCLUDE, STYLE_INCLUDE)
-from matplotlib import cbook, rcParams, rc_context
+from matplotlib import cbook
 
 
 _log = logging.getLogger(__name__)
@@ -288,17 +288,17 @@ def __init__(self, fps=5, codec=None, bitrate=None, extra_args=None,
         self.frame_format = 'rgba'
 
         if codec is None:
-            self.codec = rcParams['animation.codec']
+            self.codec = mpl.rcParams['animation.codec']
         else:
             self.codec = codec
 
         if bitrate is None:
-            self.bitrate = rcParams['animation.bitrate']
+            self.bitrate = mpl.rcParams['animation.bitrate']
         else:
             self.bitrate = bitrate
 
         if extra_args is None:
-            self.extra_args = list(rcParams[self.args_key])
+            self.extra_args = list(mpl.rcParams[self.args_key])
         else:
             self.extra_args = extra_args
 
@@ -418,7 +418,7 @@ def bin_path(cls):
         subclass. This is a class method so that the tool can be looked for
         before making a particular MovieWriter subclass available.
         '''
-        return str(rcParams[cls.exec_key])
+        return str(mpl.rcParams[cls.exec_key])
 
     @classmethod
     def isAvailable(cls):
@@ -435,7 +435,7 @@ class FileMovieWriter(MovieWriter):
     '''
     def __init__(self, *args, **kwargs):
         MovieWriter.__init__(self, *args, **kwargs)
-        self.frame_format = rcParams['animation.frame_format']
+        self.frame_format = mpl.rcParams['animation.frame_format']
 
     def setup(self, fig, outfile, dpi=None, frame_prefix='_tmp',
               clear_temp=True):
@@ -802,7 +802,7 @@ def __init__(self, fps=30, codec=None, bitrate=None, extra_args=None,
 
         # Save embed limit, which is given in MB
         if embed_limit is None:
-            self._bytes_limit = rcParams['animation.embed_limit']
+            self._bytes_limit = mpl.rcParams['animation.embed_limit']
         else:
             self._bytes_limit = embed_limit
 
@@ -1046,7 +1046,7 @@ def func(current_frame: int, total_frames: int) -> Any
         # If the writer is None, use the rc param to find the name of the one
         # to use
         if writer is None:
-            writer = rcParams['animation.writer']
+            writer = mpl.rcParams['animation.writer']
         elif (not isinstance(writer, str) and
               any(arg is not None
                   for arg in (fps, codec, bitrate, extra_args, metadata))):
@@ -1074,15 +1074,15 @@ def func(current_frame: int, total_frames: int) -> Any
 
         # Re-use the savefig DPI for ours if none is given
         if dpi is None:
-            dpi = rcParams['savefig.dpi']
+            dpi = mpl.rcParams['savefig.dpi']
         if dpi == 'figure':
             dpi = self._fig.dpi
 
         if codec is None:
-            codec = rcParams['animation.codec']
+            codec = mpl.rcParams['animation.codec']
 
         if bitrate is None:
-            bitrate = rcParams['animation.bitrate']
+            bitrate = mpl.rcParams['animation.bitrate']
 
         all_anim = [self]
         if extra_anim is not None:
@@ -1122,12 +1122,12 @@ def func(current_frame: int, total_frames: int) -> Any
         # TODO: Right now, after closing the figure, saving a movie won't work
         # since GUI widgets are gone. Either need to remove extra code to
         # allow for this non-existent use case or find a way to make it work.
-        with rc_context():
-            if rcParams['savefig.bbox'] == 'tight':
+        with mpl.rc_context():
+            if mpl.rcParams['savefig.bbox'] == 'tight':
                 _log.info("Disabling savefig.bbox = 'tight', as it may cause "
                           "frame size to vary, which is inappropriate for "
                           "animation.")
-                rcParams['savefig.bbox'] = None
+                mpl.rcParams['savefig.bbox'] = None
             with writer.saving(self._fig, filename, dpi):
                 for anim in all_anim:
                     # Clear the initial frame
@@ -1313,7 +1313,7 @@ def to_html5_video(self, embed_limit=None):
         if not hasattr(self, '_base64_video'):
             # Save embed limit, which is given in MB
             if embed_limit is None:
-                embed_limit = rcParams['animation.embed_limit']
+                embed_limit = mpl.rcParams['animation.embed_limit']
 
             # Convert from MB to bytes
             embed_limit *= 1024 * 1024
@@ -1324,9 +1324,9 @@ def to_html5_video(self, embed_limit=None):
                 path = Path(tmpdir, "temp.m4v")
                 # We create a writer manually so that we can get the
                 # appropriate size for the tag
-                Writer = writers[rcParams['animation.writer']]
+                Writer = writers[mpl.rcParams['animation.writer']]
                 writer = Writer(codec='h264',
-                                bitrate=rcParams['animation.bitrate'],
+                                bitrate=mpl.rcParams['animation.bitrate'],
                                 fps=1000. / self._interval)
                 self.save(str(path), writer=writer)
                 # Now open and base64 encode.
@@ -1385,7 +1385,7 @@ def to_jshtml(self, fps=None, embed_frames=True, default_mode=None):
 
     def _repr_html_(self):
         '''IPython display hook for rendering.'''
-        fmt = rcParams['animation.html']
+        fmt = mpl.rcParams['animation.html']
         if fmt == 'html5':
             return self.to_html5_video()
         elif fmt == 'jshtml':
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -22,7 +22,7 @@
 import re
 
 import matplotlib as mpl
-from matplotlib import cbook
+from matplotlib import animation, cbook
 from matplotlib.cbook import ls_mapper
 from matplotlib.fontconfig_pattern import parse_fontconfig_pattern
 from matplotlib.colors import is_color_like
@@ -619,11 +619,16 @@ def validate_hinting(s):
 validate_pgf_texsystem = ValidateInStrings('pgf.texsystem',
                                            ['xelatex', 'lualatex', 'pdflatex'])
 
-validate_movie_writer = ValidateInStrings('animation.writer',
-    ['ffmpeg', 'ffmpeg_file',
-     'avconv', 'avconv_file',
-     'imagemagick', 'imagemagick_file',
-     'html'])
+
+def validate_movie_writer(s):
+    # writers.list() would only list actually available writers, but
+    # FFMpeg.isAvailable is slow and not worth paying for at every import.
+    if s in animation.writers._registered:
+        return s
+    else:
+        raise ValueError(f"Supported animation writers are "
+                         f"{sorted(animation.writers._registered)}")
+
 
 validate_movie_frame_fmt = ValidateInStrings('animation.frame_format',
     ['png', 'jpeg', 'tiff', 'raw', 'rgba'])
