Deprecate unused rcParams["animation.html_args"].

anntzer · anntzer · commit 6e7ac04e94d3 · 2019-09-21T12:00:24.000+02:00
I guess it was intended as a parallel for e.g. `animation.ffmpeg_args`
-- a list of command-line arguments additionally passed to ffmpeg -- but
no external program is used by the html animation writer.
diff --git a/doc/api/next_api_changes/2018-09-21-AL.rst b/doc/api/next_api_changes/2018-09-21-AL.rst
@@ -0,0 +1,5 @@
+Deprecations
+````````````
+
+The unused ``animation.html_args`` rcParam and ``animation.HTMLWriter.args_key``
+attribute are deprecated.
diff --git a/lib/matplotlib/__init__.py b/lib/matplotlib/__init__.py
@@ -731,6 +731,7 @@ def gen_candidates():
     'savefig.frameon': ('3.1',),
     'verbose.fileo': ('3.1',),
     'verbose.level': ('3.1',),
+    'animation.html_args': ('3.3',),
 }
 
 
diff --git a/lib/matplotlib/animation.py b/lib/matplotlib/animation.py
@@ -788,7 +788,11 @@ def _embedded_frames(frame_list, frame_format):
 @writers.register('html')
 class HTMLWriter(FileMovieWriter):
     supported_formats = ['png', 'jpeg', 'tiff', 'svg']
-    args_key = 'animation.html_args'
+
+    @cbook.deprecated("3.3")
+    @property
+    def args_key(self):
+        return 'animation.html_args'
 
     @classmethod
     def isAvailable(cls):
@@ -797,21 +801,23 @@ def isAvailable(cls):
     def __init__(self, fps=30, codec=None, bitrate=None, extra_args=None,
                  metadata=None, embed_frames=False, default_mode='loop',
                  embed_limit=None):
+
+        if extra_args:
+            _log.warning("HTMLWriter ignores 'extra_args'")
+        extra_args = ()  # Don't lookup nonexistent rcParam[args_key].
         self.embed_frames = embed_frames
         self.default_mode = default_mode.lower()
+        cbook._check_in_list(['loop', 'once', 'reflect'],
+                             default_mode=self.default_mode)
 
         # Save embed limit, which is given in MB
         if embed_limit is None:
             self._bytes_limit = rcParams['animation.embed_limit']
         else:
             self._bytes_limit = embed_limit
-
         # Convert from MB to bytes
         self._bytes_limit *= 1024 * 1024
 
-        cbook._check_in_list(['loop', 'once', 'reflect'],
-                             default_mode=self.default_mode)
-
         super().__init__(fps, codec, bitrate, extra_args, metadata)
 
     def setup(self, fig, outfile, dpi, frame_dir=None):
diff --git a/matplotlibrc.template b/matplotlibrc.template
@@ -734,7 +734,6 @@
 #animation.bitrate : -1      ## Controls size/quality tradeoff for movie.
                              ## -1 implies let utility auto-determine
 #animation.frame_format : png      ## Controls frame format used by temp files
-#animation.html_args    :          ## Additional arguments to pass to html writer
 #animation.ffmpeg_path  : ffmpeg   ## Path to ffmpeg binary. Without full path
                                    ## $PATH is searched
 #animation.ffmpeg_args  :          ## Additional arguments to pass to ffmpeg

Original file line number	Diff line number	Diff line change
`@@ -731,6 +731,7 @@ def gen_candidates():`
`731`	`731`	`'savefig.frameon': ('3.1',),`
`732`	`732`	`'verbose.fileo': ('3.1',),`
`733`	`733`	`'verbose.level': ('3.1',),`
	`734`	`+ 'animation.html_args': ('3.3',),`
`734`	`735`	`}`
`735`	`736`
`736`	`737`