TST: add smoke test for saving of animations

jakevdp · jakevdp · commit 26f86c0872ff · 2012-11-28T14:26:28.000-08:00
diff --git a/lib/matplotlib/animation.py b/lib/matplotlib/animation.py
@@ -53,6 +53,9 @@ def list(self):
         ''' Get a list of available MovieWriters.'''
         return self.avail.keys()
 
+    def is_available(self, name):
+        return name in self.avail
+
     def __getitem__(self, name):
         if not self.avail:
             raise RuntimeError("No MovieWriters available!")
diff --git a/lib/matplotlib/tests/test_animation.py b/lib/matplotlib/tests/test_animation.py
@@ -0,0 +1,54 @@
+import os
+import tempfile
+import numpy as np
+from matplotlib import pyplot as plt
+from matplotlib import animation
+from matplotlib.testing.noseclasses import KnownFailureTest
+
+
+# Smoke test for saving animations.  In the future, we should probably
+# design more sophisticated tests which compare resulting frames a-la
+# matplotlib.testing.image_comparison
+def test_save_animation_smoketest():
+    writers = ['ffmpeg', 'ffmpeg_file',
+               'mencoder', 'mencoder_file',
+               'avconv', 'avconv_file',
+               'imagemagick', 'imagemagick_file']
+
+    for writer in writers:
+        if writer.startswith('imagemagick'):
+            extension = '.gif'
+        else:
+            extension = '.mp4'
+
+        yield check_save_animation, writer, extension
+
+
+def check_save_animation(writer, extension='.mp4'):
+    if not animation.writers.is_available(writer):
+        raise KnownFailureTest("writer '%s' not available on this system"
+                               % writer)
+    fig, ax = plt.subplots()
+    line, = ax.plot([], [])
+
+    def init():
+        line.set_data([], [])
+        return line,
+
+    def animate(i):
+        x = np.linspace(0, 10, 100)
+        y = np.sin(x + i)
+        line.set_data(x, y)
+        return line,
+
+    fid, fname = tempfile.mkstemp(suffix=extension)
+
+    anim = animation.FuncAnimation(fig, animate, init_func=init, frames=5)
+    anim.save(fname, fps=30, writer=writer)
+
+    os.remove(fname)
+
+
+if __name__ == '__main__':
+    import nose
+    nose.runmodule()
diff --git a/matplotlibrc.template b/matplotlibrc.template
@@ -435,7 +435,7 @@ text.hinting_factor : 8 # Specifies the amount of softness for hinting in the
 #animation.ffmpeg_path: 'ffmpeg'   # Path to ffmpeg binary. Without full path
                                    # $PATH is searched
 #animation.ffmpeg_args: ''         # Additional arugments to pass to ffmpeg
-#animation.avconv_path: 'avconv'   # Path to ffmpeg binary. Without full path
+#animation.avconv_path: 'avconv'   # Path to avconv binary. Without full path
                                    # $PATH is searched
 #animation.avconv_args: ''         # Additional arugments to pass to ffmpeg
 #animation.mencoder_path: 'mencoder' 
