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

======================================================================

このモジュールには Python 値をバイナリ形式で読み書きできるような関数が
含まれています。このバイナリ形式は Python 特有のものですが、マシンアー
キテクチャ非依存のものです (つまり、Python の値を PC 上でファイルに書
き込み、Sun に転送し、そこで読み戻すことができます)。バイナリ形式の詳
細は意図的にドキュメント化されていません; この形式は (稀にしかないこと
ですが) 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 は書き込み可能な  *バイナリファイル* である必
   要があります。

   If the value has (or contains an object that has) an unsupported
   type, a "ValueError" exception is raised --- but garbage data will
   also be written to the file.  The object will not be properly read
   back by "load()". Code objects are only supported if *allow_code*
   is true.

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

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

   バージョン 3.13 で変更: Added the *allow_code* parameter.

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

   Read one value from the open file and return it.  If no valid value
   is read (e.g. because the data has a different Python version's
   incompatible marshal format), raise "EOFError", "ValueError" or
   "TypeError". Code objects are only supported if *allow_code* is
   true. The file must be a readable *binary file*.

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

   注釈:

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

   バージョン 3.10 で変更: This call used to raise a "code.__new__"
   audit event for each code object. Now it raises a single
   "marshal.load" event for the entire load operation.

   バージョン 3.13 で変更: Added the *allow_code* parameter.

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

   Return the bytes object that would be written to a file by
   "dump(value, file)".  The value must be a supported type.  Raise a
   "ValueError" exception if value has (or contains an object that
   has) an unsupported type. Code objects are only supported if
   *allow_code* is true.

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

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

   バージョン 3.13 で変更: Added the *allow_code* parameter.

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

   Convert the *bytes-like object* to a value.  If no valid value is
   found, raise "EOFError", "ValueError" or "TypeError". Code objects
   are only supported if *allow_code* is true. Extra bytes in the
   input are ignored.

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

   バージョン 3.10 で変更: This call used to raise a "code.__new__"
   audit event for each code object. Now it raises a single
   "marshal.loads" event for the entire load operation.

   バージョン 3.13 で変更: Added the *allow_code* parameter.

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

marshal.version

   このモジュールが利用するバージョンを表します。バージョン0 は歴史的
   なフォーマットです。バージョン1 は文字列の再利用をします。バージョ
   ン2 は浮動小数点数にバイナリフォーマットを使用します。バージョン3
   はオブジェクトのインスタンス化と再帰をサポートします。現在のバージ
   ョンは4です。

-[ 脚注 ]-

[1] このモジュールの名前は (特に) Modula-3 の設計者の間で使われていた
    用語の一つに由来しています。彼らはデータを自己充足的な形式で輸送す
    る操作に "整列化 (marshalling)" という用語を使いました。厳密に言え
    ば、"整列させる (to marshal)" とは、あるデータを (例えば RPC バッ
    ファのように) 内部表現形式から外部表現形式に変換することを意味し、
    "非整列化 (unmarshalling)" とはその逆を意味します。
