Better mapping of `sys.monitoring` branches back to source code
还没有人认领这个 Issue。
- 主要语言
- Python
- 星标
- 77.2k
- 派生
- 35.9k
- PR 合并指标
- PR 指标待抓取
描述
Feature or enhancement
Proposal:
sys.monitoring allows us to record branches taken during execution, reporting them in terms of their source and destination offsets in bytecode. These offsets are meaningless to developers, however, unless they take the time to generate and study the bytecode disassembly. Code objects provide co_positions() to map bytecode locations to the source code that originated it, but the branches don't always map to locations that make sense to someone only looking at the source code.
For example, when executed,
def foo(x):
if x: print(x)
foo(0)
shows a branch from offset 4, which maps to the if keyword, to offset 30, which also maps to that if.
1 0 RESUME 0
2 2 LOAD_FAST 0 (x)
4 POP_JUMP_IF_FALSE 12 (to 30)
6 LOAD_GLOBAL 1 (NULL + print)
16 LOAD_CONST 1 ('x')
18 CALL 1
26 POP_TOP
28 RETURN_CONST 0 (None)
>> 30 RETURN_CONST 0 (None)
ex1.py 2:7-2:8 (foo@4) -> 2:7-2:8 (foo@30)
How can/should a coverage tool attempting to report this branch recognize that it is a branch out of the function?
The branch does go to a RETURN_... opcode, but is that reliable?
Branches from for loops also show a bit obfuscated. In the example
def foo():
for i in range(3):
print(i)
foo()
the branch taken into the block containing the print call actually shows as a branch to the i in line 2:
1 0 RESUME 0
2 2 LOAD_GLOBAL 1 (NULL + range)
12 LOAD_CONST 1 (3)
14 CALL 1
22 GET_ITER
>> 24 FOR_ITER 13 (to 54)
28 STORE_FAST 0 (i)
3 30 LOAD_GLOBAL 3 (NULL + print)
40 LOAD_FAST 0 (i)
42 CALL 1
50 POP_TOP
52 JUMP_BACKWARD 15 (to 24)
2 >> 54 END_FOR
56 RETURN_CONST 0 (None)
ex2.py 2:4-3:16 (foo@24) -> 2:8-2:9 (foo@28)
The final branch once the loop is done also shows a bit funny, not to offset 54, as expected, but to offset 56:
ex2.py 2:4-3:16 (foo@24) -> 2:4-3:16 (foo@56)
I've seen unexpected behavior with while loops as well... I can probably recreate it if desired.
@markshannon, @nedbat and I spoke about this issue previously; Mark asked me to open this issue. It should arguably be a bug report rather than a feature request... it can be your call, Mark.
Has this already been discussed elsewhere?
No response given
Links to previous discussion of this feature:
I spoke briefly about these issues in my PyCon'24 talk: https://www.youtube.com/watch?v=X9aXWeLC_C0
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
从 sys.monitoring 的分支报告和代码对象的 co_positions() 开始,然后比较所提供的 if 和 for 反汇编结果。确定函数退出和循环目标的源代码级映射,包括 while 循环的行为,并定义能够显示预期分支位置的回归覆盖范围。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- python
- 领域
- devtools
- Issue 类型
- 功能
- 难度
- 5/5
- 预计耗时
- 一周以上
- 活跃度
- 停滞
- 描述清晰度
- 需要澄清
- 新手友好度
- 25/100