[REFACTOR] Shared plugin and download options class
This commit is contained in:
parent
a96fcff55f
commit
f46a1f3e98
5 changed files with 29 additions and 42 deletions
|
|
@ -6,7 +6,6 @@ from typing import List
|
||||||
from typing import Optional
|
from typing import Optional
|
||||||
from typing import Tuple
|
from typing import Tuple
|
||||||
from typing import Type
|
from typing import Type
|
||||||
from typing import TypeVar
|
|
||||||
from typing import Union
|
from typing import Union
|
||||||
|
|
||||||
from mergedeep import mergedeep
|
from mergedeep import mergedeep
|
||||||
|
|
@ -22,6 +21,7 @@ from ytdl_sub.downloaders.base_downloader import BaseDownloaderValidator
|
||||||
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
|
||||||
from ytdl_sub.plugins.plugin import PluginOptions
|
from ytdl_sub.plugins.plugin import PluginOptions
|
||||||
|
from ytdl_sub.plugins.plugin import PluginOptionsT
|
||||||
from ytdl_sub.prebuilt_presets import PREBUILT_PRESET_NAMES
|
from ytdl_sub.prebuilt_presets import PREBUILT_PRESET_NAMES
|
||||||
from ytdl_sub.prebuilt_presets import PUBLISHED_PRESET_NAMES
|
from ytdl_sub.prebuilt_presets import PUBLISHED_PRESET_NAMES
|
||||||
from ytdl_sub.utils.exceptions import ValidationException
|
from ytdl_sub.utils.exceptions import ValidationException
|
||||||
|
|
@ -65,8 +65,6 @@ def _parent_preset_error_message(
|
||||||
|
|
||||||
|
|
||||||
class PresetPlugins:
|
class PresetPlugins:
|
||||||
_TPluginOptions = TypeVar("_TPluginOptions", bound=PluginOptions)
|
|
||||||
|
|
||||||
def __init__(self):
|
def __init__(self):
|
||||||
self.plugin_types: List[Type[Plugin]] = []
|
self.plugin_types: List[Type[Plugin]] = []
|
||||||
self.plugin_options: List[PluginOptions] = []
|
self.plugin_options: List[PluginOptions] = []
|
||||||
|
|
@ -87,7 +85,7 @@ class PresetPlugins:
|
||||||
"""
|
"""
|
||||||
return zip(self.plugin_types, self.plugin_options)
|
return zip(self.plugin_types, self.plugin_options)
|
||||||
|
|
||||||
def get(self, plugin_type: Type[_TPluginOptions]) -> Optional[_TPluginOptions]:
|
def get(self, plugin_type: Type[PluginOptionsT]) -> Optional[PluginOptionsT]:
|
||||||
"""
|
"""
|
||||||
Parameters
|
Parameters
|
||||||
----------
|
----------
|
||||||
|
|
|
||||||
|
|
@ -7,6 +7,7 @@ from typing import Optional
|
||||||
from yt_dlp.utils import sanitize_filename
|
from yt_dlp.utils import sanitize_filename
|
||||||
|
|
||||||
from ytdl_sub.entries.entry import Entry
|
from ytdl_sub.entries.entry import Entry
|
||||||
|
from ytdl_sub.utils.exceptions import ValidationException
|
||||||
from ytdl_sub.validators.file_path_validators import OverridesStringFormatterFilePathValidator
|
from ytdl_sub.validators.file_path_validators import OverridesStringFormatterFilePathValidator
|
||||||
from ytdl_sub.validators.file_path_validators import StringFormatterFileNameValidator
|
from ytdl_sub.validators.file_path_validators import StringFormatterFileNameValidator
|
||||||
from ytdl_sub.validators.strict_dict_validator import StrictDictValidator
|
from ytdl_sub.validators.strict_dict_validator import StrictDictValidator
|
||||||
|
|
@ -20,11 +21,28 @@ from ytdl_sub.validators.validators import LiteralDictValidator
|
||||||
|
|
||||||
# pylint: disable=no-self-use
|
# pylint: disable=no-self-use
|
||||||
# pylint: disable=unused-argument
|
# pylint: disable=unused-argument
|
||||||
class AddsVariablesMixin(ABC):
|
class OptionsValidator(StrictDictValidator, ABC):
|
||||||
"""
|
"""
|
||||||
Mixin for parts of the Preset that adds source variables
|
Abstract class that validates options for preset sections (plugins, downloaders)
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
def validation_exception(
|
||||||
|
self,
|
||||||
|
error_message: str | Exception,
|
||||||
|
) -> ValidationException:
|
||||||
|
"""
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
error_message
|
||||||
|
Error message to include in the validation exception
|
||||||
|
|
||||||
|
Returns
|
||||||
|
-------
|
||||||
|
Validation exception that points to the location in the config. To be used to throw good
|
||||||
|
validation exceptions at runtime from code outside this class.
|
||||||
|
"""
|
||||||
|
return self._validation_exception(error_message=error_message)
|
||||||
|
|
||||||
def added_source_variables(self) -> List[str]:
|
def added_source_variables(self) -> List[str]:
|
||||||
"""
|
"""
|
||||||
If the plugin adds source variables, list them here.
|
If the plugin adds source variables, list them here.
|
||||||
|
|
|
||||||
|
|
@ -6,21 +6,16 @@ from typing import List
|
||||||
from typing import Type
|
from typing import Type
|
||||||
from typing import TypeVar
|
from typing import TypeVar
|
||||||
|
|
||||||
from ytdl_sub.config.preset_options import AddsVariablesMixin
|
from ytdl_sub.config.preset_options import OptionsValidator
|
||||||
from ytdl_sub.config.preset_options import Overrides
|
from ytdl_sub.config.preset_options import Overrides
|
||||||
from ytdl_sub.downloaders.ytdl_options_builder import YTDLOptionsBuilder
|
from ytdl_sub.downloaders.ytdl_options_builder import YTDLOptionsBuilder
|
||||||
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
|
||||||
from ytdl_sub.plugins.plugin import PluginOptions
|
from ytdl_sub.plugins.plugin import PluginOptions
|
||||||
from ytdl_sub.validators.strict_dict_validator import StrictDictValidator
|
|
||||||
from ytdl_sub.ytdl_additions.enhanced_download_archive import DownloadArchiver
|
from ytdl_sub.ytdl_additions.enhanced_download_archive import DownloadArchiver
|
||||||
from ytdl_sub.ytdl_additions.enhanced_download_archive import EnhancedDownloadArchive
|
from ytdl_sub.ytdl_additions.enhanced_download_archive import EnhancedDownloadArchive
|
||||||
|
|
||||||
|
BaseDownloaderValidator = OptionsValidator
|
||||||
class BaseDownloaderValidator(StrictDictValidator, AddsVariablesMixin, ABC):
|
|
||||||
pass
|
|
||||||
|
|
||||||
|
|
||||||
BaseDownloaderOptionsT = TypeVar("BaseDownloaderOptionsT", bound=BaseDownloaderValidator)
|
BaseDownloaderOptionsT = TypeVar("BaseDownloaderOptionsT", bound=BaseDownloaderValidator)
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -28,7 +23,7 @@ class BaseDownloaderPluginOptions(PluginOptions):
|
||||||
_optional_keys = {"no-op"}
|
_optional_keys = {"no-op"}
|
||||||
|
|
||||||
|
|
||||||
class BaseDownloaderPlugin(Plugin[BaseDownloaderPluginOptions], ABC):
|
class BaseDownloaderPlugin(Plugin[BaseDownloaderOptionsT], Generic[BaseDownloaderOptionsT], ABC):
|
||||||
def __init__(
|
def __init__(
|
||||||
self,
|
self,
|
||||||
overrides: Overrides,
|
overrides: Overrides,
|
||||||
|
|
|
||||||
|
|
@ -3,7 +3,7 @@ from typing import Dict
|
||||||
from typing import List
|
from typing import List
|
||||||
from typing import Optional
|
from typing import Optional
|
||||||
|
|
||||||
from ytdl_sub.config.preset_options import AddsVariablesMixin
|
from ytdl_sub.config.preset_options import OptionsValidator
|
||||||
from ytdl_sub.validators.strict_dict_validator import StrictDictValidator
|
from ytdl_sub.validators.strict_dict_validator import StrictDictValidator
|
||||||
from ytdl_sub.validators.string_formatter_validators import DictFormatterValidator
|
from ytdl_sub.validators.string_formatter_validators import DictFormatterValidator
|
||||||
from ytdl_sub.validators.string_formatter_validators import OverridesStringFormatterValidator
|
from ytdl_sub.validators.string_formatter_validators import OverridesStringFormatterValidator
|
||||||
|
|
@ -174,7 +174,7 @@ class UrlListValidator(ListValidator[UrlValidator]):
|
||||||
collection_variables[var] = added_variables[var]
|
collection_variables[var] = added_variables[var]
|
||||||
|
|
||||||
|
|
||||||
class MultiUrlValidator(StrictDictValidator, AddsVariablesMixin):
|
class MultiUrlValidator(OptionsValidator):
|
||||||
"""
|
"""
|
||||||
Downloads from multiple URLs. If an entry is returned from more than one URL, it will
|
Downloads from multiple URLs. If an entry is returned from more than one URL, it will
|
||||||
resolve to the bottom-most URL settings.
|
resolve to the bottom-most URL settings.
|
||||||
|
|
|
||||||
|
|
@ -7,13 +7,11 @@ from typing import Tuple
|
||||||
from typing import Type
|
from typing import Type
|
||||||
from typing import TypeVar
|
from typing import TypeVar
|
||||||
|
|
||||||
from ytdl_sub.config.preset_options import AddsVariablesMixin
|
from ytdl_sub.config.preset_options import OptionsValidator
|
||||||
from ytdl_sub.config.preset_options import Overrides
|
from ytdl_sub.config.preset_options import Overrides
|
||||||
from ytdl_sub.entries.entry import Entry
|
from ytdl_sub.entries.entry import Entry
|
||||||
from ytdl_sub.utils.exceptions import ValidationException
|
|
||||||
from ytdl_sub.utils.file_handler import FileMetadata
|
from ytdl_sub.utils.file_handler import FileMetadata
|
||||||
from ytdl_sub.utils.logger import Logger
|
from ytdl_sub.utils.logger import Logger
|
||||||
from ytdl_sub.validators.strict_dict_validator import StrictDictValidator
|
|
||||||
from ytdl_sub.ytdl_additions.enhanced_download_archive import DownloadArchiver
|
from ytdl_sub.ytdl_additions.enhanced_download_archive import DownloadArchiver
|
||||||
from ytdl_sub.ytdl_additions.enhanced_download_archive import EnhancedDownloadArchive
|
from ytdl_sub.ytdl_additions.enhanced_download_archive import EnhancedDownloadArchive
|
||||||
|
|
||||||
|
|
@ -40,29 +38,7 @@ class PluginPriority:
|
||||||
return self.modify_entry >= PluginPriority.MODIFY_ENTRY_AFTER_SPLIT
|
return self.modify_entry >= PluginPriority.MODIFY_ENTRY_AFTER_SPLIT
|
||||||
|
|
||||||
|
|
||||||
class PluginOptions(StrictDictValidator, AddsVariablesMixin, ABC):
|
PluginOptions = OptionsValidator
|
||||||
"""
|
|
||||||
Class that defines the parameters to a plugin
|
|
||||||
"""
|
|
||||||
|
|
||||||
def validation_exception(
|
|
||||||
self,
|
|
||||||
error_message: str | Exception,
|
|
||||||
) -> ValidationException:
|
|
||||||
"""
|
|
||||||
Parameters
|
|
||||||
----------
|
|
||||||
error_message
|
|
||||||
Error message to include in the validation exception
|
|
||||||
|
|
||||||
Returns
|
|
||||||
-------
|
|
||||||
Validation exception that points to the location in the config. To be used for plugins
|
|
||||||
to throw good validation exceptions at runtime.
|
|
||||||
"""
|
|
||||||
return self._validation_exception(error_message=error_message)
|
|
||||||
|
|
||||||
|
|
||||||
PluginOptionsT = TypeVar("PluginOptionsT", bound=PluginOptions)
|
PluginOptionsT = TypeVar("PluginOptionsT", bound=PluginOptions)
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue