装饰器如何将变量传递给函数而不更改其签名？

Question

让我先承认，我想要做的事情可能被认为是愚蠢到邪恶，但我想知道我是否可以用Python来做到这一点。

比方说，我有一个函数装饰器，它接受定义变量的关键字参数，并且我想在包装函数中访问这些变量。我可能会做这样的事情：

def more_vars(**extras): 
    def wrapper(f): 
     @wraps(f) 
     def wrapped(*args, **kwargs): 
      return f(extras, *args, **kwargs) 
     return wrapped 
    return wrapper 

现在我可以这样做：

@more_vars(a='hello', b='world') 
def test(deco_vars, x, y): 
    print(deco_vars['a'], deco_vars['b']) 
    print(x, y) 

test(1, 2) 
# Output: 
# hello world 
# 1 2 

我不喜欢这个的事情是，当你使用这个装饰，你必须改变函数的调用签名，除了修饰装饰器外还增加额外的变量。另外，如果你看一下帮助功能，你看，你不希望在调用函数时使用一个额外的变量：

help(test) 
# Output: 
# Help on function test in module __main__: 
# 
# test(deco_vars, x, y) 

这使它看起来像预期用户调用的函数有3个参数，但显然这是行不通的。所以你还必须向docstring添加一条消息，指出第一个参数不是接口的一部分，它只是一个实现细节，应该被忽略。虽然这很糟糕。有没有办法做到这一点，而不必将这些变量挂在全局范围内的某些东西上？理想情况下，我希望它看起来像下面这样：

@more_vars(a='hello', b='world') 
def test(x, y): 
    print(a, b) 
    print(x, y) 

test(1, 2) 
# Output: 
# hello world 
# 1 2 
help(test) 
# Output: 
# Help on function test in module __main__: 
# 
# test(x, y) 

我满足于仅存在Python 3解决方案。

Answer 1

我不喜欢将局部注入到命名空间的想法。虽然这可能是可能的，但处理新注入的本地人与已经存在于该函数中的名称之间的冲突将是令人讨厌的。

将它们作为函数对象的attrs存储是否可以接受？这样他们是命名空间。

from functools import wraps 

def more_vars(**extras): 
    def wrapper(f): 
     @wraps(f) 
     def wrapped(*args, **kwargs): 
      return f(*args, **kwargs) 
     for k,v in extras.items(): 
      setattr(wrapped, k, v) 
     return wrapped 
    return wrapper 

@more_vars(a='hello', b='world') 
def test(x, y): 
    print(test.a, test.b) 
    print(x, y) 

Answer 2

你可以使用一些诡计是插入传递给装饰变量到函数的局部变量做到这一点：

import sys 
from functools import wraps 
from types import FunctionType 


def is_python3(): 
    return sys.version_info >= (3, 0) 


def more_vars(**extras): 
    def wrapper(f): 
     @wraps(f) 
     def wrapped(*args, **kwargs): 
      fn_globals = {} 
      fn_globals.update(globals()) 
      fn_globals.update(extras) 
      if is_python3(): 
       func_code = '__code__' 
      else: 
       func_code = 'func_code' 
      call_fn = FunctionType(getattr(f, func_code), fn_globals) 
      return call_fn(*args, **kwargs) 
     return wrapped 
    return wrapper 


@more_vars(a="hello", b="world") 
def test(x, y): 
    print("locals: {}".format(locals())) 
    print("x: {}".format(x)) 
    print("y: {}".format(y)) 
    print("a: {}".format(a)) 
    print("b: {}".format(b)) 


if __name__ == "__main__": 
    test(1, 2) 

能你这样做吗？当然！ 应该你这样做？可能不会！

（代码可用here）

Answer 3

这听起来像你唯一的问题是，help正显示出原始test作为包装的函数的签名的签名，你不希望它。

发生这种情况的唯一原因是wraps（或者说，update_wrapper，其中wraps调用）明确地将其从wrappee复制到包装。

你可以决定你做什么，不想复制。如果你想做的不同是很简单的，这只是一个过滤的东西出默认WRAPPER_ASSIGNMENTS和WRAPPER_UPDATES的问题。如果您想要更改其他内容，则可能需要分叉update_wrapper并使用您自己的版本 - 但functools是其中一个模块，在文档顶部有一个链接到the source，因为它旨在用作可读样本码。

在你的情况下，它可能只是wraps(f, updated=[])的问题，或者您可能需要做一些花哨，像使用inspect.signature得到的f签名，并将其修改为除去第一个参数，并明确构建一个包装甚至愚弄inspect模块。