Add a couple of exceptions to avoid exiting from class methods
[youtube-dl] / youtube-dl
index 3986ea0d88802984a08c45ec6db2894da3814b5a..f3239781b88c8d3f8e57c0a9661ac987da8eb4ca 100755 (executable)
@@ -25,6 +25,23 @@ std_headers = {
 
 simple_title_chars = string.ascii_letters.decode('ascii') + string.digits.decode('ascii')
 
+class DownloadError(Exception):
+       """Download Error exception.
+       
+       This exception may be thrown by FileDownloader objects if they are not
+       configured to continue on errors. They will contain the appropriate
+       error message.
+       """
+       pass
+
+class SameFileError(Exception):
+       """Same File exception.
+
+       This exception will be thrown by FileDownloader objects if they detect
+       multiple files would have to be downloaded to the same file on disk.
+       """
+       pass
+
 class FileDownloader(object):
        """File Downloader class.
 
@@ -60,12 +77,14 @@ class FileDownloader(object):
        simulate:       Do not download the video files.
        format:         Video format code.
        outtmpl:        Template for output names.
+       ignoreerrors:   Do not stop on download errors.
        """
 
        _params = None
        _ies = []
 
        def __init__(self, params):
+               """Create a FileDownloader object with the given options."""
                self._ies = []
                self.set_params(params)
        
@@ -159,11 +178,26 @@ class FileDownloader(object):
                """Checks if the output template is fixed."""
                return (re.search(ur'(?u)%\(.+?\)s', self._params['outtmpl']) is None)
 
+       def trouble(self, message=None):
+               """Determine action to take when a download problem appears.
+
+               Depending on if the downloader has been configured to ignore
+               download errors or not, this method may throw an exception or
+               not when errors are found, after printing the message. If it
+               doesn't raise, it returns an error code suitable to be returned
+               later as a program exit code to indicate error.
+               """
+               if message is not None:
+                       self.to_stderr(message)
+               if not self._params.get('ignoreerrors', False):
+                       raise DownloadError(message)
+               return 1
+
        def download(self, url_list):
                """Download a given list of URLs."""
                retcode = 0
                if len(url_list) > 1 and self.fixed_template():
-                       sys.exit('ERROR: fixed output name but more than one file to download')
+                       raise SameFileError(self._params['outtmpl'])
 
                for url in url_list:
                        suitable_found = False
@@ -175,10 +209,10 @@ class FileDownloader(object):
                                all_results = ie.extract(url)
                                results = [x for x in all_results if x is not None]
                                if len(results) != len(all_results):
-                                       retcode = 1
+                                       retcode = self.trouble()
 
                                if len(results) > 1 and self.fixed_template():
-                                       sys.exit('ERROR: fixed output name but more than one file to download')
+                                       raise SameFileError(self._params['outtmpl'])
 
                                for result in results:
 
@@ -195,36 +229,30 @@ class FileDownloader(object):
                                        try:
                                                filename = self._params['outtmpl'] % result
                                        except (ValueError, KeyError), err:
-                                               self.to_stderr('ERROR: invalid output template: %s' % str(err))
-                                               retcode = 1
+                                               retcode = self.trouble('ERROR: invalid output template: %s' % str(err))
                                                continue
                                        try:
                                                self.pmkdir(filename)
                                        except (OSError, IOError), err:
-                                               self.to_stderr('ERROR: unable to create directories: %s' % str(err))
-                                               retcode = 1
+                                               retcode = self.trouble('ERROR: unable to create directories: %s' % str(err))
                                                continue
                                        try:
                                                outstream = open(filename, 'wb')
                                        except (OSError, IOError), err:
-                                               self.to_stderr('ERROR: unable to open for writing: %s' % str(err))
-                                               retcode = 1
+                                               retcode = self.trouble('ERROR: unable to open for writing: %s' % str(err))
                                                continue
                                        try:
                                                self._do_download(outstream, result['url'])
                                                outstream.close()
                                        except (OSError, IOError), err:
-                                               self.to_stderr('ERROR: unable to write video data: %s' % str(err))
-                                               retcode = 1
+                                               retcode = self.trouble('ERROR: unable to write video data: %s' % str(err))
                                                continue
                                        except (urllib2.URLError, httplib.HTTPException, socket.error), err:
-                                               self.to_stderr('ERROR: unable to download video data: %s' % str(err))
-                                               retcode = 1
+                                               retcode = self.trouble('ERROR: unable to download video data: %s' % str(err))
                                                continue
                                break
                        if not suitable_found:
-                               self.to_stderr('ERROR: no suitable InfoExtractor: %s' % url)
-                               retcode = 1
+                               retcode = self.trouble('ERROR: no suitable InfoExtractor: %s' % url)
 
                return retcode
        
@@ -295,7 +323,7 @@ class InfoExtractor(object):
                return True
 
        def initialize(self):
-               """Initializes an instance (login, etc)."""
+               """Initializes an instance (authentication, etc)."""
                if not self._ready:
                        self._real_initialize()
                        self._ready = True
@@ -310,10 +338,12 @@ class InfoExtractor(object):
                self._downloader = downloader
        
        def to_stdout(self, message):
+               """Print message to stdout if downloader is not in quiet mode."""
                if self._downloader is None or not self._downloader.get_params().get('quiet', False):
                        print message
        
        def to_stderr(self, message):
+               """Print message to stderr."""
                sys.stderr.write('%s\n' % message)
 
        def _real_initialize(self):
@@ -355,6 +385,7 @@ class YoutubeIE(InfoExtractor):
                                self.to_stderr('WARNING: parsing .netrc: %s' % str(err))
                                return
 
+               # No authentication to be performed
                if username is None:
                        return
 
@@ -387,7 +418,8 @@ class YoutubeIE(InfoExtractor):
                        self.to_stdout('[youtube] Confirming age')
                        age_results = urllib2.urlopen(request).read()
                except (urllib2.URLError, httplib.HTTPException, socket.error), err:
-                       sys.exit('ERROR: unable to confirm age: %s' % str(err))
+                       self.to_stderr('ERROR: unable to confirm age: %s' % str(err))
+                       return
 
        def _real_extract(self, url):
                # Extract video id from URL
@@ -415,7 +447,8 @@ class YoutubeIE(InfoExtractor):
                        self.to_stdout('[youtube] %s: Downloading video webpage' % video_id)
                        video_webpage = urllib2.urlopen(request).read()
                except (urllib2.URLError, httplib.HTTPException, socket.error), err:
-                       sys.exit('ERROR: unable to download video: %s' % str(err))
+                       self.to_stderr('ERROR: unable to download video webpage: %s' % str(err))
+                       return [None]
                self.to_stdout('[youtube] %s: Extracting video information' % video_id)
                
                # "t" param
@@ -503,6 +536,8 @@ if __name__ == '__main__':
                                dest='format', metavar='FMT', help='video format code')
                parser.add_option('-b', '--best-quality',
                                action='store_const', dest='video_format', help='alias for -f 18', const='18')
+               parser.add_option('-i', '--ignore-errors',
+                               action='store_true', dest='ignoreerrors', help='continue on download errors', default=False)
                (opts, args) = parser.parse_args()
 
                # Conflicting, missing and erroneous options
@@ -536,10 +571,15 @@ if __name__ == '__main__':
                                or (opts.usetitle and '%(stitle)s-%(id)s.%(ext)s')
                                or (opts.useliteral and '%(title)s-%(id)s.%(ext)s')
                                or '%(id)s.%(ext)s'),
+                       'ignoreerrors': opts.ignoreerrors,
                        })
                fd.add_info_extractor(youtube_ie)
                retcode = fd.download(args)
                sys.exit(retcode)
 
+       except DownloadError:
+               sys.exit(1)
+       except SameFileError:
+               sys.exit('ERROR: fixed output name but more than one file to download')
        except KeyboardInterrupt:
                sys.exit('\nERROR: Interrupted by user')