DocumentWriter(ドキュメントライター)#

PDFのみ。

バージョン1.21.0で導入

このクラスは、MuPDFでサポートされているさまざまなドキュメントタイプを出力できるユーティリティを表します。

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は入力用に再オープンしてさらに操作できます。これは、Storiesレシピのいくつかのサンプルスクリプトで使用されています。
options (str) -- 出力PDFの保存オプションを指定します。一般的なものは「compress」や「clean」です。その他の可能な値は、mutool convert CLI ユーティリティのヘルプ出力から取得できます。

begin_page(mediabox)#

指定された寸法の新しい出力ページを開始します。

パラメータ:: mediabox (rect_like) -- ページサイズを指定する矩形。このメソッドの後、出力操作はページにコンテンツを書き込むことができます。

end_page()#: ページを終了します。保留中のデータをフラッシュし、ページを出力ドキュメントに追加します。

close()#: 出力ファイルを閉じます。保留中のデータを書き込むためにこのメソッドが必要です。

使用例については、Story (ストーリー) のセクションを参照してください。

Do you have any feedback on this page?

This software is provided AS-IS with no warranty, either express or implied. This software is distributed under license and may not be copied, modified or distributed except as expressly authorized under the terms of that license. Refer to licensing information at artifex.com or contact Artifex Software Inc., 39 Mesa Street, Suite 108A, San Francisco CA 94129, United States for further information.