Skip to content

利用 AI 大模型和自动化工作流,根据主题或关键词一键生成高清短视频。Generate HD short videos from a topic or keyword with an automated AI workflow.

feat(cli): extend saved-settings chain to voice, stroke and position

Jeff Block677f30257d73
diff --git a/cli.py b/cli.py
index a1d539e0..af8e797e 100644
--- a/cli.py
+++ b/cli.py
@@ -19,6 +19,12 @@ DEFAULT_VOICE_NAME = "zh-CN-XiaoxiaoNeural-Female"
# 对应 webui/Main.py 的 VOICE_MODE_NONE 和 VOICE_MODE_UPLOAD。两端目前没有
# 共享这些常量,因此在这里保留字面值并注明来源。
UI_VOICE_MODE_NONE = "none"
+# 字幕位置的内置默认值。VideoParams 也有同名默认值,但它是 Pydantic 字段
+# 默认,只在模块导入时读取一次 config.ui:此时 config.toml 里的非法值会被
+# 直接冻结进模型,既不会校验也无法在测试中替换。CLI 因此自己保存一份,
+# 保证“非法保存值回退到默认值”对命令行始终成立。
+DEFAULT_SUBTITLE_POSITION = "bottom"
+DEFAULT_CUSTOM_POSITION = 70.0
UI_VOICE_MODE_UPLOAD = "upload"
# 这两种保存的配音方式都表示不要自动配音。
UI_VOICE_MODES_WITHOUT_TTS = frozenset({UI_VOICE_MODE_NONE, UI_VOICE_MODE_UPLOAD})
@@ -91,6 +97,15 @@ def _hex_color(value: str) -> str:
return value
+def _subtitle_position(value: str) -> str:
+ """校验保存的字幕位置,取值范围与命令行参数保持一致。"""
+ if value not in ("top", "center", "bottom", "custom"):
+ raise argparse.ArgumentTypeError(
+ f"subtitle-position must be one of: top, center, bottom, custom, got {value!r}"
+ )
+ return value
+
+
def _task_id(value: str) -> str:
"""CLI 自定义任务标识只接受 UUID,避免该值被解释为文件系统路径。"""
try:
@@ -306,7 +321,8 @@ Output and exit status:
type=_non_negative_float,
default=None,
help=(
- "final voiceover volume multiplier, a finite number >= 0 (default: 1.0)"
+ "final voiceover volume multiplier, a finite number >= 0 (default: "
+ "[ui].voice_volume from config.toml; 1.0 when unset)"
),
)
audio_group.add_argument(
@@ -314,7 +330,8 @@ Output and exit status:
type=_positive_float,
default=None,
help=(
- "speech rate multiplier, a finite number > 0 (default: 1.0)"
+ "speech rate multiplier, a finite number > 0 (default: "
+ "[ui].voice_rate from config.toml; 1.0 when unset)"
),
)
audio_group.add_argument(
@@ -364,11 +381,12 @@ Output and exit status:
subtitle_group = parser.add_argument_group("subtitles")
subtitle_group.add_argument(
"--subtitle-enabled",
- default=True,
+ default=None,
action=argparse.BooleanOptionalAction,
help=(
"enable subtitles; use --no-subtitle-enabled to disable "
- "(default: enabled)"
+ "(default: [ui].subtitle_enabled from config.toml; enabled when "
+ "unset)"
),
)
subtitle_group.add_argument(
@@ -422,14 +440,18 @@ Output and exit status:
"--stroke-color",
type=_hex_color,
default=None,
- help="subtitle outline color in #RRGGBB format (default: #000000)",
+ help=(
+ "subtitle outline color in #RRGGBB format (default: "
+ "[ui].stroke_color from config.toml; #000000 when unset)"
+ ),
)
subtitle_group.add_argument(
"--stroke-width",
type=_non_negative_float,
default=None,
help=(
- "subtitle outline width, a finite number >= 0 (default: 1.5)"
+ "subtitle outline width, a finite number >= 0 (default: "
+ "[ui].stroke_width from config.toml; 1.5 when unset)"
),
)
subtitle_group.add_argument(
@@ -506,7 +528,9 @@ Output and exit status:
if args.custom_position is not None and args.subtitle_position != "custom":
parser.error("--custom-position requires --subtitle-position custom")
- if args.stop_at == "subtitle" and not args.subtitle_enabled:
+ # 只有显式的 --no-subtitle-enabled 才算冲突。默认值现在是 None,
+ # 保存的关闭状态在 build_video_params 中处理,不应在这里报参数错误。
+ if args.stop_at == "subtitle" and args.subtitle_enabled is False:
parser.error("--stop-at subtitle cannot be combined with --no-subtitle-enabled")
if args.subtitle_background_enabled is False and (
args.subtitle_background_color is not None
@@ -520,13 +544,17 @@ Output and exit status:
return args
-def _ui_config_value(ui_config, key: str, expected_type):
+def _ui_config_value(ui_config, key: str, expected_type, checker=None):
"""
读取 ``[ui]`` 中保存的 WebUI 设置,取不到可用值时返回 ``None``。
- 该配置段也可能被手工编辑,因此这里直接丢弃类型不符的条目,让调用方回退
- 到内置默认值,而不是把脏数据继续传下去,触发 traceback 或 ``VideoParams``
+ 该配置段也可能被手工编辑,因此这里直接丢弃不可用的条目,让调用方回退到
+ 内置默认值,而不是把脏数据继续传下去,触发 traceback 或 ``VideoParams``
的校验错误。
+
+ ``checker`` 复用命令行使用的同一批类型函数(如 ``_hex_color``),因此保存
+ 值和命令行参数遵循完全相同的取值规则,例如音量不能为负、颜色必须是
+ ``#RRGGBB``。
"""
value = ui_config.get(key)
if value is None:
@@ -534,13 +562,37 @@ def _ui_config_value(ui_config, key: str, expected_type):
# ``isinstance(True, int)`` 为真,所以在期望数字时必须显式排除 bool。
if isinstance(value, bool) != (expected_type is bool):
return None
+ # TOML 中的 ``1`` 是整数,但对音量、语速这类字段同样是合法取值。
+ if expected_type is float and isinstance(value, int):
+ value = float(value)
if not isinstance(value, expected_type):
return None
if expected_type is str and not value.strip():
return None
+ if checker is not None:
+ try:
+ return checker(str(value))
+ except argparse.ArgumentTypeError:
+ return None
return value
+def _resolve_subtitle_enabled(args: argparse.Namespace, ui_config) -> bool:
+ """
+ 按优先级解析字幕开关:命令行 > WebUI 保存值 > 默认开启。
+
+ ``--stop-at subtitle`` 明确要求生成字幕,因此保存的关闭状态不能让该阶段
+ 变成空操作;显式的 --no-subtitle-enabled 与该阶段的组合在参数校验中已被
+ 拒绝,所以这里只需处理保存值。
+ """
+ if args.subtitle_enabled is not None:
+ return args.subtitle_enabled
+ if args.stop_at == "subtitle":
+ return True
+ saved = _ui_config_value(ui_config, "subtitle_enabled", bool)
+ return True if saved is None else saved
+
+
def _resolve_voice_name(args: argparse.Namespace, ui_config) -> str:
"""
按优先级解析音色:命令行 > WebUI 保存的配音方式和音色 > 内置默认值。
@@ -594,7 +646,7 @@ def build_video_params(args: argparse.Namespace) -> VideoParams:
"video_count": args.video_count,
"video_aspect": args.video_aspect,
"voice_name": _resolve_voice_name(args, ui_config),
- "subtitle_enabled": args.subtitle_enabled,
+ "subtitle_enabled": _resolve_subtitle_enabled(args, ui_config),
}
optional_arg_names = [
@@ -631,18 +683,38 @@ def build_video_params(args: argparse.Namespace) -> VideoParams:
# 没有显式传入命令行参数时,使用 WebUI 保存的值。只补充上面尚未由命令行
# 设置的字段;若保存值缺失,则继续沿用 VideoParams 的默认值。
ui_defaults = (
- ("font_name", str),
- ("text_fore_color", str),
- ("font_size", int),
- ("rounded_subtitle_background", bool),
- )
- for name, expected_type in ui_defaults:
+ ("font_name", str, None),
+ ("text_fore_color", str, _hex_color),
+ ("font_size", int, _positive_int),
+ ("rounded_subtitle_background", bool, None),
+ ("voice_volume", float, _non_negative_float),
+ ("voice_rate", float, _positive_float),
+ ("stroke_color", str, _hex_color),
+ ("stroke_width", float, _non_negative_float),
+ )
+ for name, expected_type, checker in ui_defaults:
if name in params_kwargs:
continue
- value = _ui_config_value(ui_config, name, expected_type)
+ value = _ui_config_value(ui_config, name, expected_type, checker)
if value is not None:
params_kwargs[name] = value
+ # 字幕位置必须由 CLI 给出确定值,不能交给上面说明的导入期字段默认值。
+ if "subtitle_position" not in params_kwargs:
+ params_kwargs["subtitle_position"] = (
+ _ui_config_value(ui_config, "subtitle_position", str, _subtitle_position)
+ or DEFAULT_SUBTITLE_POSITION
+ )
+ if "custom_position" not in params_kwargs:
+ saved_custom_position = _ui_config_value(
+ ui_config, "custom_position", float, _percent_position
+ )
+ params_kwargs["custom_position"] = (
+ DEFAULT_CUSTOM_POSITION
+ if saved_custom_position is None
+ else saved_custom_position
+ )
+
if args.subtitle_background_enabled is False:
params_kwargs["text_background_color"] = False
params_kwargs["rounded_subtitle_background"] = False
diff --git a/test/services/test_cli.py b/test/services/test_cli.py
index 8ae34d80..93306edb 100644
--- a/test/services/test_cli.py
+++ b/test/services/test_cli.py
@@ -842,6 +842,157 @@ class TestCliUiDefaults(unittest.TestCase):
self.assertEqual(params.text_background_color, "#654321")
+ def test_ui_config_supplies_voice_and_stroke_defaults(self):
+ """配音音量、语速、描边和字幕开关同样保存在 [ui] 中,需要一并沿用。"""
+ ui_config = {
+ "voice_volume": 0.5,
+ "voice_rate": 1.3,
+ "stroke_color": "#112233",
+ "stroke_width": 2.5,
+ "subtitle_enabled": False,
+ }
+
+ args = cli.parse_args(["--video-subject", "test"])
+
+ with patch.dict(app_config.ui, ui_config, clear=True):
+ params = cli.build_video_params(args)
+
+ self.assertEqual(params.voice_volume, 0.5)
+ self.assertEqual(params.voice_rate, 1.3)
+ self.assertEqual(params.stroke_color, "#112233")
+ self.assertEqual(params.stroke_width, 2.5)
+ self.assertFalse(params.subtitle_enabled)
+
+ def test_cli_flags_take_precedence_over_saved_voice_and_stroke(self):
+ """命令行显式传入的值优先于这些保存值。"""
+ ui_config = {
+ "voice_volume": 0.5,
+ "voice_rate": 1.3,
+ "stroke_color": "#112233",
+ "stroke_width": 2.5,
+ "subtitle_enabled": False,
+ }
+
+ args = cli.parse_args(
+ [
+ "--video-subject",
+ "test",
+ "--voice-volume",
+ "0.9",
+ "--voice-rate",
+ "1.1",
+ "--stroke-color",
+ "#AABBCC",
+ "--stroke-width",
+ "3.5",
+ "--subtitle-enabled",
+ ]
+ )
+
+ with patch.dict(app_config.ui, ui_config, clear=True):
+ params = cli.build_video_params(args)
+
+ self.assertEqual(params.voice_volume, 0.9)
+ self.assertEqual(params.voice_rate, 1.1)
+ self.assertEqual(params.stroke_color, "#AABBCC")
+ self.assertEqual(params.stroke_width, 3.5)
+ self.assertTrue(params.subtitle_enabled)
+
+ def test_saved_integers_are_accepted_for_float_fields(self):
+ """TOML 中的整数同样是合法音量和语速,应转换后使用而不是丢弃。"""
+ ui_config = {"voice_volume": 1, "voice_rate": 2, "stroke_width": 3}
+
+ args = cli.parse_args(["--video-subject", "test"])
+
+ with patch.dict(app_config.ui, ui_config, clear=True):
+ params = cli.build_video_params(args)
+
+ self.assertEqual(params.voice_volume, 1.0)
+ self.assertEqual(params.voice_rate, 2.0)
+ self.assertEqual(params.stroke_width, 3.0)
+
+ def test_saved_values_out_of_range_fall_back_to_builtin_defaults(self):
+ """
+ 保存值按与命令行相同的规则校验:音量不可为负、语速必须为正、
+ 颜色必须是 #RRGGBB。不合法的值回退到内置默认值。
+ """
+ ui_config = {
+ "voice_volume": -1.0,
+ "voice_rate": 0,
+ "stroke_color": "notacolor",
+ "stroke_width": -2.0,
+ "font_size": 0,
+ }
+
+ args = cli.parse_args(["--video-subject", "test"])
+
+ with patch.dict(app_config.ui, ui_config, clear=True):
+ params = cli.build_video_params(args)
+
+ self.assertEqual(params.voice_volume, 1.0)
+ self.assertEqual(params.voice_rate, 1.0)
+ self.assertEqual(params.stroke_color, "#000000")
+ self.assertEqual(params.stroke_width, 1.5)
+ self.assertEqual(params.font_size, 60)
+
+ def test_stop_at_subtitle_overrides_saved_subtitle_disabled(self):
+ """
+ `--stop-at subtitle` 明确要求生成字幕。保存的关闭状态不应让该阶段
+ 变成空操作,也不应像显式 --no-subtitle-enabled 那样报参数错误。
+ """
+ ui_config = {"subtitle_enabled": False}
+
+ args = cli.parse_args(
+ ["--video-subject", "test", "--stop-at", "subtitle"]
+ )
+
+ with patch.dict(app_config.ui, ui_config, clear=True):
+ params = cli.build_video_params(args)
+
+ self.assertTrue(params.subtitle_enabled)
+
+ def test_explicit_no_subtitle_still_rejects_stop_at_subtitle(self):
+ """显式关闭字幕与 `--stop-at subtitle` 组合仍然是参数错误。"""
+ with self.assertRaises(SystemExit) as cm:
+ cli.parse_args(
+ [
+ "--video-subject",
+ "test",
+ "--stop-at",
+ "subtitle",
+ "--no-subtitle-enabled",
+ ]
+ )
+
+ self.assertEqual(cm.exception.code, 2)
+
+ def test_saved_subtitle_position_is_validated_and_applied(self):
+ """
+ 字幕位置此前只依赖 VideoParams 的字段默认值,该默认值在模块导入时
+ 求值一次,既无法校验也无法在测试中替换。现在与其它字段一样显式解析。
+ """
+ ui_config = {"subtitle_position": "custom", "custom_position": 42.5}
+
+ args = cli.parse_args(["--video-subject", "test"])
+
+ with patch.dict(app_config.ui, ui_config, clear=True):
+ params = cli.build_video_params(args)
+
+ self.assertEqual(params.subtitle_position, "custom")
+ self.assertEqual(params.custom_position, 42.5)
+
+ def test_unusable_saved_subtitle_position_falls_back(self):
+ """超出取值范围的保存位置回退到内置默认值。"""
+ ui_config = {"subtitle_position": "diagonal", "custom_position": 150.0}
+
+ args = cli.parse_args(["--video-subject", "test"])
+
+ with patch.dict(app_config.ui, ui_config, clear=True):
+ params = cli.build_video_params(args)
+
+ self.assertEqual(params.subtitle_position, "bottom")
+ self.assertEqual(params.custom_position, 70.0)
+
if __name__ == "__main__":
unittest.main()