maybe ready?
This commit is contained in:
Jesse Bannon
parent
189e897888
commit
64f6a412c0
10 changed files with 789 additions and 569 deletions
|
|
@ -13,7 +13,7 @@ from ytdl_sub.config.plugin.preset_plugins import PresetPlugins
|
|||
from ytdl_sub.config.preset_options import OutputOptions
|
||||
from ytdl_sub.config.validators.options import OptionsValidator
|
||||
from ytdl_sub.downloaders.url.validators import MultiUrlValidator
|
||||
from ytdl_sub.entries.script.variable_scripts import VARIABLE_SCRIPTS
|
||||
from ytdl_sub.entries.script.variable_definitions import VARIABLE_SCRIPTS
|
||||
from ytdl_sub.script.script import Script
|
||||
from ytdl_sub.validators.string_formatter_validators import validate_formatters
|
||||
|
||||
|
|
|
|||
|
|
@ -11,10 +11,9 @@ from ytdl_sub.config.validators.options import OptionsDictValidator
|
|||
from ytdl_sub.downloaders.source_plugin import SourcePlugin
|
||||
from ytdl_sub.downloaders.ytdl_options_builder import YTDLOptionsBuilder
|
||||
from ytdl_sub.entries.entry import Entry
|
||||
from ytdl_sub.entries.script.variable_definitions import VARIABLE_SCRIPTS
|
||||
from ytdl_sub.entries.script.variable_definitions import VARIABLES
|
||||
from ytdl_sub.entries.script.variable_definitions import VariableDefinitions
|
||||
from ytdl_sub.entries.script.variable_scripts import DOWNLOADER_INJECTED_VARIABLES
|
||||
from ytdl_sub.entries.script.variable_scripts import VARIABLE_SCRIPTS
|
||||
from ytdl_sub.utils.exceptions import ValidationException
|
||||
from ytdl_sub.utils.file_handler import FileHandler
|
||||
from ytdl_sub.utils.file_handler import get_file_extension
|
||||
|
|
@ -110,11 +109,11 @@ class InfoJsonDownloader(SourcePlugin[InfoJsonDownloaderOptions]):
|
|||
|
||||
entry.initialize_script(self.overrides).add(
|
||||
{
|
||||
inj: prior_variables.get(
|
||||
inj.variable_name,
|
||||
VARIABLE_SCRIPTS[inj.variable_name],
|
||||
inj_variable_name: prior_variables.get(
|
||||
inj_variable_name,
|
||||
VARIABLE_SCRIPTS[inj_variable_name],
|
||||
)
|
||||
for inj in DOWNLOADER_INJECTED_VARIABLES
|
||||
for inj_variable_name in v.injected_variables()
|
||||
}
|
||||
)
|
||||
entries.append(entry)
|
||||
|
|
|
|||
|
|
@ -12,8 +12,10 @@ from typing import final
|
|||
|
||||
from ytdl_sub.entries.base_entry import BaseEntry
|
||||
from ytdl_sub.entries.script.variable_definitions import VARIABLES
|
||||
from ytdl_sub.entries.script.variable_definitions import Variable
|
||||
from ytdl_sub.entries.script.variable_definitions import VariableDefinitions
|
||||
from ytdl_sub.entries.script.variable_types import ArrayVariable
|
||||
from ytdl_sub.entries.script.variable_types import StringVariable
|
||||
from ytdl_sub.entries.script.variable_types import Variable
|
||||
from ytdl_sub.script.utils.exceptions import ScriptVariableNotResolved
|
||||
from ytdl_sub.utils.script import ScriptUtils
|
||||
from ytdl_sub.utils.scriptable import Scriptable
|
||||
|
|
@ -23,8 +25,12 @@ from ytdl_sub.validators.audo_codec_validator import VIDEO_CODEC_EXTS
|
|||
v: VariableDefinitions = VARIABLES
|
||||
|
||||
_YTDL_SUB_ENTRY_VARIABLES_KWARG_KEY: str = "ytdl_sub_entry_variables"
|
||||
ytdl_sub_chapters_from_comments = Variable("ytdl_sub_chapters_from_comments")
|
||||
ytdl_sub_split_by_chapters_parent_uid = Variable("ytdl_sub_split_by_chapters_parent_uid")
|
||||
ytdl_sub_chapters_from_comments = ArrayVariable(
|
||||
"ytdl_sub_chapters_from_comments", definition="{ [] }"
|
||||
)
|
||||
ytdl_sub_split_by_chapters_parent_uid = StringVariable(
|
||||
"ytdl_sub_split_by_chapters_parent_uid", definition="{ %string('') }"
|
||||
)
|
||||
|
||||
TypeT = TypeVar("TypeT")
|
||||
|
||||
|
|
|
|||
|
|
@ -3,15 +3,14 @@ from typing import Any
|
|||
from typing import Dict
|
||||
from typing import List
|
||||
from typing import Optional
|
||||
from typing import Set
|
||||
|
||||
from ytdl_sub.entries.base_entry import BaseEntry
|
||||
from ytdl_sub.entries.base_entry import TBaseEntry
|
||||
from ytdl_sub.entries.entry import Entry
|
||||
from ytdl_sub.entries.script.variable_definitions import VARIABLES
|
||||
from ytdl_sub.entries.script.variable_definitions import MetadataVariable
|
||||
from ytdl_sub.entries.script.variable_definitions import VariableDefinitions
|
||||
from ytdl_sub.entries.script.variable_scripts import ENTRY_DEFAULT_VARIABLES
|
||||
from ytdl_sub.entries.script.variable_scripts import ENTRY_REQUIRED_VARIABLES
|
||||
from ytdl_sub.entries.script.variable_types import MetadataVariable
|
||||
|
||||
v: VariableDefinitions = VARIABLES
|
||||
|
||||
|
|
@ -53,8 +52,8 @@ class EntryParent(BaseEntry):
|
|||
|
||||
def _sibling_entry_metadata(self) -> List[Dict[str, Any]]:
|
||||
sibling_entry_metadata: List[Dict[str, Any]] = []
|
||||
variable_filter: List[MetadataVariable] = list(ENTRY_REQUIRED_VARIABLES.keys()) + list(
|
||||
ENTRY_DEFAULT_VARIABLES.keys()
|
||||
variable_filter: Set[MetadataVariable] = (
|
||||
v.required_entry_variables() | v.default_entry_variables()
|
||||
)
|
||||
for entry in self.entry_children():
|
||||
sibling_entry_metadata.append(
|
||||
|
|
|
|||
|
|
@ -101,7 +101,7 @@ class CustomFunctions:
|
|||
- year (Integer)
|
||||
- month (Integer)
|
||||
- day (Integer)
|
||||
- year_truncated (String, YY from YY[YY])
|
||||
- year_truncated (Integer, YY from YY[YY])
|
||||
- month_padded (String)
|
||||
- day_padded (String)
|
||||
- year_truncated_reversed (Integer, 100 - year_truncated)
|
||||
|
|
@ -149,7 +149,7 @@ class CustomFunctions:
|
|||
String("year"): Integer(year),
|
||||
String("month"): Integer(month),
|
||||
String("day"): Integer(day),
|
||||
String("year_truncated"): String(year_truncated),
|
||||
String("year_truncated"): Integer(year_truncated),
|
||||
String("month_padded"): String(month_padded),
|
||||
String("day_padded"): String(day_padded),
|
||||
String("year_truncated_reversed"): Integer(100 - year_truncated),
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
|
|
@ -1,296 +0,0 @@
|
|||
from typing import Dict
|
||||
from typing import List
|
||||
from typing import Optional
|
||||
from typing import Set
|
||||
|
||||
import mergedeep
|
||||
|
||||
from ytdl_sub.entries.script.custom_functions import CustomFunctions
|
||||
from ytdl_sub.entries.script.variable_definitions import VARIABLES
|
||||
from ytdl_sub.entries.script.variable_definitions import Metadata
|
||||
from ytdl_sub.entries.script.variable_definitions import MetadataVariable
|
||||
from ytdl_sub.entries.script.variable_definitions import Variable
|
||||
from ytdl_sub.entries.script.variable_definitions import VariableDefinitions
|
||||
|
||||
###############################################################################################
|
||||
# Helpers
|
||||
|
||||
v: VariableDefinitions = VARIABLES
|
||||
|
||||
|
||||
def _pad_int(key: Variable, pad: int) -> str:
|
||||
return f"{{%pad_zero({key.variable_name}, {pad})}}"
|
||||
|
||||
|
||||
def _sanitized_plex(key: Variable) -> str:
|
||||
return f"{{%sanitize_plex_episode({key.variable_name})}}"
|
||||
|
||||
|
||||
def _date_metadata(date_key: Variable, metadata_key: str) -> str:
|
||||
return f"{{%map_get(%to_date_metadata({date_key.variable_name}), '{metadata_key}')}}"
|
||||
|
||||
|
||||
###############################################################################################
|
||||
# Metadata Getters
|
||||
|
||||
|
||||
def _get(
|
||||
cast: str,
|
||||
metadata: Metadata,
|
||||
key: MetadataVariable,
|
||||
default: Optional[Variable | str | int | Dict | List],
|
||||
) -> str:
|
||||
if default is None:
|
||||
# TODO: assert with good error message if key DNE
|
||||
out = f"%map_get({metadata.variable_name}, '{key.metadata_key}')"
|
||||
elif isinstance(default, Variable):
|
||||
args = f"{metadata.variable_name}, '{key.metadata_key}', {default.variable_name}"
|
||||
out = f"%map_get_non_empty({args})"
|
||||
elif isinstance(default, str):
|
||||
out = f"%map_get_non_empty({metadata.variable_name}, '{key.metadata_key}', '{default}')"
|
||||
elif isinstance(default, dict):
|
||||
out = f"%map_get_non_empty({metadata.variable_name}, '{key.metadata_key}', {{}})"
|
||||
elif isinstance(default, list):
|
||||
out = f"%map_get_non_empty({metadata.variable_name}, '{key.metadata_key}', [])"
|
||||
else:
|
||||
out = f"%map_get_non_empty({metadata.variable_name}, '{key.metadata_key}', {default})"
|
||||
|
||||
return f"{{ %legacy_bracket_safety(%{cast}({out})) }}"
|
||||
|
||||
|
||||
###############################################################################################
|
||||
# Entry Getters
|
||||
|
||||
|
||||
def _entry_get_str(key: MetadataVariable, default: Optional[Variable | str] = None) -> str:
|
||||
return _get("string", metadata=v.entry_metadata, key=key, default=default)
|
||||
|
||||
|
||||
def _entry_get_int(key: MetadataVariable, default: Optional[Variable | int] = None) -> str:
|
||||
return _get("int", metadata=v.entry_metadata, key=key, default=default)
|
||||
|
||||
|
||||
def _entry_get_map(key: MetadataVariable, default: Optional[Variable | Dict] = None):
|
||||
return _get("map", metadata=v.entry_metadata, key=key, default=default)
|
||||
|
||||
|
||||
def _entry_get_array(key: MetadataVariable, default: Optional[Variable | List] = None):
|
||||
return _get("array", metadata=v.entry_metadata, key=key, default=default)
|
||||
|
||||
|
||||
###############################################################################################
|
||||
# Playlist Getters
|
||||
|
||||
|
||||
def _playlist_get_str(key: MetadataVariable, default: Optional[Variable | str] = None) -> str:
|
||||
return _get("string", metadata=v.playlist_metadata, key=key, default=default)
|
||||
|
||||
|
||||
def _playlist_get_int(key: MetadataVariable, default: Optional[Variable | int] = None) -> str:
|
||||
return _get("int", metadata=v.playlist_metadata, key=key, default=default)
|
||||
|
||||
|
||||
###############################################################################################
|
||||
# Source Getters
|
||||
|
||||
|
||||
def _source_get_str(key: MetadataVariable, default: Optional[Variable | str] = None) -> str:
|
||||
return _get("string", metadata=v.source_metadata, key=key, default=default)
|
||||
|
||||
|
||||
###############################################################################################
|
||||
# Scripts
|
||||
|
||||
ENTRY_EMPTY_METADATA: Dict[Variable, str] = {v.entry_metadata: "{ {} }"}
|
||||
|
||||
ENTRY_HARDCODED_VARIABLES: Dict[Variable, str] = {
|
||||
v.info_json_ext: "info.json",
|
||||
v.thumbnail_ext: "jpg",
|
||||
}
|
||||
|
||||
ENTRY_RELATIVE_VARIABLES: Dict[MetadataVariable, str] = {
|
||||
v.playlist_metadata: _entry_get_map(v.playlist_metadata, {}),
|
||||
v.source_metadata: _entry_get_map(v.source_metadata, {}),
|
||||
v.sibling_metadata: _entry_get_array(v.sibling_metadata, []),
|
||||
}
|
||||
|
||||
ENTRY_REQUIRED_VARIABLES: Dict[MetadataVariable, str] = {
|
||||
v.uid: _entry_get_str(v.uid),
|
||||
v.extractor_key: _entry_get_str(v.extractor_key),
|
||||
v.epoch: _entry_get_int(v.epoch),
|
||||
v.webpage_url: _entry_get_str(v.webpage_url),
|
||||
v.ext: _entry_get_str(v.ext),
|
||||
}
|
||||
|
||||
ENTRY_DEFAULT_VARIABLES: Dict[MetadataVariable, str] = {
|
||||
v.title: _entry_get_str(v.title, v.uid),
|
||||
v.extractor: _entry_get_str(v.extractor, v.extractor_key),
|
||||
v.description: _entry_get_str(v.description, ""),
|
||||
v.ie_key: _entry_get_str(v.ie_key, v.extractor_key),
|
||||
v.uploader_id: _entry_get_str(v.uploader_id, v.uid),
|
||||
v.uploader: _entry_get_str(v.uploader, v.uploader_id),
|
||||
v.uploader_url: _entry_get_str(v.uploader_url, v.webpage_url),
|
||||
v.upload_date: _entry_get_str(v.upload_date, v.epoch_date),
|
||||
v.release_date: _entry_get_str(v.release_date, v.upload_date),
|
||||
v.channel: _entry_get_str(v.channel, v.uploader),
|
||||
v.creator: _entry_get_str(v.creator, v.channel),
|
||||
v.channel_id: _entry_get_str(v.channel_id, v.uploader_id),
|
||||
v.duration: _entry_get_int(v.duration, 0),
|
||||
v.playlist_index: _entry_get_int(v.playlist_index, 1),
|
||||
v.playlist_count: _entry_get_int(v.playlist_count, 1),
|
||||
v.playlist_uid: _entry_get_str(v.playlist_uid, v.uid),
|
||||
v.playlist_title: _entry_get_str(v.playlist_title, v.title),
|
||||
v.playlist_uploader_id: _entry_get_str(v.playlist_uploader_id, v.uploader_id),
|
||||
}
|
||||
|
||||
# MARK AS UNRESOLVABLE UNTIL THEY ARE ADDED IN THE DOWNLOADER
|
||||
DOWNLOADER_INJECTED_VARIABLES: Dict[Variable, str] = {
|
||||
v.download_index: "{%int(1)}",
|
||||
v.upload_date_index: "{%int(1)}",
|
||||
v.comments: "{ [] }",
|
||||
v.requested_subtitles: "{ {} }",
|
||||
v.chapters: "{ [] }",
|
||||
v.sponsorblock_chapters: "{ [] }",
|
||||
v.ytdl_sub_input_url: f"{{{v.source_webpage_url.variable_name}}}",
|
||||
}
|
||||
|
||||
ENTRY_DERIVED_VARIABLES: Dict[Variable, str] = {
|
||||
v.uid_sanitized_plex: _sanitized_plex(v.uid),
|
||||
v.title_sanitized_plex: _sanitized_plex(v.title),
|
||||
v.epoch_date: f"{{%datetime_strftime({v.epoch.variable_name}, '%Y%m%d')}}",
|
||||
v.epoch_hour: f"{{%datetime_strftime({v.epoch.variable_name}, '%H')}}",
|
||||
v.download_index_padded6: _pad_int(v.download_index, 6),
|
||||
v.upload_date_index_padded: _pad_int(v.upload_date_index, 2),
|
||||
v.upload_date_index_reversed: f"{{%sub(100, {v.upload_date_index.variable_name})}}",
|
||||
v.upload_date_index_reversed_padded: _pad_int(v.upload_date_index_reversed, 2),
|
||||
v.playlist_index_reversed: (
|
||||
f"{{%sub({v.playlist_count.variable_name}, {v.playlist_index.variable_name}, -1)}}"
|
||||
),
|
||||
v.playlist_index_padded: _pad_int(v.playlist_index, 2),
|
||||
v.playlist_index_reversed_padded: _pad_int(v.playlist_index_reversed, 2),
|
||||
v.playlist_index_padded6: _pad_int(v.playlist_index, 6),
|
||||
v.playlist_index_reversed_padded6: _pad_int(v.playlist_index_reversed, 6),
|
||||
}
|
||||
|
||||
ENTRY_UPLOAD_DATE_VARIABLES: Dict[Variable, str] = {
|
||||
v.upload_year: _date_metadata(v.upload_date, "year"),
|
||||
v.upload_year_truncated: _date_metadata(v.upload_date, "year_truncated"),
|
||||
v.upload_year_truncated_reversed: _date_metadata(v.upload_date, "year_truncated_reversed"),
|
||||
v.upload_month_reversed: _date_metadata(v.upload_date, "month_reversed"),
|
||||
v.upload_month_reversed_padded: _date_metadata(v.upload_date, "month_reversed_padded"),
|
||||
v.upload_month_padded: _date_metadata(v.upload_date, "month_padded"),
|
||||
v.upload_day_padded: _date_metadata(v.upload_date, "day_padded"),
|
||||
v.upload_month: _date_metadata(v.upload_date, "month"),
|
||||
v.upload_day: _date_metadata(v.upload_date, "day"),
|
||||
v.upload_day_reversed: _date_metadata(v.upload_date, "day_reversed"),
|
||||
v.upload_day_reversed_padded: _date_metadata(v.upload_date, "day_reversed_padded"),
|
||||
v.upload_day_of_year: _date_metadata(v.upload_date, "day_of_year"),
|
||||
v.upload_day_of_year_padded: _date_metadata(v.upload_date, "day_of_year_padded"),
|
||||
v.upload_day_of_year_reversed: _date_metadata(v.upload_date, "day_of_year_reversed"),
|
||||
v.upload_day_of_year_reversed_padded: _date_metadata(
|
||||
v.upload_date, "day_of_year_reversed_padded"
|
||||
),
|
||||
v.upload_date_standardized: _date_metadata(v.upload_date, "date_standardized"),
|
||||
}
|
||||
|
||||
ENTRY_RELEASE_DATE_VARIABLES: Dict[Variable, str] = {
|
||||
v.release_year: _date_metadata(v.release_date, "year"),
|
||||
v.release_year_truncated: _date_metadata(v.release_date, "year_truncated"),
|
||||
v.release_year_truncated_reversed: _date_metadata(v.release_date, "year_truncated_reversed"),
|
||||
v.release_month_reversed: _date_metadata(v.release_date, "month_reversed"),
|
||||
v.release_month_reversed_padded: _date_metadata(v.release_date, "month_reversed_padded"),
|
||||
v.release_month_padded: _date_metadata(v.release_date, "month_padded"),
|
||||
v.release_day_padded: _date_metadata(v.release_date, "day_padded"),
|
||||
v.release_month: _date_metadata(v.release_date, "month"),
|
||||
v.release_day: _date_metadata(v.release_date, "day"),
|
||||
v.release_day_reversed: _date_metadata(v.release_date, "day_reversed"),
|
||||
v.release_day_reversed_padded: _date_metadata(v.release_date, "day_reversed_padded"),
|
||||
v.release_day_of_year: _date_metadata(v.release_date, "day_of_year"),
|
||||
v.release_day_of_year_padded: _date_metadata(v.release_date, "day_of_year_padded"),
|
||||
v.release_day_of_year_reversed: _date_metadata(v.release_date, "day_of_year_reversed"),
|
||||
v.release_day_of_year_reversed_padded: _date_metadata(
|
||||
v.release_date, "day_of_year_reversed_padded"
|
||||
),
|
||||
v.release_date_standardized: _date_metadata(v.release_date, "date_standardized"),
|
||||
}
|
||||
|
||||
PLAYLIST_VARIABLES: Dict[Variable, str] = {
|
||||
v.playlist_webpage_url: _playlist_get_str(v.playlist_webpage_url, v.webpage_url),
|
||||
v.playlist_description: _playlist_get_str(v.playlist_description, v.description),
|
||||
v.playlist_uploader: _playlist_get_str(v.playlist_uploader, v.uploader),
|
||||
v.playlist_uploader_url: _playlist_get_str(v.playlist_uploader_url, v.playlist_webpage_url),
|
||||
v.source_index: _playlist_get_int(v.source_index, 1),
|
||||
v.source_count: _playlist_get_int(v.source_count, 1),
|
||||
}
|
||||
|
||||
|
||||
SOURCE_VARIABLES: Dict[Variable, str] = {
|
||||
v.source_uid: _source_get_str(v.source_uid, v.playlist_uid),
|
||||
v.source_title: _source_get_str(v.source_title, v.playlist_title),
|
||||
v.source_webpage_url: _source_get_str(v.source_webpage_url, v.playlist_webpage_url),
|
||||
v.source_description: _source_get_str(v.source_description, v.playlist_description),
|
||||
v.source_uploader_id: _source_get_str(v.source_uploader_id, v.playlist_uploader_id),
|
||||
v.source_uploader: _source_get_str(v.source_uploader, v.playlist_uploader),
|
||||
v.source_uploader_url: _source_get_str(v.source_uploader_url, v.source_webpage_url),
|
||||
}
|
||||
|
||||
SOURCE_DERIVED_VARIABLES: Dict[Variable, str] = {
|
||||
v.source_index_padded: _pad_int(v.source_index, 2),
|
||||
}
|
||||
|
||||
SIBLING_VARIABLES: Dict[Variable, str] = {
|
||||
v.playlist_max_upload_date: f"""{{
|
||||
%array_reduce(
|
||||
%if_passthrough(
|
||||
%extract_field_from_siblings('{v.upload_date.variable_name}'),
|
||||
[{v.upload_date.variable_name}]
|
||||
),
|
||||
%max
|
||||
)
|
||||
}}"""
|
||||
}
|
||||
|
||||
SIBLING_DERIVED_VARIABLES: Dict[Variable, str] = {
|
||||
v.playlist_max_upload_year: _date_metadata(v.playlist_max_upload_date, "year"),
|
||||
v.playlist_max_upload_year_truncated: _date_metadata(
|
||||
v.playlist_max_upload_date, "year_truncated"
|
||||
),
|
||||
}
|
||||
|
||||
_VARIABLE_SCRIPTS: Dict[Variable, str] = {}
|
||||
mergedeep.merge(
|
||||
_VARIABLE_SCRIPTS,
|
||||
ENTRY_EMPTY_METADATA,
|
||||
ENTRY_HARDCODED_VARIABLES,
|
||||
ENTRY_RELATIVE_VARIABLES,
|
||||
ENTRY_REQUIRED_VARIABLES,
|
||||
ENTRY_DEFAULT_VARIABLES,
|
||||
DOWNLOADER_INJECTED_VARIABLES,
|
||||
ENTRY_DERIVED_VARIABLES,
|
||||
ENTRY_UPLOAD_DATE_VARIABLES,
|
||||
ENTRY_RELEASE_DATE_VARIABLES,
|
||||
SIBLING_VARIABLES,
|
||||
SIBLING_DERIVED_VARIABLES,
|
||||
PLAYLIST_VARIABLES,
|
||||
SOURCE_VARIABLES,
|
||||
SOURCE_DERIVED_VARIABLES,
|
||||
)
|
||||
|
||||
VARIABLE_SCRIPTS: Dict[str, str] = {
|
||||
var.variable_name: script for var, script in _VARIABLE_SCRIPTS.items()
|
||||
}
|
||||
|
||||
|
||||
def _keys(*variables: Dict[Variable, str]) -> Set[str]:
|
||||
keys: Set[str] = set()
|
||||
for variable_set in variables:
|
||||
keys.update(set(var.variable_name for var in variable_set.keys()))
|
||||
return keys
|
||||
|
||||
|
||||
UNRESOLVED_VARIABLES: Set[str] = _keys(
|
||||
ENTRY_EMPTY_METADATA,
|
||||
DOWNLOADER_INJECTED_VARIABLES,
|
||||
)
|
||||
|
||||
CustomFunctions.register()
|
||||
269
src/ytdl_sub/entries/script/variable_types.py
Normal file
269
src/ytdl_sub/entries/script/variable_types.py
Normal file
|
|
@ -0,0 +1,269 @@
|
|||
from abc import ABC
|
||||
from abc import abstractmethod
|
||||
from dataclasses import dataclass
|
||||
from typing import Dict
|
||||
from typing import List
|
||||
from typing import Optional
|
||||
from typing import Type
|
||||
from typing import TypeVar
|
||||
|
||||
from ytdl_sub.script.types.array import Array
|
||||
from ytdl_sub.script.types.map import Map
|
||||
from ytdl_sub.script.types.resolvable import Integer
|
||||
from ytdl_sub.script.types.resolvable import String
|
||||
|
||||
ENTRY_METADATA_VARIABLE_NAME = "entry_metadata"
|
||||
PLAYLIST_METADATA_VARIABLE_NAME = "playlist_metadata"
|
||||
SOURCE_METADATA_VARIABLE_NAME = "source_metadata"
|
||||
|
||||
TMetadataVariable = TypeVar("TMetadataVariable", bound="MetadataVariable")
|
||||
|
||||
|
||||
def _get(
|
||||
cast: str,
|
||||
metadata_variable_name: str,
|
||||
metadata_key: str,
|
||||
variable_name: Optional[str],
|
||||
default: Optional["Variable" | str | int | Dict | List],
|
||||
as_type: Type[TMetadataVariable],
|
||||
) -> TMetadataVariable:
|
||||
if default is None:
|
||||
# TODO: assert with good error message if key DNE
|
||||
out = f"%map_get({metadata_variable_name}, '{metadata_key}')"
|
||||
elif isinstance(default, Variable):
|
||||
args = f"{metadata_variable_name}, '{metadata_key}', {default.variable_name}"
|
||||
out = f"%map_get_non_empty({args})"
|
||||
elif isinstance(default, str):
|
||||
out = f"%map_get_non_empty({metadata_variable_name}, '{metadata_key}', '{default}')"
|
||||
elif isinstance(default, dict):
|
||||
out = f"%map_get_non_empty({metadata_variable_name}, '{metadata_key}', {{}})"
|
||||
elif isinstance(default, list):
|
||||
out = f"%map_get_non_empty({metadata_variable_name}, '{metadata_key}', [])"
|
||||
else:
|
||||
out = f"%map_get_non_empty({metadata_variable_name}, '{metadata_key}', {default})"
|
||||
|
||||
return as_type(
|
||||
variable_name=variable_name or metadata_key,
|
||||
metadata_key=metadata_key,
|
||||
definition=f"{{ %legacy_bracket_safety(%{cast}({out})) }}",
|
||||
)
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class Variable(ABC):
|
||||
variable_name: str
|
||||
definition: str
|
||||
|
||||
@classmethod
|
||||
@abstractmethod
|
||||
def human_readable_type(cls) -> str:
|
||||
"""
|
||||
Script type of the variable, for documentation
|
||||
"""
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class StringVariable(Variable):
|
||||
@classmethod
|
||||
def human_readable_type(cls) -> str:
|
||||
return String.__name__
|
||||
|
||||
def to_sanitized_plex(self, variable_name: str) -> "StringVariable":
|
||||
return StringVariable(
|
||||
variable_name=variable_name,
|
||||
definition=f"{{%sanitize_plex_episode({self.variable_name})}}",
|
||||
)
|
||||
|
||||
def as_date_variable(self) -> "StringDateVariable":
|
||||
return StringDateVariable(
|
||||
variable_name=self.variable_name,
|
||||
definition=self.definition,
|
||||
)
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class StringDateVariable(StringVariable):
|
||||
def get_string_date_metadata(
|
||||
self, date_metadata_key: str, variable_name: Optional[str] = None
|
||||
) -> StringVariable:
|
||||
return StringVariable(
|
||||
variable_name=variable_name or date_metadata_key,
|
||||
definition=f"""{{
|
||||
%string(
|
||||
%map_get(
|
||||
%to_date_metadata({self.variable_name}),
|
||||
'{date_metadata_key}'
|
||||
)
|
||||
)
|
||||
}}""",
|
||||
)
|
||||
|
||||
def get_integer_date_metadata(
|
||||
self, date_metadata_key: str, variable_name: str
|
||||
) -> "IntegerVariable":
|
||||
return IntegerVariable(
|
||||
variable_name=variable_name,
|
||||
definition=f"""{{
|
||||
%int(
|
||||
%map_get(
|
||||
%to_date_metadata({self.variable_name}),
|
||||
'{date_metadata_key}'
|
||||
)
|
||||
)
|
||||
}}""",
|
||||
)
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class IntegerVariable(Variable):
|
||||
@classmethod
|
||||
def human_readable_type(cls) -> str:
|
||||
return Integer.__name__
|
||||
|
||||
def to_padded_int(self, variable_name: str, pad: int) -> StringVariable:
|
||||
return StringVariable(
|
||||
variable_name=variable_name, definition=f"{{%pad_zero({self.variable_name}, {pad})}}"
|
||||
)
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class ArrayVariable(Variable):
|
||||
@classmethod
|
||||
def human_readable_type(cls) -> str:
|
||||
return Array.__name__
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class MapVariable(Variable):
|
||||
@classmethod
|
||||
def human_readable_type(cls) -> str:
|
||||
return Map.__name__
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class MetadataVariable(Variable, ABC):
|
||||
metadata_key: str
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class MapMetadataVariable(MetadataVariable, MapVariable):
|
||||
@classmethod
|
||||
def from_entry(
|
||||
cls,
|
||||
metadata_key: str,
|
||||
variable_name: Optional[str] = None,
|
||||
default: Optional["MapMetadataVariable" | Dict] = None,
|
||||
) -> "MapMetadataVariable":
|
||||
return _get(
|
||||
"map",
|
||||
metadata_variable_name=ENTRY_METADATA_VARIABLE_NAME,
|
||||
metadata_key=metadata_key,
|
||||
variable_name=variable_name,
|
||||
default=default,
|
||||
as_type=MapMetadataVariable,
|
||||
)
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class ArrayMetadataVariable(MetadataVariable, ArrayVariable):
|
||||
@classmethod
|
||||
def from_entry(
|
||||
cls,
|
||||
metadata_key: str,
|
||||
variable_name: Optional[str] = None,
|
||||
default: Optional["ArrayMetadataVariable" | List] = None,
|
||||
) -> "ArrayMetadataVariable":
|
||||
return _get(
|
||||
"array",
|
||||
metadata_variable_name=ENTRY_METADATA_VARIABLE_NAME,
|
||||
metadata_key=metadata_key,
|
||||
variable_name=variable_name,
|
||||
default=default,
|
||||
as_type=ArrayMetadataVariable,
|
||||
)
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class StringMetadataVariable(MetadataVariable, StringVariable):
|
||||
@classmethod
|
||||
def from_entry(
|
||||
cls,
|
||||
metadata_key: str,
|
||||
variable_name: Optional[str] = None,
|
||||
default: Optional[StringVariable | str] = None,
|
||||
) -> "StringMetadataVariable":
|
||||
return _get(
|
||||
"string",
|
||||
metadata_variable_name=ENTRY_METADATA_VARIABLE_NAME,
|
||||
metadata_key=metadata_key,
|
||||
variable_name=variable_name,
|
||||
default=default,
|
||||
as_type=StringMetadataVariable,
|
||||
)
|
||||
|
||||
@classmethod
|
||||
def from_playlist(
|
||||
cls,
|
||||
metadata_key: str,
|
||||
variable_name: Optional[str] = None,
|
||||
default: Optional[StringVariable | str] = None,
|
||||
) -> "StringMetadataVariable":
|
||||
return _get(
|
||||
"string",
|
||||
metadata_variable_name=PLAYLIST_METADATA_VARIABLE_NAME,
|
||||
metadata_key=metadata_key,
|
||||
variable_name=variable_name,
|
||||
default=default,
|
||||
as_type=StringMetadataVariable,
|
||||
)
|
||||
|
||||
@classmethod
|
||||
def from_source(
|
||||
cls,
|
||||
metadata_key: str,
|
||||
variable_name: Optional[str] = None,
|
||||
default: Optional[StringVariable | str] = None,
|
||||
) -> "StringMetadataVariable":
|
||||
return _get(
|
||||
"string",
|
||||
metadata_variable_name=SOURCE_METADATA_VARIABLE_NAME,
|
||||
metadata_key=metadata_key,
|
||||
variable_name=variable_name,
|
||||
default=default,
|
||||
as_type=StringMetadataVariable,
|
||||
)
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class IntegerMetadataVariable(MetadataVariable, IntegerVariable):
|
||||
@classmethod
|
||||
def from_entry(
|
||||
cls,
|
||||
metadata_key: str,
|
||||
variable_name: Optional[str] = None,
|
||||
default: Optional[IntegerVariable | int] = None,
|
||||
) -> "IntegerMetadataVariable":
|
||||
return _get(
|
||||
"int",
|
||||
metadata_variable_name=ENTRY_METADATA_VARIABLE_NAME,
|
||||
metadata_key=metadata_key,
|
||||
variable_name=variable_name,
|
||||
default=default,
|
||||
as_type=IntegerMetadataVariable,
|
||||
)
|
||||
|
||||
@classmethod
|
||||
def from_playlist(
|
||||
cls,
|
||||
metadata_key: str,
|
||||
variable_name: Optional[str] = None,
|
||||
default: Optional[IntegerVariable | int] = None,
|
||||
) -> "IntegerMetadataVariable":
|
||||
return _get(
|
||||
"int",
|
||||
metadata_variable_name=PLAYLIST_METADATA_VARIABLE_NAME,
|
||||
metadata_key=metadata_key,
|
||||
variable_name=variable_name,
|
||||
default=default,
|
||||
as_type=IntegerMetadataVariable,
|
||||
)
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
from ytdl_sub.entries.script.function_scripts import CUSTOM_FUNCTION_SCRIPTS
|
||||
from ytdl_sub.entries.script.variable_scripts import VARIABLE_SCRIPTS
|
||||
from ytdl_sub.entries.script.variable_definitions import VARIABLE_SCRIPTS
|
||||
from ytdl_sub.script.functions import Functions
|
||||
from ytdl_sub.script.utils.name_validation import is_valid_name
|
||||
|
||||
|
|
|
|||
|
|
@ -5,9 +5,9 @@ from typing import Dict
|
|||
from typing import Set
|
||||
|
||||
from ytdl_sub.entries.script.function_scripts import CUSTOM_FUNCTION_SCRIPTS
|
||||
from ytdl_sub.entries.script.variable_definitions import Variable
|
||||
from ytdl_sub.entries.script.variable_scripts import UNRESOLVED_VARIABLES
|
||||
from ytdl_sub.entries.script.variable_scripts import VARIABLE_SCRIPTS
|
||||
from ytdl_sub.entries.script.variable_definitions import UNRESOLVED_VARIABLES
|
||||
from ytdl_sub.entries.script.variable_definitions import VARIABLE_SCRIPTS
|
||||
from ytdl_sub.entries.script.variable_types import Variable
|
||||
from ytdl_sub.script.script import Script
|
||||
from ytdl_sub.script.utils.exceptions import RuntimeException
|
||||
from ytdl_sub.utils.exceptions import StringFormattingException
|
||||
|
|
|
|||
Loading…
Reference in a new issue