fix(api): keep sub_format "original" working through the API

This commit is contained in:
imSp4rky
2026-07-16 23:22:13 -06:00
parent 15a368f7e9
commit 036368b3c3
2 changed files with 40 additions and 3 deletions
@@ -118,3 +118,26 @@ def test_job_status_values() -> None:
"failed", "failed",
"cancelled", "cancelled",
} }
def test_normalize_sub_format_preserves_original_sentinel() -> None:
"""An API job asking for sub_format="original" must keep the "original" sentinel.
dl.py treats "original" as "keep source format" (skip conversion). If it were normalized to
None (as to_enum(["original"]) yields, since there is no such enum member), dl.py would fall
into the default branch and re-encode TTML -> WebVTT, contradicting the CLI.
"""
from unshackle.core.api.download_manager import _normalize_sub_format
from unshackle.core.tracks import Subtitle
from unshackle.core.utils.click_types import SubtitleCodecChoice
# API path keeps the sentinel, case-insensitively.
assert _normalize_sub_format("original") == "original"
assert _normalize_sub_format("ORIGINAL") == "original"
# The CLI produces the exact same sentinel value, so dl.py's `== "original"` branch handles both.
assert SubtitleCodecChoice(Subtitle.Codec).convert("original") == "original"
# A real codec still maps to its enum member; unknowns collapse to None.
assert _normalize_sub_format("srt") is Subtitle.Codec.SubRip
assert _normalize_sub_format("nonsense") is None
+17 -3
View File
@@ -298,6 +298,21 @@ def to_enum(values: List[str], enum_cls: type[Enum]) -> List[Enum]:
return [lookup[v.upper()] for v in values if v.upper() in lookup] return [lookup[v.upper()] for v in values if v.upper() in lookup]
def _normalize_sub_format(sub_format_raw: str) -> Any:
"""Normalize an API sub_format string to what dl.py expects.
"original" is a sentinel meaning "keep source format" (dl.py skips conversion), so it must
pass through unchanged to match the CLI (SubtitleCodecChoice returns the same string). Any
other value maps to a Subtitle.Codec, or None when unrecognized.
"""
from unshackle.core.tracks import Subtitle
if sub_format_raw.lower() == "original":
return "original"
mapped = to_enum([sub_format_raw], Subtitle.Codec)
return mapped[0] if mapped else None
def _perform_download( def _perform_download(
job_id: str, job_id: str,
service: str, service: str,
@@ -318,7 +333,7 @@ def _perform_download(
from unshackle.core.api.errors import APIError, APIErrorCode from unshackle.core.api.errors import APIError, APIErrorCode
from unshackle.core.config import config from unshackle.core.config import config
from unshackle.core.services import Services from unshackle.core.services import Services
from unshackle.core.tracks import Subtitle, Video from unshackle.core.tracks import Video
from unshackle.core.utils.click_types import ContextData from unshackle.core.utils.click_types import ContextData
from unshackle.core.utils.collections import merge_dict from unshackle.core.utils.collections import merge_dict
@@ -357,8 +372,7 @@ def _perform_download(
sub_format_raw = params.get("sub_format") sub_format_raw = params.get("sub_format")
if sub_format_raw and isinstance(sub_format_raw, str): if sub_format_raw and isinstance(sub_format_raw, str):
mapped = to_enum([sub_format_raw], Subtitle.Codec) params["sub_format"] = _normalize_sub_format(sub_format_raw)
params["sub_format"] = mapped[0] if mapped else None
if params.get("export"): if params.get("export"):
params["export"] = bool(params["export"]) params["export"] = bool(params["export"])