DocumentWriter#

此类仅适用于 PDF。

v1.21.0 新增

此类表示一个实用工具，它可以输出 PyMuPDF 支持的各种文档类型。

在 PyMuPDF 中，仅用于输出由 Story DOM 填充页面的 PDF 文档。

将 DocumentWriter 也用于其他文档类型可能会在将来实现。

方法 / 属性	简要描述
`DocumentWriter.begin_page()`	开始一个新的输出页面
`DocumentWriter.end_page()`	完成当前输出页面
`DocumentWriter.close()`	刷新待处理的输出并关闭文件

类 API

class DocumentWriter#

__init__(self, path, options=None)#

创建一个文档写入器对象，传递一个 Python 文件指针或文件路径。保存文件时使用的选项也可以传递。

此类也可以用作 Python 上下文管理器。

参数:

path –
输出文件。它可以是字符串文件名，或任何 Python 文件指针。

注意

通过使用 io.BytesIO() 对象作为文件指针，文档写入器可以在内存中创建 PDF。随后，此 PDF 可以重新打开以供输入并进一步操作。这项技术在故事示例中的多个示例脚本中被使用。
options (str) – 指定输出 PDF 的保存选项。典型选项是“compress”或“clean”。更多可能的值可以从 mutool convert CLI 实用程序的帮助输出中获取。

begin_page(mediabox)#

开始创建一个给定尺寸的新输出页面。

参数:: mediabox (rect_like) – 指定页面大小的矩形。调用此方法后，输出操作可以向页面写入内容。

end_page()#: 完成一个页面。这会刷新所有待处理数据并将页面附加到输出文档。

close()#: 关闭输出文件。此方法是写入所有待处理数据所必需的。

有关使用示例，请参阅Story部分。

此软件按“原样”提供，不提供任何明示或暗示的保证。此软件根据许可分发，未经该许可条款明确授权，不得复制、修改或分发。有关许可信息，请参阅 artifex.com，或联系 Artifex Software Inc., 39 Mesa Street, Suite 108A, San Francisco CA 94129, United States 获取进一步信息。