[REFACTOR] Base Downloader class
This commit is contained in:
parent
52c1cc437d
commit
ab1824ee1c
5 changed files with 40 additions and 28 deletions
|
|
@ -17,7 +17,7 @@ from ytdl_sub.config.preset_class_mappings import PluginMapping
|
||||||
from ytdl_sub.config.preset_options import OutputOptions
|
from ytdl_sub.config.preset_options import OutputOptions
|
||||||
from ytdl_sub.config.preset_options import Overrides
|
from ytdl_sub.config.preset_options import Overrides
|
||||||
from ytdl_sub.config.preset_options import YTDLOptions
|
from ytdl_sub.config.preset_options import YTDLOptions
|
||||||
from ytdl_sub.downloaders.downloader import Downloader
|
from ytdl_sub.downloaders.downloader import BaseDownloader
|
||||||
from ytdl_sub.downloaders.downloader import DownloaderValidator
|
from ytdl_sub.downloaders.downloader import DownloaderValidator
|
||||||
from ytdl_sub.entries.entry import Entry
|
from ytdl_sub.entries.entry import Entry
|
||||||
from ytdl_sub.plugins.plugin import Plugin
|
from ytdl_sub.plugins.plugin import Plugin
|
||||||
|
|
@ -123,7 +123,7 @@ class DownloadStrategyValidator(StrictDictValidator):
|
||||||
validator=StringValidator,
|
validator=StringValidator,
|
||||||
).value
|
).value
|
||||||
|
|
||||||
def get(self, downloader_source: str) -> Type[Downloader]:
|
def get(self, downloader_source: str) -> Type[BaseDownloader]:
|
||||||
"""
|
"""
|
||||||
Parameters
|
Parameters
|
||||||
----------
|
----------
|
||||||
|
|
@ -243,13 +243,13 @@ class Preset(_PresetShell):
|
||||||
def _source_variables(self) -> List[str]:
|
def _source_variables(self) -> List[str]:
|
||||||
return Entry.source_variables()
|
return Entry.source_variables()
|
||||||
|
|
||||||
def __validate_and_get_downloader(self, downloader_source: str) -> Type[Downloader]:
|
def __validate_and_get_downloader(self, downloader_source: str) -> Type[BaseDownloader]:
|
||||||
return self._validate_key(key=downloader_source, validator=DownloadStrategyValidator).get(
|
return self._validate_key(key=downloader_source, validator=DownloadStrategyValidator).get(
|
||||||
downloader_source=downloader_source
|
downloader_source=downloader_source
|
||||||
)
|
)
|
||||||
|
|
||||||
def __validate_and_get_downloader_options(
|
def __validate_and_get_downloader_options(
|
||||||
self, downloader_source: str, downloader: Type[Downloader]
|
self, downloader_source: str, downloader: Type[BaseDownloader]
|
||||||
) -> DownloaderValidator:
|
) -> DownloaderValidator:
|
||||||
# Remove the download_strategy key before validating it against the downloader options
|
# Remove the download_strategy key before validating it against the downloader options
|
||||||
# TODO: make this cleaner
|
# TODO: make this cleaner
|
||||||
|
|
@ -260,8 +260,8 @@ class Preset(_PresetShell):
|
||||||
|
|
||||||
def __validate_and_get_downloader_and_options(
|
def __validate_and_get_downloader_and_options(
|
||||||
self,
|
self,
|
||||||
) -> Tuple[Type[Downloader], DownloaderValidator]:
|
) -> Tuple[Type[BaseDownloader], DownloaderValidator]:
|
||||||
downloader: Optional[Type[Downloader]] = None
|
downloader: Optional[Type[BaseDownloader]] = None
|
||||||
download_options: Optional[DownloaderValidator] = None
|
download_options: Optional[DownloaderValidator] = None
|
||||||
downloader_sources = DownloadStrategyMapping.sources()
|
downloader_sources = DownloadStrategyMapping.sources()
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,7 @@ from typing import Dict
|
||||||
from typing import List
|
from typing import List
|
||||||
from typing import Type
|
from typing import Type
|
||||||
|
|
||||||
|
from ytdl_sub.downloaders.downloader import BaseDownloader
|
||||||
from ytdl_sub.downloaders.downloader import Downloader
|
from ytdl_sub.downloaders.downloader import Downloader
|
||||||
from ytdl_sub.downloaders.generic.multi_url import MultiUrlDownloader
|
from ytdl_sub.downloaders.generic.multi_url import MultiUrlDownloader
|
||||||
from ytdl_sub.downloaders.generic.url import UrlDownloader
|
from ytdl_sub.downloaders.generic.url import UrlDownloader
|
||||||
|
|
@ -26,7 +27,7 @@ class DownloadStrategyMapping:
|
||||||
Maps downloader strategies defined in the preset to its respective downloader class
|
Maps downloader strategies defined in the preset to its respective downloader class
|
||||||
"""
|
"""
|
||||||
|
|
||||||
_MAPPING: Dict[str, Dict[str, Type[Downloader]]] = {
|
_MAPPING: Dict[str, Dict[str, Type[BaseDownloader]]] = {
|
||||||
"download": {
|
"download": {
|
||||||
"multi_url": MultiUrlDownloader,
|
"multi_url": MultiUrlDownloader,
|
||||||
"url": UrlDownloader,
|
"url": UrlDownloader,
|
||||||
|
|
|
||||||
|
|
@ -100,18 +100,34 @@ class URLDownloadState:
|
||||||
self.thumbnails_downloaded: Set[str] = set()
|
self.thumbnails_downloaded: Set[str] = set()
|
||||||
|
|
||||||
|
|
||||||
class Downloader(DownloadArchiver, Generic[DownloaderOptionsT], ABC):
|
class BaseDownloader(DownloadArchiver, Generic[DownloaderOptionsT], ABC):
|
||||||
|
downloader_options_type: Type[DownloaderValidator] = DownloaderValidator
|
||||||
|
|
||||||
|
def __init__(
|
||||||
|
self,
|
||||||
|
download_options: DownloaderOptionsT,
|
||||||
|
enhanced_download_archive: EnhancedDownloadArchive,
|
||||||
|
download_ytdl_options: YTDLOptionsBuilder,
|
||||||
|
metadata_ytdl_options: YTDLOptionsBuilder,
|
||||||
|
overrides: Overrides,
|
||||||
|
):
|
||||||
|
super().__init__(enhanced_download_archive=enhanced_download_archive)
|
||||||
|
self.download_options = download_options
|
||||||
|
self.overrides = overrides
|
||||||
|
self._download_ytdl_options_builder = download_ytdl_options
|
||||||
|
self._metadata_ytdl_options_builder = metadata_ytdl_options
|
||||||
|
|
||||||
|
@abc.abstractmethod
|
||||||
|
def download(self) -> Iterable[Entry] | Iterable[Tuple[Entry, FileMetadata]]:
|
||||||
|
"""The function to perform the download of all media entries"""
|
||||||
|
|
||||||
|
|
||||||
|
class Downloader(BaseDownloader[DownloaderOptionsT], ABC):
|
||||||
"""
|
"""
|
||||||
Class that interacts with ytdl to perform the download of metadata and content,
|
Class that interacts with ytdl to perform the download of metadata and content,
|
||||||
and should translate that to list of Entry objects.
|
and should translate that to list of Entry objects.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
downloader_options_type: Type[DownloaderValidator] = DownloaderValidator
|
|
||||||
|
|
||||||
supports_download_archive: bool = True
|
|
||||||
supports_subtitles: bool = True
|
|
||||||
supports_chapters: bool = True
|
|
||||||
|
|
||||||
_extract_entry_num_retries: int = 5
|
_extract_entry_num_retries: int = 5
|
||||||
_extract_entry_retry_wait_sec: int = 5
|
_extract_entry_retry_wait_sec: int = 5
|
||||||
|
|
||||||
|
|
@ -147,13 +163,14 @@ class Downloader(DownloadArchiver, Generic[DownloaderOptionsT], ABC):
|
||||||
overrides
|
overrides
|
||||||
Override variables
|
Override variables
|
||||||
"""
|
"""
|
||||||
DownloadArchiver.__init__(self=self, enhanced_download_archive=enhanced_download_archive)
|
super().__init__(
|
||||||
self.download_options = download_options
|
download_options=download_options,
|
||||||
self.overrides = overrides
|
enhanced_download_archive=enhanced_download_archive,
|
||||||
self._download_ytdl_options_builder = download_ytdl_options
|
download_ytdl_options=download_ytdl_options,
|
||||||
self._metadata_ytdl_options_builder = metadata_ytdl_options
|
metadata_ytdl_options=metadata_ytdl_options,
|
||||||
|
overrides=overrides,
|
||||||
|
)
|
||||||
self._downloaded_entries: Set[str] = set()
|
self._downloaded_entries: Set[str] = set()
|
||||||
|
|
||||||
self._url_state: Optional[URLDownloadState] = None
|
self._url_state: Optional[URLDownloadState] = None
|
||||||
|
|
||||||
@property
|
@property
|
||||||
|
|
|
||||||
|
|
@ -130,10 +130,7 @@ class BaseSubscription(ABC):
|
||||||
-------
|
-------
|
||||||
Whether to maintain a download archive
|
Whether to maintain a download archive
|
||||||
"""
|
"""
|
||||||
return (
|
return self.output_options.maintain_download_archive
|
||||||
self.output_options.maintain_download_archive
|
|
||||||
and self.downloader_class.supports_download_archive
|
|
||||||
)
|
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def num_entries_added(self) -> int:
|
def num_entries_added(self) -> int:
|
||||||
|
|
|
||||||
|
|
@ -82,10 +82,7 @@ class SubscriptionYTDLOptions:
|
||||||
def _output_options(self) -> Dict:
|
def _output_options(self) -> Dict:
|
||||||
ytdl_options = {}
|
ytdl_options = {}
|
||||||
|
|
||||||
if (
|
if self._preset.output_options.maintain_download_archive:
|
||||||
self._downloader.supports_download_archive
|
|
||||||
and self._preset.output_options.maintain_download_archive
|
|
||||||
):
|
|
||||||
ytdl_options["download_archive"] = str(
|
ytdl_options["download_archive"] = str(
|
||||||
Path(self._working_directory) / self._enhanced_download_archive.archive_file_name
|
Path(self._working_directory) / self._enhanced_download_archive.archive_file_name
|
||||||
)
|
)
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue