简而言之,问题是:有没有办法防止Python查找当前范围之外的变量
详细信息:
如果变量定义未在当前作用域中定义,Python将在外部作用域中查找变量定义。因此,像这样的代码在重构过程中如果不小心就会崩溃:
def line(x, a, b):
return a + x * b
a, b = 1, 1
y1 = line(1, a, b)
y2 = line(1, 2, 3)
如果我重命名了函数参数,但忘记在函数体内重命名它们,代码仍然会运行:
def line(x, a0, b0):
return a + x * b # not an error
a, b = 1, 1
y1 = line(1, a, b) # correct result by coincidence
y2 = line(1, 2, 3) # wrong result
我知道从外部作用域隐藏名称是不好的做法。但有时我们还是会这么做。。。
有没有办法防止Python查找当前范围之外的变量?(因此,在第二个示例中,访问a
或b
会引发错误。)
是的,通常可能不是。但是,您可以使用函数来完成此操作。
您要做的是使函数的全局为空。你不能替换全局变量,也不想修改它的内容(因为这只是为了去掉全局变量和函数)。
但是:您可以在运行时创建函数对象。构造函数看起来像types.FunctionType((code, globals[, name[, argdefs[, closure]]])
。在那里你可以替换全局名称空间:
def line(x, a0, b0):
return a + x * b # will be an error
a, b = 1, 1
y1 = line(1, a, b) # correct result by coincidence
line = types.FunctionType(line.__code__, {})
y1 = line(1, a, b) # fails since global name is not defined
当然,您可以通过定义自己的装饰器来清理这个问题:
import types
noglobal = lambda f: types.FunctionType(f.__code__, {}, argdefs=f.__defaults__)
@noglobal
def f():
return x
x = 5
f() # will fail
严格地说,您并没有禁止它访问全局变量,您只是让函数相信全局命名空间中没有变量。实际上,您也可以使用它来模拟静态变量,因为如果它声明一个变量为全局变量并将其分配给它,它将最终进入自己的全局命名空间沙盒中。
如果你想访问全局名称空间的一部分,那么你需要用你希望它看到的内容填充函数全局沙盒。
不,您不能告诉Python不要在全局范围内查找名称。
如果可以,您将无法使用模块中定义的任何其他类或函数,无法从其他模块导入对象,也无法使用内置名称。你的函数名称空间变成了一片沙漠,几乎没有它所需要的一切,唯一的出路是将所有东西导入本地名称空间对于模块中的每一个函数。
与其试图破坏全局查找,不如保持全局命名空间的干净。不要添加不需要与模块中的其他作用域共享的全局变量。例如,使用main()
函数来封装实际上只是局部的内容。
此外,添加单元测试。没有(甚至只有几个)测试的重构总是容易产生错误。
根据@skyking的回答,我无法访问任何导入(我甚至无法使用print
)。此外,具有可选参数的函数也会被破坏(比较可选参数如何成为必需参数?)。
@Ax3l的评论稍微改善了这一点。我仍然无法访问导入的变量(from module import var
)。
因此,我建议:
def noglobal(f):
return types.FunctionType(f.__code__, globals().copy(), f.__name__, f.__defaults__, f.__closure__)
对于每个用@noglobal
修饰的函数,这将创建迄今为止定义的globals()
的副本。这使导入的变量(通常在文档顶部导入)保持可访问性。如果你像我一样,先定义函数,然后定义变量,这将达到预期的效果,即能够访问函数中导入的变量,但不能访问代码中定义的变量。由于CCD_ 9创建浅拷贝(Understanding dict.copy()-浅拷贝还是深拷贝?),这也应该非常节省内存。
注意,通过这种方式,函数只能调用上面定义的函数,因此您可能需要重新排序代码。
为了记录在案,我从他的Gist:中复制了@Ax3l的版本
def imports():
for name, val in globals().items():
# module imports
if isinstance(val, types.ModuleType):
yield name, val
# functions / callables
if hasattr(val, '__call__'):
yield name, val
noglobal = lambda fn: types.FunctionType(fn.__code__, dict(imports()))
要阻止全局变量查找,请将函数移到另一个模块中。除非它检查调用堆栈或显式导入调用模块;它将无法从调用它的模块访问全局。
在实践中,将代码移动到main()
函数中,以避免创建不必要的全局变量。
如果因为几个函数需要操作共享状态而使用全局变量,那么将代码移动到一个类中。
正如@bers所提到的,@skykings的decorator破坏了函数中的大多数python功能,如print()
和import
语句@bers在decorator定义时添加了当前从globals()
导入的模块,从而绕过了import
语句。
这激发了我写另一个装饰师的灵感,希望它能满足大多数来看这篇文章的人的实际需求。潜在的问题是,以前的decorator创建的新函数缺少__builtins__
变量,该变量包含新打开的解释器中可用的所有标准内置python函数(例如print
)。
import types
import builtins
def no_globals(f):
'''
A function decorator that prevents functions from looking up variables in outer scope.
'''
# need builtins in globals otherwise can't import or print inside the function
new_globals = {'__builtins__': builtins}
new_f = types.FunctionType(f.__code__, globals=new_globals, argdefs=f.__defaults__)
new_f.__annotations__ = f.__annotations__ # for some reason annotations aren't copied over
return new_f
然后使用如下
@no_globals
def f1():
return x
x = 5
f1() # should raise NameError
@no_globals
def f2(x):
import numpy as np
print(x)
return np.sin(x)
x = 5
f2(x) # should print 5 and return -0.9589242746631385
理论上,您可以在函数调用时使用自己的装饰器来删除globals()
。隐藏所有的globals()
是一种开销,但是,如果没有太多的globals()
,它可能会很有用。在操作过程中,我们不创建/删除全局对象,只是覆盖字典中引用全局对象的引用。但不要移除特殊的globals()
(如__builtins__
)和模块。可能您也不想将callable
从全局范围中删除。
from types import ModuleType
import re
# the decorator to hide global variables
def noglobs(f):
def inner(*args, **kwargs):
RE_NOREPLACE = '__w+__'
old_globals = {}
# removing keys from globals() storing global values in old_globals
for key, val in globals().iteritems():
if re.match(RE_NOREPLACE, key) is None and not isinstance(val, ModuleType) and not callable(val):
old_globals.update({key: val})
for key in old_globals.keys():
del globals()[key]
result = f(*args, **kwargs)
# restoring globals
for key in old_globals.iterkeys():
globals()[key] = old_globals[key]
return result
return inner
# the example of usage
global_var = 'hello'
@noglobs
def no_globals_func():
try:
print 'Can I use %s here?' % global_var
except NameError:
print 'Name "global_var" in unavailable here'
def globals_func():
print 'Can I use %s here?' % global_var
globals_func()
no_globals_func()
print 'Can I use %s here?' % global_var
Can I use hello here?
Name "global_var" in unavailable here
Can I use hello here?
或者,您可以对模块中的所有全局可调用函数(即函数)进行迭代,并动态地对它们进行修饰(只需要多一点代码)。
代码是针对Python 2
的,我认为可以为Python 3
创建一个非常相似的代码。