render-case.py 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269
  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 sys
  27. from pathlib import Path
  28. # Windows cp1252 console 不能直接打中文/勾选号; 把 stdout/stderr 强转 UTF-8.
  29. for _stream in (sys.stdout, sys.stderr):
  30. if hasattr(_stream, 'reconfigure'):
  31. try:
  32. _stream.reconfigure(encoding='utf-8', errors='replace')
  33. except Exception:
  34. pass
  35. # DSL_ROOT = procedure-dsl/ (本脚本位于 procedure-dsl/spec/tools/)
  36. DSL_ROOT = Path(__file__).resolve().parent.parent.parent
  37. SCHEMA_PATH = DSL_ROOT / 'spec' / 'format' / 'case-data.schema.json'
  38. # renderer.py 跟本脚本同目录 (spec/tools/), 直接用 parent 最 robust.
  39. TEMPLATE_DIR = Path(__file__).resolve().parent
  40. def _import_build_html():
  41. """延迟 import build_html, 把 examples/_build 接到 sys.path. 失败时给出明确错误."""
  42. sys.path.insert(0, str(TEMPLATE_DIR))
  43. try:
  44. from renderer import build_html # type: ignore
  45. except ImportError as e:
  46. die(f'无法导入 renderer.build_html (期望路径: {TEMPLATE_DIR}/renderer.py): {e}')
  47. return build_html
  48. def die(msg: str, code: int = 1):
  49. print(f'render-case: {msg}', file=sys.stderr)
  50. sys.exit(code)
  51. def load_json(path: Path) -> dict:
  52. if not path.exists():
  53. die(f'文件不存在: {path}')
  54. try:
  55. return json.loads(path.read_text(encoding='utf-8'))
  56. except json.JSONDecodeError as e:
  57. die(f'{path} 不是合法 JSON: {e}')
  58. def die_short(msg: str):
  59. die(msg)
  60. def merge_raw_source(case_data: dict, raw_path: Path) -> None:
  61. """从 input/case-{N}-raw.json 抽 body_text + 封面 + 图集兜底, in-place 填到 case_data.source.
  62. 设计: raw 是事实源 (原帖正文 / 封面 / 标题 / URL), case_data.source.body_text 和 cover_image
  63. 被 raw 覆盖. 其他字段 (excerpt / author / date / platform) **保留 case_data 原值** ——
  64. 那些是 Agent 推断/总结的友好版本, 不应被 raw 覆盖.
  65. 图集兜底逻辑: 微信公众号正文里有 `[image:URL]` inline markup → renderer 自动渲染就好.
  66. 小红书等"短文 + 独立图集" 平台 body_text 不含 inline markup → 把 image_url_list 里
  67. 既没 inline 也不是封面的图, 以 `[image: URL]` 形式 append 到 body_text 末尾 (附 "附图" 分隔符).
  68. 这样 renderer.render_source_body 一视同仁地把它们也渲染成 <img>, 不重复封面.
  69. """
  70. import re
  71. raw = load_json(raw_path)
  72. src = case_data.setdefault('source', {})
  73. body = raw.get('body_text', '') or ''
  74. # cover_image: image_url_list 里 image_type=2 (封面) 的第一张; 没有就 fallback 整列第一张
  75. images = raw.get('image_url_list') or []
  76. covers = [it for it in images if isinstance(it, dict) and it.get('image_type') == 2]
  77. pick = covers[0] if covers else (images[0] if images and isinstance(images[0], dict) else None)
  78. cover_url = ''
  79. if pick and pick.get('image_url'):
  80. cover_url = pick['image_url']
  81. src['cover_image'] = cover_url
  82. # 图集兜底: 检查哪些图既没在 body inline, 也不是封面 → append 到 body 末尾
  83. inlined_urls = set(re.findall(r'\[image:\s*(\S+?)\]', body))
  84. missing = []
  85. for it in images:
  86. if not isinstance(it, dict):
  87. continue
  88. u = it.get('image_url', '') or ''
  89. if not u:
  90. continue
  91. if u in inlined_urls:
  92. continue # 已 inline 不重复
  93. if u == cover_url:
  94. continue # 封面已 src-cover 单独渲染
  95. missing.append(u)
  96. if missing:
  97. suffix = '\n\n--- 附图 ---\n' + '\n'.join(f'[image: {u}]' for u in missing)
  98. body = body + suffix
  99. if body:
  100. src['body_text'] = body
  101. # title / url 兜底: case_data 漏填时从 raw 补 (Agent 一般会填)
  102. if not src.get('title') and raw.get('title'):
  103. src['title'] = raw['title']
  104. if not src.get('url') and raw.get('content_link'):
  105. src['url'] = raw['content_link']
  106. # =============================================================================
  107. # 校验
  108. # =============================================================================
  109. def validate(case_data: dict, strict: bool = True) -> list[str]:
  110. """返回错误信息列表 (空 list = 通过).
  111. 优先使用 jsonschema (Draft 2020-12); 不可用时退化到最小结构检查 (必填 key 存在 + 类型对).
  112. strict=True 时, 任何错误抛 SystemExit(1); strict=False 仅返回错误列表.
  113. """
  114. errors: list[str] = []
  115. try:
  116. from jsonschema import Draft202012Validator # type: ignore
  117. schema = load_json(SCHEMA_PATH)
  118. validator = Draft202012Validator(schema)
  119. for err in sorted(validator.iter_errors(case_data), key=lambda e: list(e.absolute_path)):
  120. path = '$' + ''.join(f'.{p}' if isinstance(p, str) else f'[{p}]' for p in err.absolute_path)
  121. errors.append(f'{path}: {err.message}')
  122. except ImportError:
  123. # 退化: 最小检查
  124. errors.extend(_minimal_check(case_data))
  125. if errors and strict:
  126. for e in errors:
  127. print(f' ✗ {e}', file=sys.stderr)
  128. print(f' ↳ schema: {SCHEMA_PATH} (要看字段约束直接 Read 这个文件, 不要猜路径)', file=sys.stderr)
  129. die(f'schema 校验失败, 共 {len(errors)} 项 (装 `pip install jsonschema` 可看完整 Draft 2020-12 报告)')
  130. return errors
  131. def _minimal_check(d: dict) -> list[str]:
  132. """无 jsonschema 时的兜底: 仅检 顶层必填 + steps 元素必填 + IO 元素必填."""
  133. errs: list[str] = []
  134. top_required = ['page_title', 'procedure', 'declarations', 'source', 'steps']
  135. for k in top_required:
  136. if k not in d:
  137. errs.append(f'$.{k}: 缺失必填字段')
  138. if not isinstance(d.get('steps'), list):
  139. errs.append('$.steps: 必须是 array')
  140. return errs
  141. # 所有 step 都要的基础字段; effect/action/focus 仅非 block 步要 (block 是控制容器)
  142. step_required = ['id', 'kind', 'via', 'feature', 'inputs', 'outputs', 'intent']
  143. exec_only = ['effect', 'action', 'focus'] # kind != block 才要
  144. io_required = ['type', 'name', 'value', 'anchor']
  145. for i, step in enumerate(d['steps']):
  146. if not isinstance(step, dict):
  147. errs.append(f'$.steps[{i}]: 必须是 object'); continue
  148. need = step_required + ([] if step.get('kind') == 'block' else exec_only)
  149. for k in need:
  150. if k not in step:
  151. errs.append(f'$.steps[{i}].{k}: 缺失必填字段')
  152. for io_kind in ('inputs', 'outputs'):
  153. for j, item in enumerate(step.get(io_kind, []) or []):
  154. if not isinstance(item, dict):
  155. errs.append(f'$.steps[{i}].{io_kind}[{j}]: 必须是 object'); continue
  156. for k in io_required:
  157. if k not in item:
  158. errs.append(f'$.steps[{i}].{io_kind}[{j}].{k}: 缺失必填字段')
  159. return errs
  160. # =============================================================================
  161. # main
  162. # =============================================================================
  163. def main() -> None:
  164. ap = argparse.ArgumentParser(
  165. prog='render-case.py',
  166. description='Procedure DSL · case_data → HTML 渲染',
  167. formatter_class=argparse.RawDescriptionHelpFormatter,
  168. epilog=__doc__.split('用法:')[1] if __doc__ else '',
  169. )
  170. ap.add_argument('--workflow', type=Path, required=True,
  171. help='workflow.json (含 procedures 数组). 内部组装 case_data = '
  172. 'workflow + source-input merge + --page-title + --case-id, 不落盘 case_data.json. '
  173. '配合 --source-input / --page-title / --case-id 一起用.')
  174. ap.add_argument('--page-title', type=str, default=None,
  175. help='页面标题, 仅与 --workflow 配对. e.g. "Case 5 · 产品宣传图 AI 工作流可视化"')
  176. ap.add_argument('--case-id', type=str, default=None,
  177. help='case 编号, 仅与 --workflow 配对')
  178. ap.add_argument('--source-input', type=Path, dest='source_input',
  179. help='可选: 原帖 raw json 路径 (e.g. input/case-N-raw.json). 给了的话, 自动把 '
  180. 'raw.body_text + 封面图 / 标题 / URL 填到 case_data.source 对应字段 '
  181. '(body_text/cover_image 直接覆盖 case_data 同字段, title/url 仅在 case_data 缺时填), '
  182. '让 HTML 折叠原文区显示完整原帖正文 + 内嵌图. excerpt/author/date 等 Agent 推断字段不动.')
  183. ap.add_argument('--out', type=Path,
  184. help='输出 HTML 路径. --validate 时可省略')
  185. ap.add_argument('--validate', action='store_true',
  186. help='只做 schema 校验, 不渲染. 退出码 0=通过, 1=失败')
  187. ap.add_argument('--no-validate', action='store_true',
  188. help='跳过校验直接渲染 (不推荐)')
  189. args = ap.parse_args()
  190. # workflow.json 装 procedures 主体 + cli 套 case-level meta
  191. case_data = load_json(args.workflow)
  192. if args.page_title:
  193. case_data['page_title'] = args.page_title
  194. if args.case_id is not None:
  195. try:
  196. case_data['case_id'] = int(args.case_id)
  197. except ValueError:
  198. case_data['case_id'] = args.case_id
  199. # source 由 --source-input 提供 (workflow.json 不含 source); 没给就让 schema validate 报错
  200. # raw 原帖 → case_data.source merge (在 validate 前, 让 schema 校验看到的就是完整版)
  201. if args.source_input:
  202. merge_raw_source(case_data, args.source_input)
  203. def _count_steps(cd):
  204. return sum(len(p.get('steps') or []) for p in cd.get('procedures', []))
  205. if not args.no_validate:
  206. validate(case_data, strict=not args.validate)
  207. if args.validate:
  208. n_procs = len(case_data.get('procedures', []))
  209. print(f'render-case: ✓ {SCHEMA_PATH.name} 校验通过 '
  210. f'({n_procs} procedure{"s" if n_procs > 1 else ""}, {_count_steps(case_data)} steps)')
  211. if not args.out:
  212. return
  213. if not args.out:
  214. ap.error('--out 必填 (除非用 --validate 只校验)')
  215. build_html = _import_build_html()
  216. html = build_html(case_data)
  217. args.out.parent.mkdir(parents=True, exist_ok=True)
  218. # newline='' 保留 build_html 返回串里的换行原貌, 防 Windows 把 \n 翻译成 \r\n
  219. args.out.write_text(html, encoding='utf-8', newline='')
  220. n_procs = len(case_data.get('procedures', []))
  221. print(f'render-case: ✓ wrote {args.out} ({len(html):,} chars, '
  222. f'{n_procs} procedure{"s" if n_procs > 1 else ""}, {_count_steps(case_data)} steps)')
  223. if __name__ == '__main__':
  224. main()