Kronecker/NotesAgentic
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 5 Wiki Activity

feat(export): 新增 PDF/DOCX 导出与 StaticRenderer 内部契约

Browse Source 
- 新增 PdfExporter（reportlab）与 DocxExporter（python-docx），实现与
  HtmlExporter 一致的同步 render + 异步 export，v1 文本优先（标题/段落/
  行内强调与链接/列表/引用/表格/代码块/数学文本），function_plot 与 mermaid
  保留源码占位并记 warning。
- service 层加 _EXPORTERS 注册表按格式分发，删除 format!=html 硬限制，
  扩展名/MIME/产物清理泛化到 html/pdf/docx 三种格式。
- 新增 app/plot/renderer.py：StaticRenderRequest + StaticRenderer Protocol +
  FunctionPlotStaticRenderer + MermaidStaticRenderer；HtmlExporter 改经
  FunctionPlotStaticRenderer 消费，去除对 render_svg 的直接依赖。
- 补齐 PDF/DOCX 魔法字节、CJK 字体、占位 warning 与 StaticRenderer 契约测试。
- 更新 Export开发说明.md。

Co-Authored-By: Claude Code <noreply@anthropic.com>
This commit is contained in:
yxx
2026-09-06 17:04:58 +08:00
co-authored by Claude Code
parent 966a94cad8
commit 406dd42571
11 changed files with 1334 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/development/Export开发说明.md
+33 -9
View File
@@ -1,6 +1,6 @@
# Export 开发说明
> 所属模块：Export Service（后端，负责人 yxx）。交付「多格式文档导出」：Markdown → HTML 的完整生命周期与 function-plot 静态 SVG 渲染；PDF/DOCX 在后续 PR 补齐。契约对应 [第二阶段接口契约 §10](../contracts/第二阶段接口契约-开发版.md)。
> 所属模块：Export Service（后端，负责人 yxx）。交付「多格式文档导出」：Markdown → HTML / PDF / DOCX 的完整生命周期与 function-plot 静态 SVG 渲染。契约对应 [第二阶段接口契约 §10](../contracts/第二阶段接口契约-开发版.md)。
## 定位
@@ -15,8 +15,16 @@ backend/app/export/
├── markdown.py mistune 'ast' renderer → Document AST
├── exporters/
│ ├── __init__.py
│ └── html.py HtmlExporter（Document AST → 完整 HTML5）
│ ├── _common.py 共享工具（URL 协议校验 + 占位 warning 文案 + 元数据格式化）
│ ├── html.py HtmlExporter（Document AST → 完整 HTML5）
│ ├── pdf.py PdfExporter（Document AST → PDF，reportlab）
│ └── docx.py DocxExporter（Document AST → DOCX，python-docx）
└── service.py ExportService（注册表 + 后台渲染 + 取消 + 产物生命周期）
backend/app/plot/
├── parser.py 函数图像表达式解析（白名单 AST）
├── render.py FunctionPlot → 静态 SVG
└── renderer.py StaticRenderer 内部契约（§10.4）
```
HTTP DTO（`ExportStatus` / `ExportFormat` / `ExportSource` / `ExportOptions` / `ExportJob` 等）放在 [app/contracts.py](../../backend/app/contracts.py)，与 Benchmark DTO 同层；`DocumentNode` / `ExportResult` 属导出器内部协议，放在 `export/document.py`，不进入 HTTP 契约。
@@ -31,7 +39,7 @@ HTTP DTO（`ExportStatus` / `ExportFormat` / `ExportSource` / `ExportOptions` /
| GET | `/api/exports/{job_id}/file` | 下载已完成产物 |
| POST | `/api/exports/{job_id}/cancel` | 取消任务 |
`source.type` 支持 `note`（引用已建索引笔记）与 `markdown`（未保存预览，字段为 `source.markdown`，上限 200 000 字符）。当前仅 `format=html` 实现，`pdf`/`docx` 返回 `EXPORT_FORMAT_UNSUPPORTED`。
`source.type` 支持 `note`（引用已建索引笔记）与 `markdown`（未保存预览，字段为 `source.markdown`，上限 200 000 字符）。`format` 支持 `html` / `pdf` / `docx` 三种，经 `service._EXPORTERS` 注册表按格式分发到对应导出器。
## Markdown → Document AST
@@ -41,20 +49,37 @@ fenced code 按语言分流：`mermaid` → `mermaid` 节点、`function_plot`/`
## HtmlExporter
递归渲染 Document AST 为完整 HTML5 文档（`<!doctype html>` + `<head>` 内嵌基础 CSS + `<body>`），标题/正文/元信息文本一律 `html.escape`。`function_plot` 解析为静态 SVG 内嵌（解析/渲染失败或超限时回退 `<pre class="function-plot">` 占位并记 warning），`mermaid` 无法静态表达，渲染为占位 `<pre class="mermaid">` 并记 warning，均不静默丢失；`code_theme` 仅作为代码容器 class，不引入 JS 高亮库。无法表示的节点统一 `warnings.append(...)` 跳过。
递归渲染 Document AST 为完整 HTML5 文档（`<!doctype html>` + `<head>` 内嵌基础 CSS + `<body>`），标题/正文/元信息文本一律 `html.escape`。`function_plot` 经 `FunctionPlotStaticRenderer` 解析为静态 SVG 内嵌（解析/渲染失败或超限时回退 `<pre class="function-plot">` 占位并记 warning），`mermaid` 无法静态表达，渲染为占位 `<pre class="mermaid">` 并记 warning，均不静默丢失；`code_theme` 仅作为代码容器 class，不引入 JS 高亮库。无法表示的节点统一 `warnings.append(...)` 跳过。
## StaticRenderer 内部契约（§10.4）
函数图像与 Mermaid 的静态渲染统一收敛到 `app/plot/renderer.py`：
- `StaticRenderRequest`（`kind` / `source` / `source_hash` / `theme` / `width` / `height`）是统一的渲染请求载体，`source_hash` 供缓存/去重，`theme` 供主题化渲染。
- `StaticRenderer` Protocol 定义 `render(request) -> StaticRenderResult`，导出器只面向协议，不直接调用 `render_svg`。
- `FunctionPlotStaticRenderer` 委托 `parse_source` 解析 + `render_svg` 输出内嵌 SVG；`parse` 与 `render_plot` 拆开，供导出器在渲染前先拿 `node_count` 做文档级累计复杂度预算。
- `MermaidStaticRenderer` 后端无 Mermaid 渲染能力，返回空占位结果并记 warning，交由前端渲染。
## PDF / DOCX 导出器（v1 文本优先）
`PdfExporter`（reportlab platypus）与 `DocxExporter`（python-docx）实现与 HtmlExporter 一致的同步 `render(document, options) -> ExportResult` + 异步 `export`。v1 为文本优先，覆盖标题/段落/行内强调与链接/列表/引用/表格/代码块/数学文本；`function_plot` 与 `mermaid` 保留源码占位并记 warning（与现有 Mermaid 处理一致）。
- PDF 中文字体用 reportlab 内置 `STSong-Light` CID 字体，无外部字体依赖；CID 字体无独立 bold/italic 字重，行内强调退化为普通文本（内容不丢、样式简化），标题靠字号区分层级。
- DOCX 通过 Normal 样式挂载 `w:eastAsia=宋体` 保证中文显示，bold/italic 由 Word 原生渲染；链接写入可点击的 `w:hyperlink` run。
- 扩展名/MIME：html→`.html`/`text/html`，pdf→`.pdf`/`application/pdf`，docx→`.docx`/`application/vnd.openxmlformats-officedocument.wordprocessingml.document`；路由 `FileResponse` 按 `mime_type` + `file_name` 通用化，无需改路由。
## 运行生命周期
`queued → running → completed | failed | cancelled`。
- 创建时校验：`format` 非 html → `EXPORT_FORMAT_UNSUPPORTED`；`note` 源不存在 → `EXPORT_SOURCE_NOT_FOUND`（404）；`markdown` 源为空或超上限 → `EXPORT_OPTIONS_INVALID`。
- 创建时校验：`note` 源不存在 → `EXPORT_SOURCE_NOT_FOUND`（404）；`markdown` 源为空或超上限 → `EXPORT_OPTIONS_INVALID`。
- 内存注册表上限 `MAX_JOBS=100`，超限只淘汰终态任务；满容量且全为活动任务时返回 `EXPORT_CAPACITY_EXCEEDED`（429）。
- 后台渲染在解析前后各让出一次执行权，使「创建后立即取消」的 queued 任务能及时进入 cancelled。
- 失败只向公开响应暴露项目错误码与安全消息，详细异常进入日志。
## 产物生命周期
产物写入 `settings.exports_path`（默认 `backend/data/exports/`，可通过 `APP_EXPORTS_PATH` 覆盖，已加入 `.gitignore`），文件名为 `{job_id}.html`，下载 `Content-Disposition` 用 `_safe_download_name` 清洗标题得到。`ExportFile` 记录 `sha256`、`size` 与 `expires_at`（`completed_at + 24h`），过期返回 `EXPORT_FILE_EXPIRED`（410）。
产物写入 `settings.exports_path`（默认 `backend/data/exports/`，可通过 `APP_EXPORTS_PATH` 覆盖，已加入 `.gitignore`），文件名为 `{job_id}{ext}`（`ext` 由格式决定），下载 `Content-Disposition` 用 `_safe_download_name` 清洗标题得到。`ExportFile` 记录 `sha256`、`size` 与 `expires_at`（`completed_at + 24h`），过期返回 `EXPORT_FILE_EXPIRED`（410）。
## 资源上限
@@ -75,7 +100,6 @@ fenced code 按语言分流：`mermaid` → `mermaid` 节点、`function_plot`/`
```text
EXPORT_SOURCE_NOT_FOUND 404
EXPORT_FORMAT_UNSUPPORTED 400
EXPORT_OPTIONS_INVALID 400
EXPORT_UNSUPPORTED_CONTENT 422（预留）
EXPORT_JOB_NOT_FOUND 404
@@ -97,10 +121,10 @@ cd backend
uv run pytest -q
```
`tests/test_export.py` 覆盖 Markdown 解析（标题/行内/列表/代码分流/表格/数学）、HTML 渲染（标签 + 转义 + warning）、Service 端到端（note 源与 markdown 源、pdf 拒绝、未知 note、取消、list/get、过期 410）与 `ExportSource` 契约校验。
`tests/test_export.py` 覆盖 Markdown 解析（标题/行内/列表/代码分流/表格/数学）、HTML 渲染（标签 + 转义 + warning）、Service 端到端（note 源与 markdown 源、PDF/DOCX 魔法字节与 CJK 字体、未知 note、取消、list/get、过期 410）与 `ExportSource` 契约校验。`tests/test_plot.py` 覆盖表达式解析/求值、SVG 渲染与 `StaticRenderer` 契约（函数图像渲染、Mermaid 占位）。
## 范围外（后续 PR）
- PDF / DOCX 导出（`python-docx` 等底层库在 PoC 后冻结，封装在 Exporter Adapter 内）。
- PDF 内嵌函数图像与 Mermaid 渲染（v1 仅源码占位）。
- 函数图像交互预览与缩放（前端 JS Renderer 负责，后端仅提供静态 SVG）。
- 代码语法高亮（当前仅 CSS class 占位）。