_ Git - youtube-dl/blob - youtube_dl/postprocessor/common.py

   1 from __future__ import unicode_literals
   2
   3 import os
   4
   5 from ..utils import (
   6     PostProcessingError,
   7     encodeFilename,
   8 )
   9
  10
  11 class PostProcessor(object):
  12     """Post Processor class.
  13
  14     PostProcessor objects can be added to downloaders with their
  15     add_post_processor() method. When the downloader has finished a
  16     successful download, it will take its internal chain of PostProcessors
  17     and start calling the run() method on each one of them, first with
  18     an initial argument and then with the returned value of the previous
  19     PostProcessor.
  20
  21     The chain will be stopped if one of them ever returns None or the end
  22     of the chain is reached.
  23
  24     PostProcessor objects follow a "mutual registration" process similar
  25     to InfoExtractor objects. And it can receive parameters from CLI trough
  26     --pp-params.
  27     """
  28
  29     _downloader = None
  30
  31     def __init__(self, downloader=None):
  32         self._downloader = downloader
  33
  34     def set_downloader(self, downloader):
  35         """Sets the downloader for this PP."""
  36         self._downloader = downloader
  37
  38     def run(self, information):
  39         """Run the PostProcessor.
  40
  41         The "information" argument is a dictionary like the ones
  42         composed by InfoExtractors. The only difference is that this
  43         one has an extra field called "filepath" that points to the
  44         downloaded file.
  45
  46         This method returns a tuple, the first element is a list of the files
  47         that can be deleted, and the second of which is the updated
  48         information.
  49
  50         In addition, this method may raise a PostProcessingError
  51         exception if post processing fails.
  52         """
  53         return [], information  # by default, keep file and do nothing
  54
  55     def try_utime(self, path, atime, mtime, errnote='Cannot update utime of file'):
  56         try:
  57             os.utime(encodeFilename(path), (atime, mtime))
  58         except Exception:
  59             self._downloader.report_warning(errnote)
  60
  61
  62 class AudioConversionError(PostProcessingError):
  63     pass