ytptube/app/library/YTDLPOpts.py
2025-09-12 22:43:20 +03:00

205 lines
6 KiB
Python

import logging
from pathlib import Path
from .config import Config
from .Presets import Preset, Presets
from .Utils import REMOVE_KEYS, arg_converter, calc_download_path, load_cookies, merge_dict
LOG: logging.Logger = logging.getLogger("YTDLPOpts")
class YTDLPOpts:
def __init__(self):
self._config: Config = Config.get_instance()
"The config instance."
self._item_opts: dict = {}
"The item options."
self._preset_opts: dict = {}
"The preset options."
self._item_cli: list = []
"The command options for yt-dlp from item."
self._preset_cli: str = ""
"The command options for yt-dlp from preset."
@staticmethod
def get_instance() -> "YTDLPOpts":
"""
Get the instance of the class.
Returns:
Presets: The instance of the class
"""
return YTDLPOpts().reset()
def add_cli(self, args: str, from_user: int | bool = False) -> "YTDLPOpts":
"""
Parse and add command options for yt-dlp to the item options.
Args:
args (str): The command options for yt-dlp to add
from_user (bool): If the options are from the user
Returns:
YTDLPOpts: The instance of the class
"""
if not args or not isinstance(args, str) or len(args) < 2:
return self
try:
arg_converter(args=args, level=from_user)
except Exception as e:
msg = f"Invalid command options for yt-dlp were given. '{e!s}'."
raise ValueError(msg) from e
self._item_cli.append(args)
return self
def add(self, config: dict, from_user: bool = False) -> "YTDLPOpts":
"""
Add the options to the item options.
Args:
config (dict): The options to add
from_user (bool): If the options are from the user
Returns:
YTDLPOpts: The instance of the class
"""
bad_options: dict = {}
if from_user:
bad_options: dict[str, str] = {k: v for d in REMOVE_KEYS for k, v in d.items()}
for key, value in config.items():
if from_user and key in bad_options:
continue
self._item_opts[key] = value
return self
def preset(self, name: str) -> "YTDLPOpts":
"""
Add the preset options to the item options.
Args:
name (str): The name of the preset
Returns:
YTDLPOpts: The instance of the class
"""
preset: Preset | None = Presets.get_instance().get(name)
if not preset:
return self
if preset.cli:
try:
arg_converter(args=preset.cli, level=True)
self._preset_opts = {}
self._preset_cli = preset.cli
except Exception as e:
msg = f"Invalid preset '{preset.name}' command options for yt-dlp. '{e!s}'."
raise ValueError(msg) from e
if preset.cookies:
file: Path = Path(self._config.config_path) / "cookies" / f"{preset.id}.txt"
if not file.parent.exists():
file.parent.mkdir(parents=True, exist_ok=True)
file.write_text(preset.cookies)
try:
load_cookies(file)
self._preset_opts["cookiefile"] = str(file)
except ValueError as e:
LOG.error(f"Failed to load '{preset.name}' cookies from '{file}'. {e!s}")
if preset.template:
self._preset_opts["outtmpl"] = {"default": preset.template, "chapter": self._config.output_template_chapter}
if preset.folder:
self._preset_opts["paths"] = {
"home": calc_download_path(base_path=Path(self._config.download_path), folder=preset.folder),
"temp": self._config.temp_path,
}
return self
def get_all(self, keep: bool = False) -> dict:
"""
Get all the options.
Args:
keep (bool): If the options should be kept
Returns:
dict: The options
"""
default_opts: dict = {}
default_opts["paths"] = {"home": self._config.download_path, "temp": self._config.temp_path}
default_opts["outtmpl"] = {
"default": self._config.output_template,
"chapter": self._config.output_template_chapter,
}
if not isinstance(self._item_cli, list):
self._item_cli = []
merge: list[str] = []
if self._preset_cli and len(self._preset_cli) > 1:
merge.append(self._preset_cli)
if len(merge) > 0:
# prepend the yt-dlp command options to the list
self._item_cli = merge + self._item_cli
user_cli: dict = {}
if len(self._item_cli) > 0:
try:
user_cli = "\n".join(self._item_cli)
for k, v in self._config.get_replacers().items():
user_cli = user_cli.replace(f"%({k})s", v if isinstance(v, str) else str(v))
user_cli: dict = arg_converter(args=user_cli, level=True)
except Exception as e:
msg = f"Invalid command options for yt-dlp were given. '{e!s}'."
raise ValueError(msg) from e
data: dict = merge_dict(user_cli, merge_dict(self._item_opts, merge_dict(self._preset_opts, default_opts)))
if not keep:
self.reset()
if "format" in data:
if data["format"] in ["not_set", "default", "best"]:
data["format"] = None
if data["format"] == "-best":
data["format"] = data["format"][1:]
if self._config.debug:
LOG.debug(f"Final yt-dlp options: '{data!s}'.")
return data
def reset(self) -> "YTDLPOpts":
"""
Reset the item options.
Returns:
YTDLPOpts: The instance of the class
"""
self._item_opts = {}
self._item_cli = []
self._preset_cli = ""
self._preset_opts = {}
return self