如何检测 Python AST 以跟踪存储操作?

Question

我的调试器使用 AST 检测来获取代码执行的所有逻辑步骤(包括表达式计算中的步骤(的通知。

有一个步骤我无法确定 - for-loop即将为循环变量分配新值的那一刻。

在 -nodeFor内部，循环变量(或更复杂的变量(用属性target表达式表示。此表达式ctx属性设置为ast.Store()。我不知道如何跟踪此节点的使用情况。

作为特例，我可以用索引替换简单的循环变量locals()：

for locals()["i"] in range(10):
print(i)

这将在ctx=ast.Store()节点内为我提供一个ctx=ast.Load()节点，我知道如何跟踪它。不幸的是，这不会扩展到更复杂的目标。

口译员如何使用这些ctx=ast.Store()表达方式？我可以以某种方式直接检测它们，以便在解释器执行存储操作时收到通知吗？

Answer 1

一种选择是重写for循环，以便赋值以临时变量为目标，并将跟踪代码插入循环主体。例如，像这样的循环：

for foo.x in range(3):
print(foo.x)

可以改写成这样：

for _temp in range(3):
print('loop variable will be set to', _temp)
foo.x = _temp
print(foo.x)

为此，我们实现了一个NodeTransformer：

class ForLoopRewriter(ast.NodeTransformer):
def __init__(self, nodes_to_insert):
super().__init__()
self.nodes_to_insert = nodes_to_insert
def visit_For(self, node):
# redirect the assignment to a usually invalid variable name so it
# doesn't clash with other variables in the code
target = ast.Name('@loop_var', ast.Store())
# insert the new nodes
loop_body = self.nodes_to_insert.copy()
# then reassign the loop variable to the actual target
reassign = ast.Assign([node.target], ast.Name('@loop_var', ast.Load()))
loop_body.append(reassign)
# visit all the ast nodes in the loop body
for n in node.body:
loop_body.append(self.visit(n))
# make a new For node and return it
new_node = ast.For(target, node.iter, loop_body, node.orelse)
ast.fix_missing_locations(new_node)
return new_node

可以这样使用：

code = '''
class Foo:
@property
def x(self):
pass
@x.setter
def x(self, x):
print('Setting x')
foo = Foo()
itr = (print('yielding', x) for x in range(1))
for foo.x in itr:
pass
'''
tree = ast.parse(code)
tracing_code = ast.parse('print("Your tracing code")').body
tree = ForLoopRewriter(tracing_code).visit(tree)
codeobj = compile(tree, 'foo.py', 'exec')
exec(codeobj)
# output:
# yielding 0
# Your tracing code
# Setting x