KeyArgo
/
youtube-transcript-api
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add preserve_formatting docstrings

This commit is contained in:
E. Seiver 2023-04-11 16:37:06 -07:00
parent e88783d69e
commit 393a76ca6a
2 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
youtube_transcript_api/_api.py
View File

@ -61,6 +61,8 @@ class YouTubeTranscriptApi(object):
:type proxies: {'http': str, 'https': str} - http://docs.python-requests.org/en/master/user/advanced/#proxies :type proxies: {'http': str, 'https': str} - http://docs.python-requests.org/en/master/user/advanced/#proxies
:param cookies: a string of the path to a text file containing youtube authorization cookies :param cookies: a string of the path to a text file containing youtube authorization cookies
:type cookies: str :type cookies: str
:param preserve_formatting: whether to keep select HTML text formatting
:type preserve_formatting: bool
:return: the list of available transcripts :return: the list of available transcripts
:rtype TranscriptList: :rtype TranscriptList:
""" """
@ -126,6 +128,8 @@ class YouTubeTranscriptApi(object):
:type proxies: {'http': str, 'https': str} - http://docs.python-requests.org/en/master/user/advanced/#proxies :type proxies: {'http': str, 'https': str} - http://docs.python-requests.org/en/master/user/advanced/#proxies
:param cookies: a string of the path to a text file containing youtube authorization cookies :param cookies: a string of the path to a text file containing youtube authorization cookies
:type cookies: str :type cookies: str
:param preserve_formatting: whether to keep select HTML text formatting
:type preserve_formatting: bool
:return: a list of dictionaries containing the 'text', 'start' and 'duration' keys :return: a list of dictionaries containing the 'text', 'start' and 'duration' keys
:rtype [{'text': str, 'start': float, 'end': float}]: :rtype [{'text': str, 'start': float, 'end': float}]:
""" """

5
youtube_transcript_api/_transcripts.py
View File

@ -137,6 +137,8 @@ class TranscriptList(object):
:type video_id: str :type video_id: str
:param captions_json: the JSON parsed from the YouTube pages static HTML :param captions_json: the JSON parsed from the YouTube pages static HTML
:type captions_json: dict :type captions_json: dict
:param preserve_formatting: whether to keep select HTML text formatting
:type preserve_formatting: bool
:return: the created TranscriptList :return: the created TranscriptList
:rtype TranscriptList: :rtype TranscriptList:
""" """
@ -279,7 +281,8 @@ class Transcript(object):
:param language_code: :param language_code:
:param is_generated: :param is_generated:
:param translation_languages: :param translation_languages:
:param preserve_formatting: whether to keep select HTMl text formatting :param preserve_formatting: whether to keep select HTML text formatting
:type preserve_formatting: bool
""" """
self._http_client = http_client self._http_client = http_client
self.video_id = video_id self.video_id = video_id