Merge pull request #13827 from timhoffm/moviewriter-init-error

tacaswell · web-flow · commit 8714c32afd83 · 2019-04-02T09:17:07.000-04:00
MNT: Better MovieWriter init error message
diff --git a/lib/matplotlib/animation.py b/lib/matplotlib/animation.py
@@ -235,8 +235,9 @@ def saving(self, fig, outfile, dpi, *args, **kwargs):
 class MovieWriter(AbstractMovieWriter):
     '''Base class for writing movies.
 
-    This class is set up to provide for writing movie frame data to a pipe.
-    See examples for how to use these classes.
+    This is a base class for MovieWriter subclasses that write a movie frame
+    data to a pipe. You cannot instantiate this class directly.
+    See examples for how to use its subclasses.
 
     Attributes
     ----------
@@ -274,6 +275,15 @@ def __init__(self, fps=5, codec=None, bitrate=None, extra_args=None,
             output file. Some keys that may be of use include:
             title, artist, genre, subject, copyright, srcform, comment.
         '''
+        if self.__class__ is MovieWriter:
+            # TODO MovieWriter is still an abstract class and needs to be
+            #      extended with a mixin. This should be clearer in naming
+            #      and description. For now, just give a reasonable error
+            #      message to users.
+            raise TypeError(
+                'MovieWriter cannot be instantiated directly. Please use one '
+                'of its subclasses.')
+
         self.fps = fps
         self.frame_format = 'rgba'
 
diff --git a/lib/matplotlib/tests/test_animation.py b/lib/matplotlib/tests/test_animation.py
@@ -77,8 +77,11 @@ def test_null_movie_writer():
 
 
 def test_movie_writer_dpi_default():
-    # Test setting up movie writer with figure.dpi default.
+    class DummyMovieWriter(animation.MovieWriter):
+        def _run(self):
+            pass
 
+    # Test setting up movie writer with figure.dpi default.
     fig = plt.figure()
 
     filename = "unused.null"
@@ -87,11 +90,7 @@ def test_movie_writer_dpi_default():
     bitrate = 1
     extra_args = ["unused"]
 
-    def run():
-        pass
-
-    writer = animation.MovieWriter(fps, codec, bitrate, extra_args)
-    writer._run = run
+    writer = DummyMovieWriter(fps, codec, bitrate, extra_args)
     writer.setup(fig, filename)
     assert writer.dpi == fig.dpi
 
