Python/docs/3.9/library/marshal

marshal — Python 内部对象序列化

---

该模块包含可以以二进制格式读取和写入 Python 值的函数。 该格式特定于 Python，但与机器架构问题无关（例如，您可以将 Python 值写入 PC 上的文件，将文件传输到 Sun，然后从那里读取）。 格式的详细信息是故意没有记录的； 它可能会在 Python 版本之间发生变化（尽管很少发生）。 1

这不是一个通用的“持久性”模块。 对于通过 RPC 调用的 Python 对象的一般持久化和传输，请参阅模块 pickle 和 shelve。 marshal模块的存在主要是为了支持对.pyc文件的Python模块的“伪编译”代码的读写。 因此，Python 维护者保留在需要时以向后不兼容的方式修改 marshal 格式的权利。 如果您正在序列化和反序列化 Python 对象，请改用 pickle 模块 - 性能相当，版本独立性得到保证，并且 pickle 支持的对象范围比 marshal 大得多。

警告

marshal 模块并非旨在针对错误或恶意构建的数据提供安全保护。 切勿解组从不受信任或未经身份验证的来源收到的数据。

并非所有 Python 对象类型都受支持； 通常，该模块只能写入和读取其值与特定 Python 调用无关的对象。 支持以下类型：布尔值、整数、浮点数、复数、字符串、字节、字节数组、元组、列表、集合、冻结集、字典和代码对象，其中应理解元组、列表、集合、冻结集和字典仅在其中包含的值本身受支持时才受支持。 单例 None、Ellipsis 和 StopIteration 也可以被编组和解组。 对于低于 3 的格式 version，不能编写递归列表、集合和字典（见下文）。

有读/写文件的函数以及操作字节类对象的函数。

该模块定义了以下功能：

marshal.dump(value, file[, version])

在打开的文件上写入值。 该值必须是受支持的类型。 该文件必须是可写的 二进制文件 。

如果值具有（或包含具有）不受支持的类型，则会引发 ValueError 异常 - 但垃圾数据也将写入文件。 load() 将无法正确读回该对象。

version 参数表示 dump 应该使用的数据格式（见下文）。

marshal.load(file)

从打开的文件中读取一个值并返回它。 如果没有读取到有效值（例如 因为数据具有不同的 Python 版本的不兼容的 marshal 格式），引发 EOFError、ValueError 或 TypeError。 该文件必须是可读的 二进制文件 。

笔记

如果包含不受支持的类型的对象使用 dump() 进行编组，则 load() 将替换 None 为不可编组的类型。

在 3.9.7 版更改：此调用用于为每个代码对象引发 code.__new__ 审核事件。 现在，它为整个加载操作引发了一个 marshal.load 事件。

marshal.dumps(value[, version])

返回将由 dump(value, file) 写入文件的字节对象。 该值必须是受支持的类型。 如果 value 具有（或包含具有）不受支持的类型，则引发 ValueError 异常。

version 参数表示 dumps 应该使用的数据格式（见下文）。

marshal.loads(bytes)

将 bytes-like object 转换为一个值。 如果未找到有效值，则引发 EOFError、ValueError 或 TypeError。 输入中的额外字节将被忽略。

在 3.9.7 版更改：此调用用于为每个代码对象引发 code.__new__ 审核事件。 现在，它为整个加载操作引发了一个 marshal.loads 事件。

此外，还定义了以下常量：

marshal.version

指示模块使用的格式。 版本 0 是历史格式，版本 1 共享内部字符串，版本 2 对浮点数使用二进制格式。 版本 3 添加了对对象实例化和递归的支持。 当前版本是4。

脚注

1

该模块的名称源于 Modula-3 的设计者（以及其他人）使用的一些术语，他们使用术语“编组”来以独立的形式传送数据。 严格来说，“to marshal”意味着将一些数据从内部形式转换为外部形式（例如在 RPC 缓冲区中），并为反向过程“解组”。