
本文介绍一种利用 sys.setprofile 实现函数级变量赋值自动捕获的可靠方法,解决 exec() 无法获取运行时局部变量的问题,并提供可直接使用的装饰器实现与关键原理说明。
本文介绍一种利用 `sys.setprofile` 实现函数级变量赋值自动捕获的可靠方法,解决 `exec()` 无法获取运行时局部变量的问题,并提供可直接使用的装饰器实现与关键原理说明。
在 Python 中,试图通过 exec(func.__code__, globals(), locals_dict) 直接执行函数字节码来捕获变量赋值,本质上是行不通的——因为 exec() 并不模拟真实的函数调用上下文:它不会创建栈帧(frame)、不处理参数绑定、不执行 LOAD_FAST/STORE_FAST 等局部变量操作指令,更不会触发实际的变量写入行为。因此,assignments 字典始终为空,这是预期行为,而非使用错误。
真正可行的方案是在函数实际执行过程中,于其返回前一刻“快照”其局部命名空间。Python 提供了底层钩子机制:sys.setprofile()。该函数允许注册一个分析回调(profiler),在每次代码事件(如函数调用、返回、行执行)发生时被调用。我们只需监听目标函数的 'return' 事件,并从中提取 frame.f_locals 即可。
以下是经过验证的完整实现:
import sys
import pprint
def track_assignments(func):
def wrapper(*args, **kwargs):
captured_locals = {}
def profiler(frame, event, arg):
# 仅在目标函数返回时捕获 locals
if event == 'return' and frame.f_code.co_name == func.__name__:
nonlocal captured_locals
captured_locals = dict(frame.f_locals) # 浅拷贝,避免引用失效
# 保存并安装 profiler
old_profiler = sys.getprofile()
sys.setprofile(profiler)
try:
result = func(*args, **kwargs)
return result
finally:
# 必须恢复原始 profiler,防止影响其他代码
sys.setprofile(old_profiler)
# 打印捕获到的所有局部变量(含参数、中间变量)
print(f"[{func.__name__} assignments]:")
pprint.pprint(captured_locals, width=60, indent=2)
return wrapper
# 使用示例
@track_assignments
def test():
a = 10
b = 20
c = a * b
print("Inside test:", a)
return c + 1
if __name__ == '__main__':
result = test()
print("Returned:", result)
运行后将输出类似:
[test assignments]:
{ 'a': 10,
'b': 20,
'c': 200,
'result': 201 }
Returned: 201
⚠️ 重要注意事项:
- sys.setprofile 是全局设置,会影响整个解释器,因此必须在 finally 块中严格恢复原始 profiler;
- 该方法会带来显著性能开销(每个字节码事件都触发回调),严禁用于生产环境或高频调用函数;
- f_locals 在函数返回后仍有效,但它是只读快照;修改它不会影响实际变量;
- 若函数内嵌套调用其他函数,需确保 frame.f_code.co_name 判断准确,避免误捕子函数上下文(当前实现已做名称匹配防护)。
作为教学或调试辅助工具,此方案简洁有效;若需长期监控或更高性能,建议转向 AST 静态分析(如重写函数体插入日志语句)或专用调试库(如 py-spy 或 pdb 扩展)。但就“动态捕获运行时赋值”这一目标而言,sys.setprofile 是最贴近需求且无需外部依赖的标准库解法。
Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!











