文档写入器#
该类仅用于PDF。
v1.21.0 中的新功能
该类表示一个工具，可以输出各种PyMuPDF 支持的文档类型。
在 PyMuPDF 中仅用于输出由 Story DOM 填充的 PDF 文档的页面。
将来可能会使用 DocumentWriter 处理其他文档类型。
方法 / 属性 |
简短描述 |
|---|---|
开始一个新的输出页面 |
|
完成当前输出页面 |
|
刷新待处理的输出并关闭文件 |
类 API
- class DocumentWriter#
- __init__(self, path, options=None)#
创建一个文档写入器对象，可以传入一个 Python 文件指针或文件路径。保存文件时也可以传递选项。
这个类也可以作为Python上下文管理器使用。
- Parameters:
路径 –
输出文件。这可以是一个字符串文件名或任何Python文件指针。
注意
通过使用
io.BytesIO()对象作为文件指针，文档写入器可以在内存中创建一个PDF。随后，该PDF可以重新打开以进行输入并进一步操作。这个技术在 故事食谱 中的几个示例脚本中被使用。选项 (str) – 指定输出PDF的保存选项。典型的选项有“压缩”或“清理”。更多可能的值可以从
mutool convert命令行工具的帮助输出中获取。
- begin_page(mediabox)#
开始一个给定尺寸的新输出页面。
- Parameters:
mediabox (rect_like) – 指定页面大小的矩形。调用此方法后，输出操作可以将内容写入页面。
- end_page()#
完成一个页面。这将冲刷所有待处理的数据并将页面附加到输出文档。
- close()#
关闭输出文件。该方法是写入任何待处理数据所必需的。
有关使用示例，请参阅故事部分。