Remove animation bits deprecated in 3.3.

QuLogic · QuLogic · commit b2667e8d02d8 · 2021-06-29T05:23:38.000-04:00
diff --git a/doc/api/animation_api.rst b/doc/api/animation_api.rst
@@ -186,7 +186,6 @@ on all systems.
 
    FFMpegWriter
    ImageMagickWriter
-   AVConvWriter
 
 The file-based writers save temporary files for each frame which are stitched
 into a single file at the end.  Although slower, these writers can be easier to
@@ -198,7 +197,6 @@ debug.
 
    FFMpegFileWriter
    ImageMagickFileWriter
-   AVConvFileWriter
 
 Fundamentally, a `MovieWriter` provides a way to grab sequential frames
 from the same underlying `~matplotlib.figure.Figure` object.  The base
@@ -283,7 +281,6 @@ and mixins
    :toctree: _as_gen
    :nosignatures:
 
-   AVConvBase
    FFMpegBase
    ImageMagickBase
 
@@ -298,6 +295,6 @@ Inheritance Diagrams
    :private-bases:
    :parts: 1
 
-.. inheritance-diagram:: matplotlib.animation.AVConvFileWriter matplotlib.animation.AVConvWriter matplotlib.animation.FFMpegFileWriter matplotlib.animation.FFMpegWriter matplotlib.animation.ImageMagickFileWriter matplotlib.animation.ImageMagickWriter
+.. inheritance-diagram:: matplotlib.animation.FFMpegFileWriter matplotlib.animation.FFMpegWriter matplotlib.animation.ImageMagickFileWriter matplotlib.animation.ImageMagickWriter
    :private-bases:
    :parts: 1
diff --git a/doc/api/next_api_changes/removals/20465-ES.rst b/doc/api/next_api_changes/removals/20465-ES.rst
@@ -8,3 +8,23 @@ Case-insensitive capstyles and joinstyles
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Please pass capstyles ("miter", "round", "bevel") and joinstyles ("butt",
 "round", "projecting") as lowercase.
+
+AVConv animation writers removed
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The ``AVConvBase``, ``AVConvWriter`` and ``AVConvFileWriter`` classes, and the
+associated ``animation.avconv_path`` and ``animation.avconv_args`` rcParams
+have been removed.
+
+Debian 8 (2015, EOL 06/2020) and Ubuntu 14.04 (EOL 04/2019) were the
+last versions of Debian and Ubuntu to ship avconv.  It remains possible
+to force the use of avconv by using the FFmpeg-based writers with
+:rc:`animation.ffmpeg_path` set to "avconv".
+
+``MovieWriter`` attributes
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+* ``animation.html_args`` rcParam
+* ``HTMLWriter.args_key`` attribute
+* ``MovieWriter.args_key`` and ``MovieWriter.exec_key`` attributes
+* *clear_temp* parameter and attribute of `.FileMovieWriter`; files placed in a
+  temporary directory (using ``frame_prefix=None``, the default) will be
+  cleared; files placed elsewhere will not.
diff --git a/lib/matplotlib/animation.py b/lib/matplotlib/animation.py
@@ -261,9 +261,6 @@ class MovieWriter(AbstractMovieWriter):
     # stored.  Third-party writers cannot meaningfully set these as they cannot
     # extend rcParams with new keys.
 
-    exec_key = _api.deprecate_privatize_attribute("3.3")
-    args_key = _api.deprecate_privatize_attribute("3.3")
-
     # Pipe-based writers only support RGBA, but file-based ones support more
     # formats.
     supported_formats = ["rgba"]
@@ -407,9 +404,7 @@ def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self.frame_format = mpl.rcParams['animation.frame_format']
 
-    @_api.delete_parameter("3.3", "clear_temp")
-    def setup(self, fig, outfile, dpi=None, frame_prefix=None,
-              clear_temp=True):
+    def setup(self, fig, outfile, dpi=None, frame_prefix=None):
         """
         Setup for writing the movie file.
 
@@ -423,13 +418,10 @@ def setup(self, fig, outfile, dpi=None, frame_prefix=None,
             The dpi of the output file. This, with the figure size,
             controls the size in pixels of the resulting movie file.
         frame_prefix : str, optional
-            The filename prefix to use for temporary files.  If None (the
+            The filename prefix to use for temporary files.  If *None* (the
             default), files are written to a temporary directory which is
-            deleted by `cleanup` (regardless of the value of *clear_temp*).
-        clear_temp : bool, optional
-            If the temporary files should be deleted after stitching
-            the final result.  Setting this to ``False`` can be useful for
-            debugging.  Defaults to ``True``.
+            deleted by `cleanup`; if not *None*, no temporary files are
+            deleted.
         """
         self.fig = fig
         self.outfile = outfile
@@ -444,7 +436,6 @@ def setup(self, fig, outfile, dpi=None, frame_prefix=None,
         else:
             self._tmpdir = None
             self.temp_prefix = frame_prefix
-        self._clear_temp = clear_temp
         self._frame_counter = 0  # used for generating sequential file names
         self._temp_paths = list()
         self.fname_format_str = '%s%%07d.%s'
@@ -453,15 +444,6 @@ def __del__(self):
         if self._tmpdir:
             self._tmpdir.cleanup()
 
-    @_api.deprecated("3.3")
-    @property
-    def clear_temp(self):
-        return self._clear_temp
-
-    @clear_temp.setter
-    def clear_temp(self, value):
-        self._clear_temp = value
-
     @property
     def frame_format(self):
         """
@@ -488,10 +470,9 @@ def _base_temp_name(self):
 
     def grab_frame(self, **savefig_kwargs):
         # docstring inherited
-        # Overloaded to explicitly close temp file.
         # 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._temp_paths.append(path)  # Record the filename for later use.
         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)
@@ -510,12 +491,6 @@ def _cleanup(self):  # Inline to finish() once cleanup() is removed.
         if self._tmpdir:
             _log.debug('MovieWriter: clearing temporary path=%s', self._tmpdir)
             self._tmpdir.cleanup()
-        else:
-            if self._clear_temp:
-                _log.debug('MovieWriter: clearing temporary paths=%s',
-                           self._temp_paths)
-                for path in self._temp_paths:
-                    path.unlink()
 
 
 @writers.register('pillow')
@@ -582,17 +557,6 @@ def output_args(self):
 
         return args + ['-y', self.outfile]
 
-    @classmethod
-    def isAvailable(cls):
-        return (
-            super().isAvailable()
-            # Ubuntu 12.04 ships a broken ffmpeg binary which we shouldn't use.
-            # NOTE: when removed, remove the same method in AVConvBase.
-            and b'LibAv' not in subprocess.run(
-                [cls.bin_path()], creationflags=subprocess_creation_flags,
-                stdin=subprocess.DEVNULL, stdout=subprocess.DEVNULL,
-                stderr=subprocess.PIPE).stderr)
-
 
 # Combine FFMpeg options with pipe-based writing
 @writers.register('ffmpeg')
@@ -651,45 +615,6 @@ def _args(self):
         return [self.bin_path(), *args, *self.output_args]
 
 
-# Base class of avconv information.  AVConv has identical arguments to FFMpeg.
-@_api.deprecated('3.3')
-class AVConvBase(FFMpegBase):
-    """
-    Mixin class for avconv output.
-
-    To be useful this must be multiply-inherited from with a
-    `MovieWriterBase` sub-class.
-    """
-
-    _exec_key = 'animation.avconv_path'
-    _args_key = 'animation.avconv_args'
-
-    # NOTE : should be removed when the same method is removed in FFMpegBase.
-    isAvailable = classmethod(MovieWriter.isAvailable.__func__)
-
-
-# Combine AVConv options with pipe-based writing
-@writers.register('avconv')
-class AVConvWriter(AVConvBase, FFMpegWriter):
-    """
-    Pipe-based avconv writer.
-
-    Frames are streamed directly to avconv via a pipe and written in a single
-    pass.
-    """
-
-
-# Combine AVConv options with file-based writing
-@writers.register('avconv_file')
-class AVConvFileWriter(AVConvBase, FFMpegFileWriter):
-    """
-    File-based avconv writer.
-
-    Frames are written to temporary files on disk and then stitched
-    together at the end.
-    """
-
-
 # Base class for animated GIFs with ImageMagick
 class ImageMagickBase:
     """
@@ -794,8 +719,6 @@ class HTMLWriter(FileMovieWriter):
     """Writer for JavaScript-based HTML movies."""
 
     supported_formats = ['png', 'jpeg', 'tiff', 'svg']
-    args_key = _api.deprecated("3.3")(property(
-        lambda self: 'animation.html_args'))
 
     @classmethod
     def isAvailable(cls):
@@ -892,19 +815,13 @@ def finish(self):
 
         # duplicate the temporary file clean up logic from
         # FileMovieWriter.cleanup.  We can not call the inherited
-        # versions of finished or cleanup because both assume that
+        # versions of finish or cleanup because both assume that
         # there is a subprocess that we either need to call to merge
         # many frames together or that there is a subprocess call that
         # we need to clean up.
         if self._tmpdir:
             _log.debug('MovieWriter: clearing temporary path=%s', self._tmpdir)
             self._tmpdir.cleanup()
-        else:
-            if self._clear_temp:
-                _log.debug('MovieWriter: clearing temporary paths=%s',
-                           self._temp_paths)
-                for path in self._temp_paths:
-                    path.unlink()
 
 
 class Animation:
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -1236,16 +1236,10 @@ def _convert_validator_spec(key, conv):
     # Controls image format when frames are written to disk
     "animation.frame_format": ["png", "jpeg", "tiff", "raw", "rgba", "ppm",
                                "sgi", "bmp", "pbm", "svg"],
-    # Additional arguments for HTML writer
-    "animation.html_args":    validate_stringlist,
     # Path to ffmpeg binary. If just binary name, subprocess uses $PATH.
     "animation.ffmpeg_path":  _validate_pathlike,
     # Additional arguments for ffmpeg movie writer (using pipes)
     "animation.ffmpeg_args":  validate_stringlist,
-    # Path to AVConv binary. If just binary name, subprocess uses $PATH.
-    "animation.avconv_path":  _validate_pathlike,
-    # Additional arguments for avconv movie writer (using pipes)
-    "animation.avconv_args":  validate_stringlist,
      # Path to convert binary. If just binary name, subprocess uses $PATH.
     "animation.convert_path": _validate_pathlike,
      # Additional arguments for convert movie writer (using pipes)
@@ -1261,9 +1255,7 @@ def _convert_validator_spec(key, conv):
     # ... because they are private:
     "_internal.classic_mode": False,
     # ... because they are deprecated:
-    "animation.avconv_path": "avconv",
-    "animation.avconv_args": [],
-    "animation.html_args": [],
+    # No current deprecations.
     # backend is handled separately when constructing rcParamsDefault.
 }
 _validators = {k: _convert_validator_spec(k, conv)
