mirror of
https://github.com/devine-dl/devine.git
synced 2025-04-29 17:49:44 +00:00
c06ea4cea8
Overall this commit is to just make working with Chapters a lot less manual and convoluted. The current system has you specify information that can easily be automated, like Chapter order and numbers, which is one of the main changes in this commit.
Note: This is a Breaking change and requires updates to your Service code. The `get_chapters()` method must be updated. For more information see the updated doc-string for `Service.get_chapters()`.
- Added new Chapters class which automatically sorts Chapters by timestamp.
- Chapter class has been significantly reworked to be much more generic. Most operations have been mvoed to the new Chapters class.
- Chapter objects can no longer specify a Chapter number. The number is now automatically set based on it's sorted order in the Chapters object, which is all done automatically.
- Chapter objects can now provide a timestamp in more formats. Timestamp's are now verified more efficiently.
- Chapter objects ID is now a crc32 hash of the timestamp and name instead of just basically their number.
- The Chapters object now also has an ID which is also a crc32 hash of all of the Chapter IDs it holds. This ID can be used for stuff like temp paths.
- `Service.get_chapters()` must now return a Chapters object. The Chapters object may be empty. The Chapters object must hold Chapter objects.
- Using `Chapter {N}` or `Act {N}` Chapters and so on is no longer permitted. You should instead leave the name blank if there's no descriptive name to use for it.
- If you or a user wants `Chapter {N}` names, then they can use the config option `chapter_fallback_name` set to `"Chapter {i:02}"`. See the config documentation for more info.
- Do not add a `00:00:00.000` Chapter, at all. This is automatically added for you if there's at least 1 Chapter with a timestamp after `00:00:00.000`.
111 lines
4.3 KiB
Python
111 lines
4.3 KiB
Python
from __future__ import annotations
|
|
|
|
import tempfile
|
|
from pathlib import Path
|
|
from typing import Any, Optional
|
|
|
|
import yaml
|
|
from appdirs import AppDirs
|
|
|
|
|
|
class Config:
|
|
class _Directories:
|
|
# default directories, do not modify here, set via config
|
|
app_dirs = AppDirs("devine", False)
|
|
core_dir = Path(__file__).resolve().parent
|
|
namespace_dir = core_dir.parent
|
|
commands = namespace_dir / "commands"
|
|
services = namespace_dir / "services"
|
|
vaults = namespace_dir / "vaults"
|
|
user_configs = Path(app_dirs.user_config_dir)
|
|
data = Path(app_dirs.user_data_dir)
|
|
downloads = Path.home() / "Downloads" / "devine"
|
|
temp = Path(tempfile.gettempdir()) / "devine"
|
|
cache = Path(app_dirs.user_cache_dir)
|
|
cookies = data / "Cookies"
|
|
logs = Path(app_dirs.user_log_dir)
|
|
wvds = data / "WVDs"
|
|
dcsl = data / "DCSL"
|
|
|
|
class _Filenames:
|
|
# default filenames, do not modify here, set via config
|
|
log = "devine_{name}_{time}.log" # Directories.logs
|
|
config = "config.yaml" # Directories.services / tag
|
|
root_config = "devine.yaml" # Directories.user_configs
|
|
chapters = "Chapters_{title}_{random}.txt" # Directories.temp
|
|
subtitle = "Subtitle_{id}_{language}.srt" # Directories.temp
|
|
|
|
def __init__(self, **kwargs: Any):
|
|
self.dl: dict = kwargs.get("dl") or {}
|
|
self.aria2c: dict = kwargs.get("aria2c") or {}
|
|
self.cdm: dict = kwargs.get("cdm") or {}
|
|
self.chapter_fallback_name: str = kwargs.get("chapter_fallback_name") or ""
|
|
self.curl_impersonate: dict = kwargs.get("curl_impersonate") or {}
|
|
self.remote_cdm: list[dict] = kwargs.get("remote_cdm") or []
|
|
self.credentials: dict = kwargs.get("credentials") or {}
|
|
|
|
self.directories = self._Directories()
|
|
for name, path in (kwargs.get("directories") or {}).items():
|
|
if name.lower() in ("app_dirs", "core_dir", "namespace_dir", "user_configs", "data"):
|
|
# these must not be modified by the user
|
|
continue
|
|
setattr(self.directories, name, Path(path).expanduser())
|
|
|
|
self.downloader = kwargs.get("downloader") or "requests"
|
|
|
|
self.filenames = self._Filenames()
|
|
for name, filename in (kwargs.get("filenames") or {}).items():
|
|
setattr(self.filenames, name, filename)
|
|
|
|
self.headers: dict = kwargs.get("headers") or {}
|
|
self.key_vaults: list[dict[str, Any]] = kwargs.get("key_vaults", [])
|
|
self.muxing: dict = kwargs.get("muxing") or {}
|
|
self.nordvpn: dict = kwargs.get("nordvpn") or {}
|
|
self.proxy_providers: dict = kwargs.get("proxy_providers") or {}
|
|
self.serve: dict = kwargs.get("serve") or {}
|
|
self.services: dict = kwargs.get("services") or {}
|
|
self.set_terminal_bg: bool = kwargs.get("set_terminal_bg", True)
|
|
self.tag: str = kwargs.get("tag") or ""
|
|
|
|
@classmethod
|
|
def from_yaml(cls, path: Path) -> Config:
|
|
if not path.exists():
|
|
raise FileNotFoundError(f"Config file path ({path}) was not found")
|
|
if not path.is_file():
|
|
raise FileNotFoundError(f"Config file path ({path}) is not to a file.")
|
|
return cls(**yaml.safe_load(path.read_text(encoding="utf8")) or {})
|
|
|
|
|
|
def get_config_path() -> Optional[Path]:
|
|
"""
|
|
Get Path to Config from various locations.
|
|
|
|
Looks for a config file in the following folders in order:
|
|
|
|
1. The Devine Namespace Folder (e.g., %appdata%/Python/Python311/site-packages/devine)
|
|
2. The Parent Folder to the Devine Namespace Folder (e.g., %appdata%/Python/Python311/site-packages)
|
|
3. The AppDirs User Config Folder (e.g., %localappdata%/devine)
|
|
|
|
Returns None if no config file could be found.
|
|
"""
|
|
# noinspection PyProtectedMember
|
|
path = Config._Directories.namespace_dir / Config._Filenames.root_config
|
|
if not path.exists():
|
|
# noinspection PyProtectedMember
|
|
path = Config._Directories.namespace_dir.parent / Config._Filenames.root_config
|
|
if not path.exists():
|
|
# noinspection PyProtectedMember
|
|
path = Config._Directories.user_configs / Config._Filenames.root_config
|
|
if not path.exists():
|
|
path = None
|
|
return path
|
|
|
|
|
|
config_path = get_config_path()
|
|
if config_path:
|
|
config = Config.from_yaml(config_path)
|
|
else:
|
|
config = Config()
|
|
|
|
__all__ = ("config",)
|