from typing import Any from typing import Dict from typing import Optional from mergedeep import mergedeep from ytdl_sub.prebuilt_presets import PREBUILT_PRESETS from ytdl_sub.validators.strict_dict_validator import StrictDictValidator from ytdl_sub.validators.validators import LiteralDictValidator from ytdl_sub.validators.validators import StringValidator class ConfigOptions(StrictDictValidator): _required_keys = {"working_directory"} _optional_keys = {"umask", "dl_aliases", "lock_directory"} def __init__(self, name: str, value: Any): super().__init__(name, value) self._working_directory = self._validate_key( key="working_directory", validator=StringValidator ) self._umask = self._validate_key_if_present( key="umask", validator=StringValidator, default="022" ) self._dl_aliases = self._validate_key_if_present( key="dl_aliases", validator=LiteralDictValidator ) self._lock_directory = self._validate_key( key="lock_directory", validator=StringValidator, default="/tmp" ) @property def working_directory(self) -> str: """ The directory to temporarily store downloaded files before moving them into their final directory. """ return self._working_directory.value @property def umask(self) -> Optional[str]: """ Optional. Umask (octal format) to apply to every created file. Defaults to "022". """ return self._umask.value @property def dl_aliases(self) -> Optional[Dict[str, str]]: """ Optional. Alias definitions to shorten ``ytdl-sub dl`` arguments. For example, .. code-block:: yaml configuration: dl_aliases: mv: "--preset music_video" u: "--download.url" Simplifies .. code-block:: bash ytdl-sub dl --preset "music_video" --download.url "youtube.com/watch?v=a1b2c3" to .. code-block:: bash ytdl-sub dl --mv --u "youtube.com/watch?v=a1b2c3" """ if self._dl_aliases: return self._dl_aliases.dict return {} @property def lock_directory(self) -> str: """ Optional. The directory to temporarily store file locks, which prevents multiple instances of ``ytdl-sub`` from running. Note that file locks do not work on network-mounted directories. Ensure that this directory resides on the host machine. Defaults to ``/tmp``. """ return self._lock_directory.value class ConfigValidator(StrictDictValidator): _required_keys = {"configuration", "presets"} def __init__(self, name: str, value: Any): super().__init__(name, value) self.config_options = self._validate_key("configuration", ConfigOptions) # Make sure presets is a dictionary. Will be validated in `PresetValidator` self.presets = self._validate_key("presets", LiteralDictValidator) # Ensure custom presets do not collide with prebuilt presets for preset_name in self.presets.keys: if preset_name in PREBUILT_PRESETS: raise self._validation_exception( f"preset name '{preset_name}' conflicts with a prebuilt preset" ) # Merge prebuilt presets into the config so custom presets can use them mergedeep.merge(self.presets._value, PREBUILT_PRESETS)