类方法中使用Python exec定义函数触发NameError的原因及解决方法

代码示例 #

问题中的代码如下：

class A:
    def hello(self):
        exec("def func():\n print('hello world')")
        func()

import pdb; pdb.set_trace()

在PDB调试时，执行以下操作会报错：

(Pdb) aa = A()
(Pdb) aa.hello()
*** NameError: name 'func' is not defined

但在PDB全局环境中直接执行exec却能正常运行：

(Pdb) exec("def func():\n print('hello world')")
(Pdb) func()
hello world

差异原因 #

这是Python中exec的命名空间规则导致的：

• 在函数（类方法属于函数）内部，默认情况下exec会操作当前函数的局部命名空间，但CPython对函数局部变量做了编译期优化——函数内的局部变量列表是在编译时确定的，exec动态添加的func不会被解释器识别为合法的局部变量，因此直接调用时会触发NameError。
• 在PDB的全局环境（模块级别）中，exec默认修改的是全局命名空间，全局变量没有编译期的固定列表限制，动态添加的func可以直接被查找并调用。

解决办法 #

可以通过以下几种方式让类方法内的exec定义函数正常工作：

方法1：显式自定义命名空间（推荐） #

创建一个字典作为exec的命名空间，执行后从字典中取出函数调用：

class A:
    def hello(self):
        ns = {}
        exec("def func():\n print('hello world')", ns)
        ns['func']()  # 从命名空间字典中调用函数

方法2：使用全局命名空间（不推荐，易污染全局） #

如果不介意污染全局命名空间，可以指定exec使用全局命名空间：

class A:
    def hello(self):
        exec("def func():\n print('hello world')", globals())
        func()

方法3：处理局部命名空间（依赖CPython实现） #

将当前局部命名空间转为字典传入exec，再从字典中取函数调用，这种方式依赖CPython的特定实现，跨版本兼容性有限：

class A:
    def hello(self):
        local_ns = locals()
        exec("def func():\n print('hello world')", globals(), local_ns)
        local_ns['func']()

内容的提问来源于stack exchange，提问作者zkytony