pickletools — pickle 开发人员的工具

源代码： Lib/pickletools.py

---

这个模块包含与 pickle 模块的内部细节相关的各种常量，一些关于实现的详细注释，以及一些用于分析 pickle 数据的有用函数。这个模块的内容对于正在开发 pickle 的 Python 核心开发人员很有用； pickle 模块的普通用户可能不会觉得 pickletools 模块相关。

命令行用法

3.2 版本新增。

从命令行调用时，python -m pickletools 将反汇编一个或多个 pickle 文件的内容。 请注意，如果您想查看存储在 pickle 中的 Python 对象而不是 pickle 格式的细节，您可能需要使用 -m pickle。 但是，当您要检查的 pickle 文件来自不受信任的来源时，-m pickletools 是更安全的选择，因为它不执行 pickle 字节码。

例如，对于在文件 x.pickle 中 pickle 的元组 (1, 2)

$ python -m pickle x.pickle
(1, 2)

$ python -m pickletools x.pickle
    0: \x80 PROTO      3
    2: K    BININT1    1
    4: K    BININT1    2
    6: \x86 TUPLE2
    7: q    BINPUT     0
    9: .    STOP
highest protocol among opcodes = 2

命令行选项

-a, --annotate

用简短的操作码描述注释每一行。

-o, --output=<file>

应在其中写入输出的文件的名称。

-l, --indentlevel=<num>

缩进新 MARK 级别的空格数。

-m, --memo

当反汇编多个对象时，在反汇编之间保留 memo。

-p, --preamble=<preamble>

当指定多个 pickle 文件时，在每次反汇编之前打印给定的 preamble。

程序化接口

pickletools.dis(pickle, out=None, memo=None, indentlevel=4, annotate=0)

将 pickle 的符号反汇编输出到类文件对象 out，默认为 sys.stdout。 pickle 可以是字符串或类文件对象。 memo 可以是一个 Python 字典，它将被用作 pickle 的 memo； 它可用于在同一 pickler 创建的多个 pickle 中执行反汇编。 由流中的 MARK 操作码指示的连续级别按 indentlevel 空格缩进。 如果为 annotate 提供非零值，则输出中的每个操作码都会用简短的描述进行注释。 annotate 的值用作注释应开始的列的提示。

在 3.2 版本中变更：添加了 annotate 参数。

pickletools.genops(pickle)

提供一个在 pickle 中所有操作码上的 迭代器，返回 (opcode, arg, pos) 三元组序列。 opcode 是 OpcodeInfo 类的实例； arg 是操作码参数的解码值，作为 Python 对象； pos 是此操作码所在的位置。 pickle 可以是字符串或类文件对象。

pickletools.optimize(picklestring)

在消除未使用的 PUT 操作码后，返回一个新的等效 pickle 字符串。 优化的 pickle 更短，传输时间更少，需要的存储空间更少，并且反 pickle 的效率更高。