应用functools.对嵌套包装器进行包装

Question

我有一个基本装饰器，它接受参数，但也由其他装饰器构建。我似乎想不出该把这些功能工具放在哪里。

import inspect
from functools import wraps
# Base decorator
def _process_arguments(func, *indices):
    """ Apply the pre-processing function to each selected parameter """
    @wraps(func)
    def wrap(f):
        @wraps(f)
        def wrapped_f(*args):
            params = inspect.getargspec(f)[0]
            args_out = list()
            for ind, arg in enumerate(args):
                if ind in indices:
                    args_out.append(func(arg))
                else:
                    args_out.append(arg)
            return f(*args_out)
        return wrapped_f
    return wrap

# Function that will be used to process each parameter
def double(x):
    return x * 2
# Decorator called by end user
def double_selected(*args):
    return _process_arguments(double, *args)
# End-user's function
@double_selected(2, 0)
def say_hello(a1, a2, a3):
    """ doc string for say_hello """
    print('{} {} {}'.format(a1, a2, a3))
say_hello('say', 'hello', 'arguments')

这段代码的结果应该是，并且是:

saysay hello argumentsarguments

但是，在say_hello上运行help给了我:

say_hello(*args, **kwargs)
    doc string for say_hello

除参数名外，其余内容都保留。

似乎我只需要在某个地方添加另一个@wraps()，但是在哪里?

Answer 1

我试验了一下:

>>> from functools import wraps
>>> def x(): print(1)
...
>>> @wraps(x)
... def xyz(a,b,c): return x

>>> xyz.__name__
'x'
>>> help(xyz)
Help on function x in module __main__:
x(a, b, c)

我敢说，这与wraps本身无关，但与help有关。实际上，因为help检查您的对象以提供信息，包括__doc__和其他属性，这就是为什么您会得到这种行为，尽管您的包装函数具有不同的参数列表。虽然wraps不会自动更新(参数列表)它真正更新的是这个元组和__dict__，技术上是对象命名空间:

WRAPPER_ASSIGNMENTS = ('__module__', '__name__', '__qualname__', '__doc__',
                       '__annotations__')
WRAPPER_UPDATES = ('__dict__',)

如果你不确定wraps是如何工作的，如果你从标准库中阅读源代码可能会有所帮助:functools.py .

似乎我只需要在某个地方添加另一个@wraps()，但是在哪里?

不，你不需要在你的代码中添加另一个wraps，正如我上面所说的help通过检查你的对象来工作。函数的参数与代码对象(__code__)相关联，因为函数的参数存储/表示在该对象中，wraps无法将包装器的参数更新为像包装函数一样(继续上面的示例):

>>> xyz.__code__.co_varnames
>>> xyz.__code__.co_varnames = x.__code__.co_varnames
AttributeError: readonly attribute

如果help显示函数xyz有这个参数列表()而不是(a, b, c)，那么这显然是错误的!这同样适用于wraps，将包装器的参数列表更改为包装后的参数列表将非常麻烦!所以这根本不用担心。

>>> @wraps(x, ("__code__",))
... def xyz(a,b,c): pass
...
>>> help(xyz)
Help on function xyz in module __main__:
xyz()

但是xyz()返回x():

>>> xyz()
1

有关其他参考资料，请查看此问题或Python文档

functools。包装做什么?

Answer 2

direprobs是正确的，因为再多的functools包装也无法让我到达那里。Bravosierra99向我指出了一些相关的例子。然而，我找不到一个嵌套装饰符上签名保存的例子，其中外层装饰符接受参数。

Bruce Eckel关于带参数的装饰器的帖子的评论给了我实现我想要的结果的最大提示。

关键在于从_process_arguments函数中删除中间函数，并将其形参放入下一个嵌套函数中。现在对我来说有点道理了……但是它可以工作:

import inspect
from decorator import decorator
# Base decorator
def _process_arguments(func, *indices):
    """ Apply the pre-processing function to each selected parameter """
    @decorator
    def wrapped_f(f, *args):
        params = inspect.getargspec(f)[0]
        args_out = list()
        for ind, arg in enumerate(args):
            if ind in indices:
                args_out.append(func(arg))
            else:
                args_out.append(arg)
        return f(*args_out)
    return wrapped_f

# Function that will be used to process each parameter
def double(x):
    return x * 2
# Decorator called by end user
def double_selected(*args):
    return _process_arguments(double, *args)
# End-user's function
@double_selected(2, 0)
def say_hello(a1, a2,a3):
    """ doc string for say_hello """
    print('{} {} {}'.format(a1, a2, a3))
say_hello('say', 'hello', 'arguments')
print(help(say_hello))

和结果:

saysay hello argumentsarguments
Help on function say_hello in module __main__:
say_hello(a1, a2, a3)
    doc string for say_hello