Merge branch 'master' into subtitles_rework
[youtube-dl] / youtube_dl / extractor / subtitles.py
index 8843e02209214fa351cde40f6cbfdebc0d063e91..c10cdf266737737d5c0d985c9e29e3bac1c8399d 100644 (file)
@@ -12,45 +12,45 @@ from ..utils import (
 
 class SubtitlesIE(InfoExtractor):
 
-    def report_video_subtitles_available(self, video_id, sub_lang_list):
-        """Report available subtitles."""
+    def _list_available_subtitles(self, video_id):
+        """ outputs the available subtitles for the video """
+        sub_lang_list = self._get_available_subtitles(video_id)
         sub_lang = ",".join(list(sub_lang_list.keys()))
         self.to_screen(u'%s: Available subtitles for video: %s' %
                        (video_id, sub_lang))
 
-    def _list_available_subtitles(self, video_id):
-        sub_lang_list = self._get_available_subtitles(video_id)
-        self.report_video_subtitles_available(video_id, sub_lang_list)
-
     def _extract_subtitles(self, video_id):
-        """
-        Return a dictionary: {language: subtitles} or {} if the subtitles
-        couldn't be found
-        """
-        sub_lang_list = self._get_available_subtitles(video_id)
-        if not sub_lang_list:  # error, it didn't get the available subtitles
+        """ returns {sub_lang: sub} or {} if subtitles not found """
+        available_subs_list = self._get_available_subtitles(video_id)
+        if not available_subs_list:  # error, it didn't get the available subtitles
             return {}
+        if self._downloader.params.get('allsubtitles', False):
+            sub_lang_list = available_subs_list
+        else:
+            if self._downloader.params.get('writesubtitles', False):
+                if self._downloader.params.get('subtitleslangs', False):
+                    requested_langs = self._downloader.params.get('subtitleslangs')
+                elif 'en' in available_subs_list:
+                    requested_langs = ['en']
+                else:
+                    requested_langs = [list(available_subs_list.keys())[0]]
 
-        if self._downloader.params.get('writesubtitles', False):
-            if self._downloader.params.get('subtitleslang', False):
-                sub_lang = self._downloader.params.get('subtitleslang')
-            elif 'en' in sub_lang_list:
-                sub_lang = 'en'
-            else:
-                sub_lang = list(sub_lang_list.keys())[0]
-            if not sub_lang in sub_lang_list:
-                self._downloader.report_warning(u'no closed captions found in the specified language "%s"' % sub_lang)
-                return {}
-            sub_lang_list = {sub_lang: sub_lang_list[sub_lang]}
+                sub_lang_list = {}
+                for sub_lang in requested_langs:
+                    if not sub_lang in available_subs_list:
+                        self._downloader.report_warning(u'no closed captions found in the specified language "%s"' % sub_lang)
+                        continue
+                    sub_lang_list[sub_lang] = available_subs_list[sub_lang]
 
         subtitles = {}
-        for sub_lang, url in sub_lang_list.iteritems():
+        for sub_lang, url in sub_lang_list.items():
             subtitle = self._request_subtitle_url(sub_lang, url)
             if subtitle:
                 subtitles[sub_lang] = subtitle
         return subtitles
 
     def _request_subtitle_url(self, sub_lang, url):
+        """ makes the http request for the subtitle """
         try:
             sub = compat_urllib_request.urlopen(url).read().decode('utf-8')
         except (compat_urllib_error.URLError, compat_http_client.HTTPException, socket.error) as err:
@@ -62,12 +62,19 @@ class SubtitlesIE(InfoExtractor):
         return sub
 
     def _get_available_subtitles(self, video_id):
-        """returns the list of available subtitles like this {lang: url} """
-        """or {} if not available. Must be redefined by the subclasses."""
+        """ returns {sub_lang: url} or {} if not available """
+        """ Must be redefined by the subclasses """
         pass
 
     def _request_automatic_caption(self, video_id, webpage):
-        """Request automatic caption. Redefine in subclasses."""
-        """returns a tuple of ... """
-        # return [(err_msg, None, None)]
+        """ returns {sub_lang: sub} or {} if not available """
+        """ Must be redefined by the subclasses """
         pass
+
+
+class NoAutoSubtitlesIE(SubtitlesIE):
+    """ A subtitle class for the servers that don't support auto-captions"""
+
+    def _request_automatic_caption(self, video_id, webpage):
+        self._downloader.report_warning(u'Automatic Captions not supported by this server')
+        return {}