Python eval hook时局部和全局变量报错NameError问题

一、eval语法

先介绍一下eval的语法：eval(expression, globals=None, locals=None)

它有三个参数，其中 expression 是一个字符串类型的表达式或代码对象，用于做运算；globals 与 locals 是可选参数，默认值是 None。

globals 用于指定运行时的全局命名空间，类型是字典，缺省时使用的是当前模块的内置命名空间。locals 指定运行时的局部命名空间，类型是字典，缺省时使用 globals 的值。两者都缺省时，则遵循 eval 函数执行时的作用域。值得注意的是，这两者不代表真正的命名空间，只在运算时起作用，运算后则销毁。

二、问题场景

由于业务需要，对eval进行了hook，hook方法大概如下：

import builtins
import os

def eval_hook(func):
    print("eval: ", func)
    def wrapper(*args, **kwargs):
        # 逻辑处理
        return func(*args, **kwargs)
    return wrapper

builtins.eval = eval_hook(builtins.eval)

在脚本中进行调用时会发现；

import test_hook
import os


data = "os.system('ls')"

print(data)
a = "(lambda x:data)(None)"

eval(data)  #正常调用

eval(a) #报错 NameError: name 'data' is not defined
eval(a, None)  #报错 NameError: name 'data' is not defined
eval(a, None, None)   #报错 NameError: name 'data' is not defined

为什么普通的变量data直接使用是正常的，但是在lambda表达式里就报错NameError了呢？

可以从locals()里查看一下当前模块的局部命名空间变量来确定：

在测试前打印locals()可以得到：

{'__name__': '__main__', 
 '__doc__': None, '__package__': None, 
 '__loader__': <_frozen_importlib_external.SourceFileLoader object at 0x100750ca0>,
'__spec__': None, '__annotations__': {}, 
'__builtins__': <module 'builtins' (built-in)>, 
'__file__': '/Users/test_str.py', '__cached__': None,
'test_hook': <module 'test_hook' from '/Users/test_hook.py'>,
'os': <module 'os' from '/Library/Developer/CommandLineTools/Library/Frameworks/Python3.framework/Versions/3.9/lib/python3.9/os.py'>,
'data': "os.system('ls')", 
'a': '(lambda x:data)(None)'}

可以看到是有data变量的，但是如果我们在hook 的处理函数eval_hook里打印一下，会发现locals()中确实不含data变量：

{
    'args': ('(lambda x:data)(None)',), 
 	'kwargs': {}, 
 	'func': <built-in function eval>
}

原因其实是变量的作用域问题，在hook的代码里应该在调用原函数前把locals()和globals()还原回hook前的值，这样才能确保局部和全局的变量都能被正确调用。

所以在hook的代码里应该添加下面的处理逻辑：

import builtins
import os
import inspect

def eval_hook(func):
    
    def wrapper(*args, **kwargs):

        frame = inspect.currentframe().f_back
        locals().update(frame.f_locals)
        globals().update(frame.f_globals)

        # 逻辑处理
        return func(*args, **kwargs)

    return wrapper

builtins.eval = eval_hook(builtins.eval)

其中inspect.currentframe().f_back就是eval_hook的上一个栈帧，也就是调用eval的栈。