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

docs

Browse source
This commit is contained in:
Jesse Bannon 2022-09-28 09:04:37 -07:00
parent 718b42f209
commit ac33698f93
2 changed files with 22 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
src/ytdl_sub/downloaders/downloader.py
View file

@ -415,10 +415,12 @@ class Downloader(DownloadArchiver, Generic[DownloaderOptionsT], ABC):
for child in entry.parent_children(): for child in entry.parent_children():
self._set_collection_variables(collection_url, child) self._set_collection_variables(collection_url, child)
for child in entry.entry_children(): for child in entry.entry_children():
child.add_variables(variables_to_add=collection_url.variables) child.add_variables(
variables_to_add=collection_url.variables.dict_with_format_strings
)
elif isinstance(entry, Entry): elif isinstance(entry, Entry):
entry.add_variables(variables_to_add=collection_url.variables) entry.add_variables(variables_to_add=collection_url.variables.dict_with_format_strings)
def _download_url_metadata( def _download_url_metadata(
self, collection_url: CollectionUrlValidator self, collection_url: CollectionUrlValidator

30
src/ytdl_sub/downloaders/generic/collection_validator.py
View file

@ -48,8 +48,9 @@ class CollectionUrlValidator(StrictDictValidator):
# TODO: url validate using yt-dlp IE # TODO: url validate using yt-dlp IE
self._url = self._validate_key(key="url", validator=StringValidator) self._url = self._validate_key(key="url", validator=StringValidator)
variables = self._validate_key_if_present(key="variables", validator=DictFormatterValidator) self._variables = self._validate_key_if_present(
self._variables = variables.dict_with_format_strings if variables else {} key="variables", validator=DictFormatterValidator, default={}
)
self._source_thumbnails = self._validate_key_if_present( self._source_thumbnails = self._validate_key_if_present(
key="source_thumbnails", validator=CollectionThumbnailListValidator, default=[] key="source_thumbnails", validator=CollectionThumbnailListValidator, default=[]
@ -61,23 +62,25 @@ class CollectionUrlValidator(StrictDictValidator):
@property @property
def url(self) -> str: def url(self) -> str:
""" """
Returns URL to download from, listed in priority from lowest (top) to highest (bottom). If a
------- download exists in more than one URL, it will resolve to the bottom-most one and inherit
URL to download from those variables.
""" """
return self._url.value return self._url.value
@property @property
def variables(self) -> Dict[str, str]: def variables(self) -> DictFormatterValidator:
""" """
Variables to add to each entry Source variables to add to each entry. The top-most collection must define all possible
variables. Collections below can redefine all of them or a subset of the top-most variables.
""" """
return self._variables return self._variables
@property @property
def source_thumbnails(self) -> Optional[CollectionThumbnailListValidator]: def source_thumbnails(self) -> Optional[CollectionThumbnailListValidator]:
""" """
TODO:docstring Thumbnails to download from the source, if any exist. The hierarchy is
source -> playlist -> entry.
""" """
return self._source_thumbnails return self._source_thumbnails
@ -96,13 +99,13 @@ class CollectionUrlListValidator(ListValidator[CollectionUrlValidator]):
def __init__(self, name, value): def __init__(self, name, value):
super().__init__(name, value) super().__init__(name, value)
added_variables: Dict[str, str] = self.list[0].variables added_variables: Dict[str, str] = self.list[0].variables.dict_with_format_strings
for idx, collection_url_validator in enumerate(self.list[1:]): for idx, collection_url_validator in enumerate(self.list[1:]):
collection_variables = collection_url_validator.variables collection_variables = collection_url_validator.variables
# see if this collection contains new added vars (it should not) # see if this collection contains new added vars (it should not)
for var in collection_variables.keys(): for var in collection_variables.keys:
if var not in added_variables: if var not in added_variables:
raise self._validation_exception( raise self._validation_exception(
f"Collection url {idx} contains the variable '{var}' that the first " f"Collection url {idx} contains the variable '{var}' that the first "
@ -141,7 +144,7 @@ class CollectionValidator(StrictDictValidator, AddsVariablesMixin):
------- -------
List of variables added. The first collection url always contains all the variables. List of variables added. The first collection url always contains all the variables.
""" """
return list(self._urls.list[0].variables.keys()) return list(self._urls.list[0].variables.keys)
def validate_with_variables( def validate_with_variables(
self, source_variables: List[str], override_variables: Dict[str, str] self, source_variables: List[str], override_variables: Dict[str, str]
@ -162,7 +165,10 @@ class CollectionValidator(StrictDictValidator, AddsVariablesMixin):
# Apply formatting to each new source variable, ensure it resolves # Apply formatting to each new source variable, ensure it resolves
for collection_url in self.collection_urls.list: for collection_url in self.collection_urls.list:
for source_var_name, source_var_formatter_str in collection_url.variables.items(): for (
source_var_name,
source_var_formatter_str,
) in collection_url.variables.dict_with_format_strings.items():
_ = StringFormatterValidator( _ = StringFormatterValidator(
name=f"{self._name}.{source_var_name}", value=source_var_formatter_str name=f"{self._name}.{source_var_name}", value=source_var_formatter_str
).apply_formatter(base_variables) ).apply_formatter(base_variables)