danvics/ytdl-sub
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

change order of docstrings

Browse source
This commit is contained in:
Jesse Bannon 2022-11-21 11:01:29 -08:00
parent 75cfeb9c57
commit 95bf0021d8
1 changed files with 18 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
src/ytdl_sub/plugins/chapters.py
View file

@ -138,6 +138,24 @@ class ChaptersOptions(PluginOptions):
""" """
return self._embed_chapters return self._embed_chapters
@property
def allow_chapters_from_comments(self) -> bool:
"""
Optional. If chapters do not exist in the video/description itself, attempt to scrape
comments to find the chapters. Defaults to False.
"""
return self._allow_chapters_from_comments
@property
def remove_chapters_regex(self) -> Optional[List[re.Pattern]]:
"""
Optional. List of regex patterns to match chapter titles against and remove them from the
entry.
"""
if self._remove_chapters_regex:
return [validator.compiled_regex for validator in self._remove_chapters_regex.list]
return None
@property @property
def sponsorblock_categories(self) -> Optional[List[str]]: def sponsorblock_categories(self) -> Optional[List[str]]:
""" """
@ -168,16 +186,6 @@ class ChaptersOptions(PluginOptions):
return category_list return category_list
return None return None
@property
def remove_chapters_regex(self) -> Optional[List[re.Pattern]]:
"""
Optional. List of regex patterns to match chapter titles against and remove them from the
entry.
"""
if self._remove_chapters_regex:
return [validator.compiled_regex for validator in self._remove_chapters_regex.list]
return None
@property @property
def force_key_frames(self) -> bool: def force_key_frames(self) -> bool:
""" """
@ -187,14 +195,6 @@ class ChaptersOptions(PluginOptions):
""" """
return self._force_key_frames return self._force_key_frames
@property
def allow_chapters_from_comments(self) -> bool:
"""
Optional. If chapters do not exist in the video/description itself, attempt to scrape
comments to find the chapters. Defaults to False.
"""
return self._allow_chapters_from_comments
class ChaptersPlugin(Plugin[ChaptersOptions]): class ChaptersPlugin(Plugin[ChaptersOptions]):
plugin_options_type = ChaptersOptions plugin_options_type = ChaptersOptions