render-case.py 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346
  1. #!/usr/bin/env python3
  2. # -*- coding: utf-8 -*-
  3. """
  4. render-case.py — Procedure DSL · 阶段三 3.3 落盘&渲染脚本.
  5. 把 case_data (符合 spec/format/case-data.schema.json) 通过 spec/tools/renderer.build_html
  6. 渲染成单文件 HTML.
  7. 用法:
  8. 渲染:
  9. render-case.py --workflow outputs/case-N/workflow.json \
  10. --source-input input/case-N-raw.json \
  11. --page-title "Case N · 主题" --case-id N \
  12. --out outputs/case-N/case-N-<slug>.html
  13. 只校验, 不渲染:
  14. render-case.py --workflow outputs/case-N/workflow.json --source-input input/case-N-raw.json --validate
  15. 退出码:
  16. 0 成功 (渲染或校验通过)
  17. 1 IO / schema / 渲染异常
  18. 2 CLI 参数错误
  19. 依赖:
  20. 必需: spec/tools/renderer.py (跟本脚本同目录, 自动加入 sys.path)
  21. 可选: jsonschema (装了就用 Draft 2020-12 校验; 没装则只做最小结构检查)
  22. """
  23. from __future__ import annotations
  24. import argparse
  25. import json
  26. import re
  27. import sys
  28. from pathlib import Path
  29. # Windows cp1252 console 不能直接打中文/勾选号; 把 stdout/stderr 强转 UTF-8.
  30. for _stream in (sys.stdout, sys.stderr):
  31. if hasattr(_stream, 'reconfigure'):
  32. try:
  33. _stream.reconfigure(encoding='utf-8', errors='replace')
  34. except Exception:
  35. pass
  36. # DSL_ROOT = procedure-dsl/ (本脚本位于 procedure-dsl/spec/tools/)
  37. DSL_ROOT = Path(__file__).resolve().parent.parent.parent
  38. SCHEMA_PATH = DSL_ROOT / 'spec' / 'format' / 'case-data.schema.json'
  39. # renderer.py 跟本脚本同目录 (spec/tools/), 直接用 parent 最 robust.
  40. TEMPLATE_DIR = Path(__file__).resolve().parent
  41. def _import_build_html():
  42. """延迟 import build_html, 把 examples/_build 接到 sys.path. 失败时给出明确错误."""
  43. sys.path.insert(0, str(TEMPLATE_DIR))
  44. try:
  45. from renderer import build_html # type: ignore
  46. except ImportError as e:
  47. die(f'无法导入 renderer.build_html (期望路径: {TEMPLATE_DIR}/renderer.py): {e}')
  48. return build_html
  49. def die(msg: str, code: int = 1):
  50. print(f'render-case: {msg}', file=sys.stderr)
  51. sys.exit(code)
  52. def load_json(path: Path) -> dict:
  53. if not path.exists():
  54. die(f'文件不存在: {path}')
  55. try:
  56. return json.loads(path.read_text(encoding='utf-8'))
  57. except json.JSONDecodeError as e:
  58. die(f'{path} 不是合法 JSON: {e}')
  59. def die_short(msg: str):
  60. die(msg)
  61. def merge_raw_source(case_data: dict, raw_path: Path) -> None:
  62. """从 input/case-{N}-raw.json 抽 body_text + 封面 + 图集兜底, in-place 填到 case_data.source.
  63. 设计: raw 是事实源 (原帖正文 / 封面 / 标题 / URL), case_data.source.body_text 和 cover_image
  64. 被 raw 覆盖. 其他字段 (excerpt / author / date / platform) **保留 case_data 原值** ——
  65. 那些是 Agent 推断/总结的友好版本, 不应被 raw 覆盖.
  66. 图集兜底逻辑: 微信公众号正文里有 `[image:URL]` inline markup → renderer 自动渲染就好.
  67. 小红书等"短文 + 独立图集" 平台 body_text 不含 inline markup → 把 image_url_list 里
  68. 既没 inline 也不是封面的图, 以 `[image: URL]` 形式 append 到 body_text 末尾 (附 "附图" 分隔符).
  69. 这样 renderer.render_source_body 一视同仁地把它们也渲染成 <img>, 不重复封面.
  70. """
  71. import re
  72. raw = load_json(raw_path)
  73. src = case_data.setdefault('source', {})
  74. body = raw.get('body_text', '') or ''
  75. # cover_image: image_url_list 里 image_type=2 (封面) 的第一张; 没有就 fallback 整列第一张
  76. images = raw.get('image_url_list') or []
  77. covers = [it for it in images if isinstance(it, dict) and it.get('image_type') == 2]
  78. pick = covers[0] if covers else (images[0] if images and isinstance(images[0], dict) else None)
  79. cover_url = ''
  80. if pick and pick.get('image_url'):
  81. cover_url = pick['image_url']
  82. src['cover_image'] = cover_url
  83. # 图集兜底: 检查哪些图既没在 body inline, 也不是封面 → append 到 body 末尾
  84. inlined_urls = set(re.findall(r'\[image:\s*(\S+?)\]', body))
  85. missing = []
  86. for it in images:
  87. if not isinstance(it, dict):
  88. continue
  89. u = it.get('image_url', '') or ''
  90. if not u:
  91. continue
  92. if u in inlined_urls:
  93. continue # 已 inline 不重复
  94. if u == cover_url:
  95. continue # 封面已 src-cover 单独渲染
  96. missing.append(u)
  97. if missing:
  98. suffix = '\n\n--- 附图 ---\n' + '\n'.join(f'[image: {u}]' for u in missing)
  99. body = body + suffix
  100. if body:
  101. src['body_text'] = body
  102. # title / url 兜底: case_data 漏填时从 raw 补 (Agent 一般会填)
  103. if not src.get('title') and raw.get('title'):
  104. src['title'] = raw['title']
  105. if not src.get('url') and raw.get('content_link'):
  106. src['url'] = raw['content_link']
  107. # =============================================================================
  108. # 校验
  109. # =============================================================================
  110. def validate(case_data: dict, strict: bool = True) -> list[str]:
  111. """返回错误信息列表 (空 list = 通过).
  112. 优先使用 jsonschema (Draft 2020-12); 不可用时退化到最小结构检查 (必填 key 存在 + 类型对).
  113. strict=True 时, 任何错误抛 SystemExit(1); strict=False 仅返回错误列表.
  114. """
  115. errors: list[str] = []
  116. try:
  117. from jsonschema import Draft202012Validator # type: ignore
  118. schema = load_json(SCHEMA_PATH)
  119. validator = Draft202012Validator(schema)
  120. for err in sorted(validator.iter_errors(case_data), key=lambda e: list(e.absolute_path)):
  121. path = '$' + ''.join(f'.{p}' if isinstance(p, str) else f'[{p}]' for p in err.absolute_path)
  122. errors.append(f'{path}: {err.message}')
  123. except ImportError:
  124. # 退化: 最小检查
  125. errors.extend(_minimal_check(case_data))
  126. if errors and strict:
  127. for e in errors:
  128. print(f' ✗ {e}', file=sys.stderr)
  129. print(f' ↳ schema: {SCHEMA_PATH} (要看字段约束直接 Read 这个文件, 不要猜路径)', file=sys.stderr)
  130. die(f'schema 校验失败, 共 {len(errors)} 项 (装 `pip install jsonschema` 可看完整 Draft 2020-12 报告)')
  131. return errors
  132. def _minimal_check(d: dict) -> list[str]:
  133. """无 jsonschema 时的兜底: 仅检 顶层必填 + steps 元素必填 + IO 元素必填."""
  134. errs: list[str] = []
  135. top_required = ['page_title', 'procedure', 'declarations', 'source', 'steps']
  136. for k in top_required:
  137. if k not in d:
  138. errs.append(f'$.{k}: 缺失必填字段')
  139. if not isinstance(d.get('steps'), list):
  140. errs.append('$.steps: 必须是 array')
  141. return errs
  142. # 所有 step 都要的基础字段; effect/action 仅非 block 步要 (block 是控制容器)
  143. step_required = ['id', 'kind', 'via', 'inputs', 'outputs', 'intent']
  144. exec_only = ['effect', 'action'] # kind != block 才要
  145. io_required = ['type', 'value', 'anchor']
  146. for i, step in enumerate(d['steps']):
  147. if not isinstance(step, dict):
  148. errs.append(f'$.steps[{i}]: 必须是 object'); continue
  149. need = step_required + ([] if step.get('kind') == 'block' else exec_only)
  150. for k in need:
  151. if k not in step:
  152. errs.append(f'$.steps[{i}].{k}: 缺失必填字段')
  153. for io_kind in ('inputs', 'outputs'):
  154. for j, item in enumerate(step.get(io_kind, []) or []):
  155. if not isinstance(item, dict):
  156. errs.append(f'$.steps[{i}].{io_kind}[{j}]: 必须是 object'); continue
  157. for k in io_required:
  158. if k not in item:
  159. errs.append(f'$.steps[{i}].{io_kind}[{j}].{k}: 缺失必填字段')
  160. return errs
  161. # =============================================================================
  162. # 占位门禁: 文本类 value 是 <占位> → 拒绝渲染 (强制回填真实内容)
  163. # 模态判定与 lint-case.py Check 3 一致: 文本类必须真内容, 媒体类可 <描述>, inferred 放行.
  164. # =============================================================================
  165. _PH_RE = re.compile(r'^\s*<[^>]*>\s*$')
  166. # 显式「原文未提供」标记 → 放行 (LLM 判断原文确无该信息时的轻量逃生, 等同 inferred)。
  167. # 写法如: <占位>(原文未提供) / <某分析>(原文未给出)
  168. _NOSRC_RE = re.compile(r'原文(未提供|未给出|没有|无)')
  169. _TEXT_KW = ('提示词', '描述', '参数', '评', '大纲', '脚本', '文案', '歌词', '字幕',
  170. '标题', '正文', '词', '知识', '工作流', '对标', '规格', '批处理', '模板', '版式',
  171. '数据', '分析', '报告', '记录', '方案', '思路', '设定', '依据', '标准', '清单', '列表', '文本', '文字')
  172. _MEDIA_KW = ('图', '视频', '音频', '帧', '片段', '截图', '蒙版', '音效', '配音', 'BGM',
  173. '数字人', '滤镜', '海报', '封面')
  174. def _modality(type_name: str, type_reg: dict) -> str:
  175. base, seen = type_name, set()
  176. while base in (type_reg or {}) and base not in seen:
  177. seen.add(base)
  178. ent = type_reg[base]
  179. ext = ent.get('extends') if isinstance(ent, dict) else None
  180. if not ext:
  181. break
  182. base = ext
  183. nm = base or type_name or ''
  184. if any(k in nm for k in _TEXT_KW):
  185. return 'text'
  186. if any(k in nm for k in _MEDIA_KW):
  187. return 'media'
  188. return 'unknown'
  189. def check_placeholder_values(case_data: dict) -> list[str]:
  190. """揪出文本类(非媒体、非 inferred)IO value 仍是 <占位> 的——这些必须回填真内容才放行渲染."""
  191. bad: list[str] = []
  192. for p in case_data.get('procedures') or []:
  193. pid = p.get('id') or '?'
  194. type_reg = p.get('type_registry') or {}
  195. for i, step in enumerate(p.get('steps') or []):
  196. if not isinstance(step, dict):
  197. continue
  198. for kind in ('inputs', 'outputs'):
  199. for j, io in enumerate(step.get(kind) or []):
  200. if not isinstance(io, dict) or io.get('inferred'):
  201. continue
  202. v = io.get('value')
  203. if not isinstance(v, str):
  204. continue
  205. if _NOSRC_RE.search(v):
  206. continue # 显式标了「原文未提供」→ 放行 (LLM 确认原文确无)
  207. if not _PH_RE.match(v):
  208. continue
  209. if _modality(io.get('type', '') or '', type_reg) == 'media':
  210. continue # 图/视频/音频 用 <描述> 合理
  211. bad.append(f"[{pid}] {step.get('id')}.{kind}[{j}] type={io.get('type','')!r} value={v.strip()!r}")
  212. return bad
  213. # =============================================================================
  214. # main
  215. # =============================================================================
  216. def main() -> None:
  217. ap = argparse.ArgumentParser(
  218. prog='render-case.py',
  219. description='Procedure DSL · case_data → HTML 渲染',
  220. formatter_class=argparse.RawDescriptionHelpFormatter,
  221. epilog=__doc__.split('用法:')[1] if __doc__ else '',
  222. )
  223. ap.add_argument('--workflow', type=Path, required=True,
  224. help='workflow.json (含 procedures 数组). 内部组装 case_data = '
  225. 'workflow + source-input merge + --page-title + --case-id, 不落盘 case_data.json. '
  226. '配合 --source-input / --page-title / --case-id 一起用.')
  227. ap.add_argument('--page-title', type=str, default=None,
  228. help='页面标题, 仅与 --workflow 配对. e.g. "Case 5 · 产品宣传图 AI 工作流可视化"')
  229. ap.add_argument('--case-id', type=str, default=None,
  230. help='case 编号, 仅与 --workflow 配对')
  231. ap.add_argument('--source-input', type=Path, dest='source_input',
  232. help='可选: 原帖 raw json 路径 (e.g. input/case-N-raw.json). 给了的话, 自动把 '
  233. 'raw.body_text + 封面图 / 标题 / URL 填到 case_data.source 对应字段 '
  234. '(body_text/cover_image 直接覆盖 case_data 同字段, title/url 仅在 case_data 缺时填), '
  235. '让 HTML 折叠原文区显示完整原帖正文 + 内嵌图. excerpt/author/date 等 Agent 推断字段不动.')
  236. ap.add_argument('--out', type=Path,
  237. help='输出 HTML 路径. --validate 时可省略')
  238. ap.add_argument('--validate', action='store_true',
  239. help='只做 schema 校验, 不渲染. 退出码 0=通过, 1=失败')
  240. ap.add_argument('--no-validate', action='store_true',
  241. help='跳过校验直接渲染 (不推荐)')
  242. ap.add_argument('--allow-placeholders', action='store_true',
  243. help='跳过「文本类 value 占位」门禁 (调试用; 默认: 有文本类 <占位> value 就拒绝出 HTML)')
  244. args = ap.parse_args()
  245. # workflow.json 装 procedures 主体 + cli 套 case-level meta
  246. case_data = load_json(args.workflow)
  247. if args.page_title:
  248. case_data['page_title'] = args.page_title
  249. if args.case_id is not None:
  250. try:
  251. case_data['case_id'] = int(args.case_id)
  252. except ValueError:
  253. case_data['case_id'] = args.case_id
  254. # source 由 --source-input 提供 (workflow.json 不含 source); 没给就让 schema validate 报错
  255. # raw 原帖 → case_data.source merge (在 validate 前, 让 schema 校验看到的就是完整版)
  256. if args.source_input:
  257. merge_raw_source(case_data, args.source_input)
  258. def _count_steps(cd):
  259. return sum(len(p.get('steps') or []) for p in cd.get('procedures', []))
  260. if not args.no_validate:
  261. validate(case_data, strict=not args.validate)
  262. # 占位硬门禁: 文本类 value 仍是 <占位> → 拒绝出 HTML, 逼回填真内容 (媒体类/inferred/原文未提供 放行)。
  263. # 放在这里 (validate 块外), 所以 --no-validate 也绕不过; --validate 模式也会查。
  264. if not args.allow_placeholders:
  265. ph = check_placeholder_values(case_data)
  266. if ph:
  267. print(f'render-case: ✗ {len(ph)} 处文本类 value 仍是 <占位>, 拒绝出 HTML —— 必须回填真实内容:', file=sys.stderr)
  268. for h in ph:
  269. print(f' - {h}', file=sys.stderr)
  270. print(' → 用 wf-patch 的 `@quote|<起锚>|<止锚>` + `--resolve-quotes --source <原文> --ocr <ocr.txt>` '
  271. '从原文/OCR 回填真内容;\n'
  272. ' 原文确无该信息 → value 写成 `<占位>(原文未提供)`(或给该 IO 标 `inferred:true`+reason)即可放行;\n'
  273. ' 媒体类(图/视频/音频)用 `<描述>` 本就不受此限。', file=sys.stderr)
  274. print(' (确需带占位渲染才加 --allow-placeholders)', file=sys.stderr)
  275. die(f'{len(ph)} 处文本类 value 占位未回填')
  276. if not args.no_validate and args.validate:
  277. n_procs = len(case_data.get('procedures', []))
  278. print(f'render-case: ✓ {SCHEMA_PATH.name} 校验通过 '
  279. f'({n_procs} procedure{"s" if n_procs > 1 else ""}, {_count_steps(case_data)} steps)')
  280. if not args.out:
  281. return
  282. if not args.out:
  283. ap.error('--out 必填 (除非用 --validate 只校验)')
  284. build_html = _import_build_html()
  285. html = build_html(case_data)
  286. args.out.parent.mkdir(parents=True, exist_ok=True)
  287. # newline='' 保留 build_html 返回串里的换行原貌, 防 Windows 把 \n 翻译成 \r\n
  288. args.out.write_text(html, encoding='utf-8', newline='')
  289. n_procs = len(case_data.get('procedures', []))
  290. print(f'render-case: ✓ wrote {args.out} ({len(html):,} chars, '
  291. f'{n_procs} procedure{"s" if n_procs > 1 else ""}, {_count_steps(case_data)} steps)')
  292. if __name__ == '__main__':
  293. main()