marshal --- 内部使用向けの Python オブジェクト直列化

このモジュールは、Python の値をバイナリ形式で読み書きする関数を提供します。 この形式は Python 固有ですが、マシンのアーキテクチャには依存しません (例えば PC で Python の値をファイルに書き込み、そのファイルを Mac に転送して読み戻せます)。 形式の詳細は意図的に文書化されていません。 Python のバージョンによって変更される場合があります (ただし、実際にはまれです)。 [1]

This is not a general "persistence" module. For general persistence and transfer of Python objects through RPC calls, see the modules pickle and shelve. The marshal module exists mainly to support reading and writing the "pseudo-compiled" code for Python modules of .pyc files. Therefore, the Python maintainers reserve the right to modify the marshal format in backward incompatible ways should the need arise. The format of code objects is not compatible between Python versions, even if the version of the format is the same. De-serializing a code object in the incorrect Python version has undefined behavior. If you're serializing and de-serializing Python objects, use the pickle module instead -- the performance is comparable, version independence is guaranteed, and pickle supports a substantially wider range of objects than marshal.

警告

marshal モジュールは、誤ったデータや悪意を持って作成されたデータに対する安全性を考慮していません。信頼できない、もしくは認証されていない出所からのデータを非整列化してはなりません。

Not all Python object types are supported; in general, only objects whose value is independent from a particular invocation of Python can be written and read by this module. The following types are supported: booleans, integers, floating-point numbers, complex numbers, strings, bytes, bytearrays, tuples, lists, sets, frozensets, dictionaries, and code objects (if allow_code is true), where it should be understood that tuples, lists, sets, frozensets and dictionaries are only supported as long as the values contained therein are themselves supported. The singletons None, Ellipsis and StopIteration can also be marshalled and unmarshalled. For format version lower than 3, recursive lists, sets and dictionaries cannot be written (see below).

bytes-like オブジェクトを操作する関数と同様に、ファイルの読み書きを行う関数が提供されています。

このモジュールでは、以下の関数が定義されています。

marshal.dump(value, file, version=version, /, *, allow_code=True)

開かれたファイルに値を書き込みます。値はサポートされている型でなくてはなりません。file は書き込み可能な バイナリファイル である必要があります。

値がサポートされていない型であるか、その型のオブジェクトを含む場合、ValueError を送出しますが、不正なデータもファイルに書き込まれます。 このオブジェクトは load() で正しく読み戻せません。 コードオブジェクト は allow_code が真の場合にのみサポートされます。

version 引数は dump が使用するデータフォーマットを指定します (下記を参照してください)。

引数 value, version を指定して 監査イベント marshal.dumps を送出します。

バージョン 3.13 で変更: allow_code 引数を追加しました。

marshal.load(file, /, *, allow_code=True)

開かれたファイルから値を 1 つ読み取り、返します。 有効な値を読み取れない場合 (例えば、別の Python バージョンの互換性のない marshal 形式である場合)、EOFError、ValueError、TypeError のいずれかを送出します。 コードオブジェクト は allow_code が真の場合にのみサポートされます。 ファイルは読み取り可能な バイナリファイル でなければなりません。

引数無しで 監査イベント marshal.load を送出します。

注釈

サポートされていない型を含むオブジェクトが dump() で整列化されている場合、 load() は整列化不能な値を None で置き換えます。

バージョン 3.10 で変更: 以前はコードオブジェクトごとに code.__new__ 監査イベントを発生させていました。 現在は読み込み操作全体に対して marshal.load イベントを 1 回発生させます。

バージョン 3.13 で変更: allow_code 引数を追加しました。

marshal.dumps(value, version=version, /, *, allow_code=True)

dump(value, file) でファイルに書き込まれる内容を bytes オブジェクトとして返します。 値はサポートされている型でなければなりません。 値がサポートされていない型であるか、その型のオブジェクトを含む場合、ValueError を送出します。 コードオブジェクト は allow_code が真の場合にのみサポートされます。

version 引数は dumps が使用するデータフォーマットを指定します (下記を参照してください)。

引数 value, version を指定して 監査イベント marshal.dumps を送出します。

バージョン 3.13 で変更: allow_code 引数を追加しました。

marshal.loads(bytes, /, *, allow_code=True)

bytes-like object を値に変換します。 有効な値が見つからなければ、EOFError、ValueError、TypeError のいずれかを送出します。 コードオブジェクト は allow_code が真の場合にのみサポートされます。 入力の余分なバイトは無視されます。

引数 bytes を指定して 監査イベント marshal.loads を送出します。

バージョン 3.10 で変更: 以前はコードオブジェクトごとに code.__new__ 監査イベントを発生させていました。 現在は読み込み操作全体に対して marshal.loads イベントを 1 回発生させます。

バージョン 3.13 で変更: allow_code 引数を追加しました。

これに加えて、以下の定数が定義されています:

marshal.version

Indicates the format that the module uses. Version 0 is the historical format, version 1 shares interned strings and version 2 uses a binary format for floating-point numbers. Version 3 adds support for object instancing and recursion. The current version is 4.

脚注