Files
douyin_guaji-main/tools/diagnostics/check_web_gui_config_sync.py
T
CodexandClaude Opus 4.5 a19fa35a0f chore: 整理 tools/ 47 个脚本按功能分组
- diagnostics/ 11 个:环境/配置/依赖诊断
- logs/ 7 个:日志分析与查看
- coords/ 6 个:坐标拾取与区域选择
- cleanup/ 3 个:代码清理工具
- adb/ 2 个:ADB / 输入法相关
- windows/ 4 个:Windows 系统修复(备份)
- dev/ 9 个:开发辅助 / 运行时探测

并更新 tools/README.md 描述新结构。
删除 3 个明显的临时调试脚本 (_dump_lines.py / tmp_*.py)。

tools/ 不被业务代码 import,分组仅为人工浏览方便。

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-05-20 23:25:28 +08:00

229 lines
7.4 KiB
Python

#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""Check that desktop GUI and WebUI expose the same config keys.
The check compares:
- keys saved by gui/gui_app.py to config.json
- keys loaded by gui/gui_app.py from config.json
- keys bound in webui/index.html through data-key/data-mirror-key
It is intentionally static and side-effect free, so it can run in local
verification without opening the GUI or starting the Web server.
"""
from __future__ import annotations
import argparse
import json
import re
import sys
from pathlib import Path
ROOT = Path(__file__).resolve().parents[1]
GUI_APP = ROOT / "gui" / "gui_app.py"
WEB_INDEX = ROOT / "webui" / "index.html"
MANIFEST_PATH = ROOT / "tools" / "web_gui_config_manifest.json"
IGNORED_CONTAINER_KEYS = {
"debug_captures",
"logging",
"logging.performance_tracking",
"gui",
"gui.realtime_status",
}
GUI_RUNTIME_ONLY_KEYS = {
# Local file-log switches are consumed by GUI/Web backends but are not part
# of gui_app.py's main left-pane config form.
"log_unified_enabled",
"log_unified_path",
"logging.use_dated_logs",
# These are right-side runtime refresh preferences in gui_app.py.
"gui.realtime_status.refresh_interval_ms",
"gui.realtime_status.tail_items",
}
def _read(path: Path) -> str:
return path.read_text(encoding="utf-8", errors="ignore")
def _normalize_key(parts: tuple[str | None, ...]) -> str:
return ".".join(part for part in parts if part)
def extract_gui_saved_keys(source: str) -> set[str]:
start = source.index("def save_ui_to_config")
end = source.index("write_config(cfg2)", start)
block = source[start:end]
keys: set[str] = set()
pattern = re.compile(
r'cfg2\["([^"]+)"\](?:\["([^"]+)"\])?(?:\["([^"]+)"\])?\s*='
)
for match in pattern.finditer(block):
key = _normalize_key(match.groups())
if key not in IGNORED_CONTAINER_KEYS:
keys.add(key)
return keys
def extract_gui_loaded_keys(source: str) -> set[str]:
start = source.index("def load_config_to_ui")
end = source.index("def save_ui_to_config", start)
block = source[start:end]
keys = set(re.findall(r'(?<![A-Za-z0-9_])cfg\.get\("([^"]+)"', block))
for top_key in ("gui", "logging"):
pattern = re.compile(rf'cfg\.get\("{top_key}", \{{\}}\)\.get\("([^"]+)"')
for match in pattern.finditer(block):
keys.add(f"{top_key}.{match.group(1)}")
for group_name, prefix in (
("debug_captures_config", "debug_captures"),
("logging_config", "logging"),
("perf_cfg", "logging.performance_tracking"),
):
pattern = re.compile(rf'{group_name}\.get\("([^"]+)"')
for match in pattern.finditer(block):
keys.add(f"{prefix}.{match.group(1)}")
realtime_pattern = re.compile(r'gui_cfg\.get\("([^"]+)"')
for match in realtime_pattern.finditer(source):
keys.add(f"gui.realtime_status.{match.group(1)}")
return {key for key in keys if key not in IGNORED_CONTAINER_KEYS}
def extract_web_keys(source: str) -> set[str]:
keys = set(re.findall(r'data-key="([^"]+)"', source))
keys.update(re.findall(r'data-mirror-key="([^"]+)"', source))
return keys
def build_manifest() -> dict[str, object]:
gui_source = _read(GUI_APP)
web_source = _read(WEB_INDEX)
gui_saved = extract_gui_saved_keys(gui_source)
gui_loaded = extract_gui_loaded_keys(gui_source)
web_keys = extract_web_keys(web_source)
expected_gui_keys = web_keys - GUI_RUNTIME_ONLY_KEYS
return {
"generated_by": "tools/check_web_gui_config_sync.py --sync",
"shared_keys": sorted(expected_gui_keys),
"gui_runtime_only_keys": sorted(GUI_RUNTIME_ONLY_KEYS),
"gui_saved_keys": sorted(gui_saved),
"gui_loaded_keys": sorted(gui_loaded),
"web_keys": sorted(web_keys),
}
def write_manifest() -> None:
manifest = build_manifest()
MANIFEST_PATH.write_text(
json.dumps(manifest, ensure_ascii=False, indent=2) + "\n",
encoding="utf-8",
)
print(f"[OK] Wrote {MANIFEST_PATH.relative_to(ROOT)}")
def load_manifest() -> dict[str, object] | None:
if not MANIFEST_PATH.exists():
return None
try:
return json.loads(MANIFEST_PATH.read_text(encoding="utf-8"))
except json.JSONDecodeError:
return None
def compare_manifest(current: dict[str, object]) -> list[str]:
stored = load_manifest()
if stored is None:
return [
f"{MANIFEST_PATH.relative_to(ROOT)} is missing or invalid; "
"run tools/check_web_gui_config_sync.py --sync"
]
diffs: list[str] = []
for key in (
"shared_keys",
"gui_runtime_only_keys",
"gui_saved_keys",
"gui_loaded_keys",
"web_keys",
):
if stored.get(key) != current.get(key):
diffs.append(
f"{MANIFEST_PATH.relative_to(ROOT)} is stale for {key}; "
"run tools/check_web_gui_config_sync.py --sync"
)
return diffs
def check_sync() -> tuple[list[tuple[str, list[str]]], dict[str, object]]:
manifest = build_manifest()
gui_saved = set(manifest["gui_saved_keys"]) # type: ignore[arg-type]
gui_loaded = set(manifest["gui_loaded_keys"]) # type: ignore[arg-type]
web_keys = set(manifest["web_keys"]) # type: ignore[arg-type]
expected_gui_keys = set(manifest["shared_keys"]) # type: ignore[arg-type]
problems: list[tuple[str, list[str]]] = []
missing_in_web = sorted((gui_saved | gui_loaded) - web_keys - GUI_RUNTIME_ONLY_KEYS)
missing_in_gui_save = sorted(expected_gui_keys - gui_saved)
missing_in_gui_load = sorted(expected_gui_keys - gui_loaded)
saved_not_loaded = sorted(gui_saved - gui_loaded - GUI_RUNTIME_ONLY_KEYS)
loaded_not_saved = sorted(gui_loaded - gui_saved - GUI_RUNTIME_ONLY_KEYS)
if missing_in_web:
problems.append(("GUI exposes keys missing from WebUI", missing_in_web))
if missing_in_gui_save:
problems.append(("WebUI keys missing from gui_app.py save", missing_in_gui_save))
if missing_in_gui_load:
problems.append(("WebUI keys missing from gui_app.py load", missing_in_gui_load))
if saved_not_loaded:
problems.append(("gui_app.py saves keys it does not load", saved_not_loaded))
if loaded_not_saved:
problems.append(("gui_app.py loads keys it does not save", loaded_not_saved))
stale_manifest = compare_manifest(manifest)
if stale_manifest:
problems.append(("Generated sync manifest is not current", stale_manifest))
return problems, manifest
def main() -> int:
parser = argparse.ArgumentParser(
description="Check or regenerate WebUI/Desktop GUI config sync metadata."
)
parser.add_argument(
"--sync",
action="store_true",
help="Regenerate tools/web_gui_config_manifest.json from current code.",
)
args = parser.parse_args()
if args.sync:
write_manifest()
return 0
problems, manifest = check_sync()
if problems:
print("[FAIL] WebUI and gui_app.py config keys are not synchronized.")
for title, keys in problems:
print(f"\n{title}:")
for key in keys:
print(f" - {key}")
return 1
print(
"[OK] WebUI and gui_app.py config keys are synchronized "
f"({len(manifest['shared_keys'])} shared keys)."
)
return 0
if __name__ == "__main__":
raise SystemExit(main())