dis — Python 字节码反汇编器¶

命令行界面¶

The dis 模块可以作为脚本从命令行调用

python -m dis [-h] [infile]

接受以下选项

-h, --help¶

显示用法并退出。

如果指定了 infile，则其反汇编代码将写入 stdout。否则，将对从 stdin 收到的已编译源代码执行反汇编。

字节码分析¶

字节码分析 API 允许将 Python 代码片段包装在 Bytecode 对象中，该对象提供对已编译代码的详细信息的轻松访问。

class dis.Bytecode(x, *, first_line=None, current_offset=None, show_caches=False, adaptive=False)¶

分析与函数、生成器、异步生成器、协程、方法、源代码字符串或代码对象（由 compile() 返回）相对应的字节码。

这是对下面列出的许多函数（最值得注意的是 get_instructions()）的便捷包装器，因为迭代 Bytecode 实例会产生字节码操作作为 Instruction 实例。

如果 first_line 不是 None，则它表示应为反汇编代码中的第一行源代码报告的行号。否则，源代码行信息（如果有）将直接从反汇编的代码对象中获取。

如果 current_offset 不是 None，则它指的是反汇编代码中的指令偏移量。设置此值意味着 dis() 将在指定的 opcode 处显示“当前指令”标记。

如果 show_caches 为 True，则 dis() 将显示解释器用来专门化字节码的内联缓存条目。

如果 adaptive 为 True，则 dis() 将显示专门化的字节码，它可能与原始字节码不同。

classmethod from_traceback(tb, *, show_caches=False)¶

从给定的跟踪信息构建 Bytecode 实例，将 current_offset 设置为导致异常的指令。

codeobj¶

已编译的代码对象。

first_line¶

代码对象的第一个源代码行（如果可用）。

dis()¶

返回字节码操作的格式化视图（与 dis.dis() 打印的相同，但作为多行字符串返回）。

info()¶

返回一个格式化的多行字符串，其中包含有关代码对象的详细信息，例如 code_info()。

在版本 3.7 中更改: 现在可以处理协程和异步生成器对象。

在版本 3.11 中更改: 添加了 show_caches 和 adaptive 参数。

示例

>>> bytecode = dis.Bytecode(myfunc)
>>> for instr in bytecode:
...     print(instr.opname)
...
RESUME
LOAD_GLOBAL
LOAD_FAST
CALL
RETURN_VALUE

分析函数¶

The dis 模块还定义了以下分析函数，这些函数将输入直接转换为所需的输出。如果只执行单个操作，它们可能很有用，因此中间分析对象没有用。

dis.code_info(x)¶

返回一个格式化的多行字符串，其中包含为提供的函数、生成器、异步生成器、协程、方法、源代码字符串或代码对象提供的详细代码对象信息。

请注意，代码信息字符串的确切内容高度依赖于实现，并且它们可能在不同的 Python VM 或 Python 版本之间任意更改。

在版本 3.2 中添加。

在版本 3.7 中更改: 现在可以处理协程和异步生成器对象。

dis.show_code(x, *, file=None)¶

将提供的函数、方法、源代码字符串或代码对象的详细代码对象信息打印到 file（如果未指定 file，则打印到 sys.stdout）。

这是 print(code_info(x), file=file) 的便捷简写，旨在用于解释器提示符处的交互式探索。

在版本 3.2 中添加。

在版本 3.4 中更改：添加了 file 参数。

dis.dis(x=None, *, file=None, depth=None, show_caches=False, adaptive=False)¶

反汇编 x 对象。x 可以表示模块、类、方法、函数、生成器、异步生成器、协程、代码对象、源代码字符串或原始字节码的字节序列。对于模块，它反汇编所有函数。对于类，它反汇编所有方法（包括类方法和静态方法）。对于代码对象或原始字节码序列，它为每个字节码指令打印一行。它还递归地反汇编嵌套的代码对象。这些可以包括生成器表达式、嵌套函数、嵌套类的主体以及用于 注释范围 的代码对象。字符串首先使用 compile() 内置函数编译为代码对象，然后再反汇编。如果没有提供对象，此函数将反汇编最后一个回溯。

反汇编结果将以文本形式写入提供的 file 参数，如果没有提供，则写入 sys.stdout。

除非 depth 为 None，否则递归的最大深度受 depth 限制。 depth=0 表示不递归。

如果 show_caches 为 True，此函数将显示解释器用于专门化字节码的内联缓存条目。

如果 adaptive 为 True，此函数将显示可能与原始字节码不同的专门化字节码。

在版本 3.4 中更改：添加了 file 参数。

在版本 3.7 中更改：实现了递归反汇编并添加了 depth 参数。

在版本 3.7 中更改: 现在可以处理协程和异步生成器对象。

在版本 3.11 中更改: 添加了 show_caches 和 adaptive 参数。

dis.distb(tb=None, *, file=None, show_caches=False, adaptive=False)¶

反汇编回溯的栈顶函数，如果未传递任何回溯，则使用最后一个回溯。导致异常的指令将被指示。

反汇编结果将以文本形式写入提供的 file 参数，如果没有提供，则写入 sys.stdout。

在版本 3.4 中更改：添加了 file 参数。

在版本 3.11 中更改: 添加了 show_caches 和 adaptive 参数。

dis.disassemble(code, lasti=-1, *, file=None, show_caches=False, adaptive=False)¶

dis.disco(code, lasti=-1, *, file=None, show_caches=False, adaptive=False)¶

反汇编代码对象，如果提供了 lasti，则指示最后一条指令。输出分为以下几列

1. 每行的第一条指令的行号

2. 当前指令，用 --> 表示

3. 带标签的指令，用 >> 表示

4. 指令的地址

5. 操作码名称

6. 操作参数

7. 参数的解释（在括号中）。

参数解释识别局部变量和全局变量名称、常量值、分支目标和比较运算符。

反汇编结果将以文本形式写入提供的 file 参数，如果没有提供，则写入 sys.stdout。

在版本 3.4 中更改：添加了 file 参数。

在版本 3.11 中更改: 添加了 show_caches 和 adaptive 参数。

dis.get_instructions(x, *, first_line=None, show_caches=False, adaptive=False)¶

返回提供的函数、方法、源代码字符串或代码对象中的指令的迭代器。

迭代器生成一系列 Instruction 命名元组，提供提供的代码中每个操作的详细信息。

如果 first_line 不是 None，则它表示应为反汇编代码中的第一行源代码报告的行号。否则，源代码行信息（如果有）将直接从反汇编的代码对象中获取。

show_caches 和 adaptive 参数的工作方式与 dis() 中的相同。

在版本 3.4 中添加。

在版本 3.11 中更改: 添加了 show_caches 和 adaptive 参数。

dis.findlinestarts(code)¶

此生成器函数使用 co_lines() 方法，该方法属于 代码对象 code，用于查找源代码中行的起始偏移量。它们以 (offset, lineno) 对的形式生成。

在 3.6 版本中变更: 行号可以递减。之前，它们总是递增的。

在 3.10 版本中变更: 使用 PEP 626 co_lines() 方法，而不是 co_firstlineno 和 co_lnotab 属性，它们属于 代码对象。

dis.findlabels(code)¶

检测原始编译字节码字符串 code 中所有作为跳转目标的偏移量，并返回这些偏移量的列表。

dis.stack_effect(opcode, oparg=None, *, jump=None)¶

计算 opcode 带参数 oparg 的堆栈效应。

如果代码有跳转目标并且 jump 为 True，stack_effect() 将返回跳转的堆栈效应。如果 jump 为 False，它将返回不跳转的堆栈效应。如果 jump 为 None（默认值），它将返回两种情况的最大堆栈效应。

在版本 3.4 中添加。

在 3.8 版本中变更: 添加了 jump 参数。

Python 字节码指令¶

get_instructions() 函数和 Bytecode 类以 Instruction 实例的形式提供字节码指令的详细信息。

class dis.Instruction¶

字节码操作的详细信息

opcode¶

操作的数字代码，对应于下面列出的操作码值和 操作码集合 中的字节码值。

opname¶

操作的人类可读名称

arg¶

操作的数字参数（如果有），否则为 None

argval¶

解析后的参数值（如果有），否则为 None

argrepr¶

操作参数的人类可读描述（如果有），否则为空字符串。

offset¶

操作在字节码序列中的起始索引

starts_line¶

此操作码开始的行（如果有），否则为 None

is_jump_target¶

True 如果其他代码跳转到这里，否则为 False

positions¶

dis.Positions 对象，保存此指令覆盖的开始和结束位置。

在版本 3.4 中添加。

在 3.11 版本中变更: 添加了字段 positions。

class dis.Positions¶

如果信息不可用，某些字段可能为 None。

lineno¶

end_lineno¶

col_offset¶

end_col_offset¶

在 3.11 版本中添加。

Python 编译器目前生成以下字节码指令。

通用指令

在下文中，我们将解释器堆栈称为 STACK，并将描述对它的操作，就好像它是一个 Python 列表一样。堆栈顶端对应于此语言中的 STACK[-1]。

NOP¶

不执行任何操作的代码。用作字节码优化器的占位符，以及生成行跟踪事件。

POP_TOP¶

删除堆栈顶部的项目

STACK.pop()

END_FOR¶

从堆栈中删除前两个值。等效于 POP_TOP; POP_TOP。用于在循环结束时清理，因此得名。

在 3.12 版本中添加。

END_SEND¶

实现 del STACK[-2]。用于在生成器退出时清理。

在 3.12 版本中添加。

COPY(i)¶

将第 i 个项目推送到堆栈顶部，而不将其从原始位置删除

assert i > 0
STACK.append(STACK[-i])

在 3.11 版本中添加。

SWAP(i)¶

将堆栈顶部与第 i 个元素交换

STACK[-i], STACK[-1] = STACK[-1], STACK[-i]

在 3.11 版本中添加。

CACHE¶

此操作码并非实际指令，而是用于为解释器标记额外的空间，以便解释器直接在字节码中缓存有用的数据。它被所有 dis 工具自动隐藏，但可以使用 show_caches=True 查看。

从逻辑上讲，此空间是前一个指令的一部分。许多操作码期望后面跟着确切数量的缓存，并将指示解释器在运行时跳过它们。

填充的缓存可能看起来像任意指令，因此在读取或修改包含加速数据的原始自适应字节码时，应格外小心。

在 3.11 版本中添加。

一元运算

一元运算从堆栈顶部获取值，应用运算，并将结果压回堆栈。

UNARY_NEGATIVE¶

实现 STACK[-1] = -STACK[-1]。

UNARY_NOT¶

实现 STACK[-1] = not STACK[-1]。

UNARY_INVERT¶

实现 STACK[-1] = ~STACK[-1]。

GET_ITER¶

实现 STACK[-1] = iter(STACK[-1])。

GET_YIELD_FROM_ITER¶

如果 STACK[-1] 是一个 生成器迭代器 或 协程 对象，则保持不变。否则，实现 STACK[-1] = iter(STACK[-1])。

在版本 3.5 中添加。

二元运算和就地运算

二元运算从堆栈中移除最上面的两个元素 (STACK[-1] 和 STACK[-2])。它们执行运算，然后将结果放回堆栈。

就地运算类似于二元运算，但当 STACK[-2] 支持时，运算是在原地完成的，并且生成的 STACK[-1] 可能是（但不必是）原始的 STACK[-2]。

BINARY_OP(op)¶

实现二元运算和就地运算（取决于 op 的值）。

rhs = STACK.pop()
lhs = STACK.pop()
STACK.append(lhs op rhs)

在 3.11 版本中添加。

BINARY_SUBSCR¶

实现

key = STACK.pop()
container = STACK.pop()
STACK.append(container[key])

STORE_SUBSCR¶

实现

key = STACK.pop()
container = STACK.pop()
value = STACK.pop()
container[key] = value

DELETE_SUBSCR¶

实现

key = STACK.pop()
container = STACK.pop()
del container[key]

BINARY_SLICE¶

实现

end = STACK.pop()
start = STACK.pop()
container = STACK.pop()
STACK.append(container[start:end])

在 3.12 版本中添加。

STORE_SLICE¶

实现

end = STACK.pop()
start = STACK.pop()
container = STACK.pop()
values = STACK.pop()
container[start:end] = value

在 3.12 版本中添加。

协程操作码

GET_AWAITABLE(where)¶

实现 STACK[-1] = get_awaitable(STACK[-1])，其中 get_awaitable(o) 返回 o 如果 o 是一个协程对象或带有 CO_ITERABLE_COROUTINE 标志的生成器对象，或者解析 o.__await__。

如果 where 操作数不为零，则表示指令出现的位置

• 1：在调用 __aenter__ 之后

• 2：在调用 __aexit__ 之后

在版本 3.5 中添加。

在版本 3.11 中更改： 以前，此指令没有 oparg。

GET_AITER¶

实现 STACK[-1] = STACK[-1].__aiter__()。

在版本 3.5 中添加。

在版本 3.7 中更改： 不再支持从 __aiter__ 返回可等待对象。

GET_ANEXT¶

在堆栈中实现 STACK.append(get_awaitable(STACK[-1].__anext__()))。有关 get_awaitable 的详细信息，请参阅 GET_AWAITABLE。

在版本 3.5 中添加。

END_ASYNC_FOR¶

终止 async for 循环。处理在等待下一个项目时引发的异常。堆栈在 STACK[-2] 中包含异步可迭代对象，在 STACK[-1] 中包含引发的异常。两者都被弹出。如果异常不是 StopAsyncIteration，则重新引发。

在版本 3.8 中添加。

在版本 3.11 中更改： 堆栈上的异常表示现在包含一个项目，而不是三个项目。

CLEANUP_THROW¶

处理在当前帧中通过 throw() 或 close() 调用期间引发的异常。如果 STACK[-1] 是 StopIteration 的实例，则从堆栈中弹出三个值并压入其 value 成员。否则，重新引发 STACK[-1]。

在 3.12 版本中添加。

BEFORE_ASYNC_WITH¶

从 STACK[-1] 中解析 __aenter__ 和 __aexit__。将 __aexit__ 和 __aenter__() 的结果压入堆栈。

STACK.extend((__aexit__, __aenter__())

在版本 3.5 中添加。

其他操作码

SET_ADD(i)¶

实现

item = STACK.pop()
set.add(STACK[-i], item)

用于实现集合推导。

LIST_APPEND(i)¶

实现

item = STACK.pop()
list.append(STACK[-i], item)

用于实现列表推导。

MAP_ADD(i)¶

实现

value = STACK.pop()
key = STACK.pop()
dict.__setitem__(STACK[-i], key, value)

用于实现字典推导。

在版本 3.1 中添加。

在版本 3.8 中更改： 映射值是 STACK[-1]，映射键是 STACK[-2]。之前，它们是反转的。

对于所有 SET_ADD、LIST_APPEND 和 MAP_ADD 指令，虽然添加的值或键值对被弹出，但容器对象仍然保留在堆栈中，以便它可用于循环的进一步迭代。

RETURN_VALUE¶

使用 STACK[-1] 返回给函数的调用者。

RETURN_CONST(consti)¶

返回 co_consts[consti] 给函数的调用者。

在 3.12 版本中添加。