[subtitles] Improved docs + new class for servers who don't support

auto-caption
This commit is contained in:
Ismael Mejia 2013-08-08 11:20:56 +02:00
parent 447591e1ae
commit 69df680b97
2 changed files with 19 additions and 22 deletions

View file

@ -3,7 +3,7 @@
import socket
from .common import InfoExtractor
from .subtitles import SubtitlesIE
from .subtitles import NoAutoSubtitlesIE
from ..utils import (
compat_http_client,
@ -17,7 +17,7 @@
)
class DailyMotionSubtitlesIE(SubtitlesIE):
class DailyMotionSubtitlesIE(NoAutoSubtitlesIE):
def _get_available_subtitles(self, video_id):
request = compat_urllib_request.Request('https://api.dailymotion.com/video/%s/subtitles?fields=id,language,url' % video_id)
@ -33,11 +33,6 @@ def _get_available_subtitles(self, video_id):
self._downloader.report_warning(u'video doesn\'t have subtitles')
return {}
def _request_automatic_caption(self, video_id, webpage):
self._downloader.report_warning(u'Automatic Captions not supported by this server')
return {}
class DailymotionIE(DailyMotionSubtitlesIE):
"""Information Extractor for Dailymotion"""

View file

@ -12,21 +12,15 @@
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
"""
""" returns {sub_lang: sub} or {} if subtitles not found """
sub_lang_list = self._get_available_subtitles(video_id)
if not sub_lang_list: # error, it didn't get the available subtitles
return {}
@ -51,6 +45,7 @@ def _extract_subtitles(self, video_id):
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 +57,19 @@ def _request_subtitle_url(self, sub_lang, url):
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 {}