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

[DOCS] Fix playlist thumbnail docs (#251)

Browse source
This commit is contained in:
Jesse Bannon 2022-09-28 00:17:18 -07:00 committed by GitHub
parent 839192059b
commit e2faffd59c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/config.rst
View file

@ -59,7 +59,7 @@ _______
playlist
________
.. autoclass:: ytdl_sub.downloaders.youtube.playlist.YoutubePlaylistDownloaderOptions()
:members: playlist_url
:members: playlist_url, playlist_thumbnail_name
:member-order: bysource
.. autofunction:: ytdl_sub.downloaders.youtube.playlist.YoutubePlaylistDownloader.ytdl_option_defaults()

8
src/ytdl_sub/downloaders/youtube/playlist.py
View file

@ -24,6 +24,8 @@ class YoutubePlaylistDownloaderOptions(DownloaderValidator):
# required
download_strategy: "playlist"
playlist_url: "https://www.youtube.com/playlist?list=UCsvn_Po0SmunchJYtttWpOxMg"
# optional
playlist_thumbnail_name: "poster.jpg"
"""
_required_keys = {"playlist_url"}
@ -42,10 +44,10 @@ class YoutubePlaylistDownloaderOptions(DownloaderValidator):
def collection_validator(self) -> CollectionValidator:
"""Downloads the playlist url"""
playlist_thumbnails: List[Dict] = []
if self.playlist_thumbnail_path:
if self.playlist_thumbnail_name:
playlist_thumbnails.append(
{
"name": self.playlist_thumbnail_path.format_string,
"name": self.playlist_thumbnail_name.format_string,
"uid": ThumbnailTypes.LATEST_ENTRY,
}
)
@ -72,7 +74,7 @@ class YoutubePlaylistDownloaderOptions(DownloaderValidator):
return self._playlist_url
@property
def playlist_thumbnail_path(self) -> Optional[OverridesStringFormatterValidator]:
def playlist_thumbnail_name(self) -> Optional[OverridesStringFormatterValidator]:
"""
Optional. Path to store the playlist's thumbnail
"""