PDF 生成模板编辑器
开源可视化 PDF 生成引擎,支持自定义模板,并提供面向开发者的 API,灵活构建文档生成流程。
概述
ComPDF Conversion SDK 支持将 Word 文档(.docx)转换为 PDF。输入为 DOCX 格式,不支持旧版二进制 .doc 格式。Word 转 PDF 不依赖 AI 模型。
基本用法
from ComPDFKitConversion import *
error = CPDFConversion.start_word_to_pdf("input.docx", "output.pdf")
if error != ErrorCode.SUCCESS:
print("Word to PDF failed:", error)start_word_to_pdf 有两种调用形式,均返回 ErrorCode:
| 调用形式 | 说明 |
|---|---|
start_word_to_pdf(file_path, output_path, callback=None) | 使用默认选项:不生成书签,输出全部页面 |
start_word_to_pdf(file_path, output_path, options, callback=None) | 通过 ConvertOptions 指定书签与页面范围(Word 转 PDF 只使用这两项) |
callback 为可选的 ConvertCallback,用法与 PDF 转换相同,可用于获取进度和取消转换。
书签与页面范围
Word 转 PDF 只使用 ConvertOptions 的以下属性,其他属性不生效:
| 属性 | 默认 | 含义 |
|---|---|---|
word_pdf_bookmark_mode | WordPdfBookmarkMode.NONE | 如何生成 PDF 书签(阅读器导航栏中的目录) |
page_ranges | 空字符串 | 指定输出的页码,如 "1-3,5,7-9";空表示输出所有页 |
WordPdfBookmarkMode 的取值:
| 值 | 含义 |
|---|---|
NONE | 不生成书签 |
HEADINGS | 每个标题(带大纲级别的段落)生成一个书签,按级别嵌套 |
WORD_BOOKMARKS | 每个 Word 书签生成一个书签,书签名与 Word 中一致 |
文档属性(标题、作者、主题、关键词)始终按 Word 文档中填写的内容写入 PDF。
options = ConvertOptions()
options.word_pdf_bookmark_mode = WordPdfBookmarkMode.HEADINGS # or WORD_BOOKMARKS
options.page_ranges = "1-3,5,7-9"
callback = ConvertCallback()
callback.set_progress(lambda current, total: print(f"Progress: {current}/{total}"))
error = CPDFConversion.start_word_to_pdf("input.docx", "output.pdf", options, callback)返回值与不支持特性的提示
ErrorCode.SUCCESS;通过回调取消转换返回 ErrorCode.CANCEL,且不生成输出文件。ErrorCode.PDF_PAGE_ERROR,且不生成输出文件。ErrorCode.UNSUPPORTED_FEATURE(95)。此时 PDF 通常仍会生成,请检查输出文件是否存在并确认内容。转换本身失败时返回真实的错误码,优先于 95。可用条件
Word 转 PDF 由 SDK 的原生库提供,4.2.0 及更早版本的 Python 模块不包含该入口。如需让同一份代码兼容不同版本的模块,可先判断:
if hasattr(CPDFConversion, "start_word_to_pdf"):
error = CPDFConversion.start_word_to_pdf("input.docx", "output.pdf")从源码构建 Python 包时,setup.py 会在构建阶段检查所用原生库是否提供 Word 转 PDF;如果原生库使用的是旧版接口,构建会失败并提示使用同一修订的原生库、绑定源码与头文件。