121

假设我写了一个装饰器,它做了一些非常通用的事情。例如,它可能会将所有参数转换为特定类型、执行日志记录、实现记忆等。

这是一个例子:

def args_as_ints(f):
    def g(*args, **kwargs):
        args = [int(x) for x in args]
        kwargs = dict((k, int(v)) for k, v in kwargs.items())
        return f(*args, **kwargs)
    return g

@args_as_ints
def funny_function(x, y, z=3):
    """Computes x*y + 2*z"""
    return x*y + 2*z

>>> funny_function("3", 4.0, z="5")
22

到目前为止一切都很好。然而,有一个问题。修饰函数不保留原始函数的文档:

>>> help(funny_function)
Help on function g in module __main__:

g(*args, **kwargs)

幸运的是,有一个解决方法:

def args_as_ints(f):
    def g(*args, **kwargs):
        args = [int(x) for x in args]
        kwargs = dict((k, int(v)) for k, v in kwargs.items())
        return f(*args, **kwargs)
    g.__name__ = f.__name__
    g.__doc__ = f.__doc__
    return g

@args_as_ints
def funny_function(x, y, z=3):
    """Computes x*y + 2*z"""
    return x*y + 2*z

这一次,函数名称和文档是正确的:

>>> help(funny_function)
Help on function funny_function in module __main__:

funny_function(*args, **kwargs)
    Computes x*y + 2*z

但是还有一个问题:函数签名是错误的。信息“*args, **kwargs”几乎没用。

该怎么办?我可以想到两个简单但有缺陷的解决方法:

1 -- 在文档字符串中包含正确的签名:

def funny_function(x, y, z=3):
    """funny_function(x, y, z=3) -- computes x*y + 2*z"""
    return x*y + 2*z

由于重复,这很糟糕。签名仍不会在自动生成的文档中正确显示。更新函数并忘记更改文档字符串或打错字很容易。[是的,我知道文档字符串已经复制了函数体。请忽略这个;funny_function 只是一个随机的例子。]

2 -- 不使用装饰器,或为每个特定签名使用专用装饰器:

def funny_functions_decorator(f):
    def g(x, y, z=3):
        return f(int(x), int(y), z=int(z))
    g.__name__ = f.__name__
    g.__doc__ = f.__doc__
    return g

这适用于具有相同签名的一组函数,但通常没用。正如我一开始所说,我希望能够完全通用地使用装饰器。

我正在寻找一种完全通用且自动的解决方案。

所以问题是:有没有办法在创建装饰函数签名后对其进行编辑?

否则,我可以编写一个装饰器来提取函数签名并在构造装饰函数时使用该信息而不是“*kwargs,**kwargs”吗?我如何提取这些信息?我应该如何构造装饰函数——使用 exec?

还有其他方法吗?

4

8 回答 8

90
  1. 安装装饰器模块:

    $ pip install decorator
    
  2. 调整 的定义args_as_ints()

    import decorator
    
    @decorator.decorator
    def args_as_ints(f, *args, **kwargs):
        args = [int(x) for x in args]
        kwargs = dict((k, int(v)) for k, v in kwargs.items())
        return f(*args, **kwargs)
    
    @args_as_ints
    def funny_function(x, y, z=3):
        """Computes x*y + 2*z"""
        return x*y + 2*z
    
    print funny_function("3", 4.0, z="5")
    # 22
    help(funny_function)
    # Help on function funny_function in module __main__:
    # 
    # funny_function(x, y, z=3)
    #     Computes x*y + 2*z
    

Python 3.4+

functools.wraps()自 Python 3.4 以来,stdlib保留了签名:

import functools


def args_as_ints(func):
    @functools.wraps(func)
    def wrapper(*args, **kwargs):
        args = [int(x) for x in args]
        kwargs = dict((k, int(v)) for k, v in kwargs.items())
        return func(*args, **kwargs)
    return wrapper


@args_as_ints
def funny_function(x, y, z=3):
    """Computes x*y + 2*z"""
    return x*y + 2*z


print(funny_function("3", 4.0, z="5"))
# 22
help(funny_function)
# Help on function funny_function in module __main__:
#
# funny_function(x, y, z=3)
#     Computes x*y + 2*z

functools.wraps()至少从 Python 2.5 开始可用,但它不保留那里的签名:

help(funny_function)
# Help on function funny_function in module __main__:
#
# funny_function(*args, **kwargs)
#    Computes x*y + 2*z

注意:*args, **kwargs而不是x, y, z=3.

于 2008-09-29T08:08:30.187 回答
20

这可以通过 Python 的标准库functools和专门的functools.wraps函数来解决,该函数旨在“更新包装函数以使其看起来像被包装的函数”。但是,它的行为取决于 Python 版本,如下所示。应用于问题中的示例,代码如下所示:

from functools import wraps

def args_as_ints(f):
    @wraps(f) 
    def g(*args, **kwargs):
        args = [int(x) for x in args]
        kwargs = dict((k, int(v)) for k, v in kwargs.items())
        return f(*args, **kwargs)
    return g


@args_as_ints
def funny_function(x, y, z=3):
    """Computes x*y + 2*z"""
    return x*y + 2*z

在 Python 3 中执行时,这将产生以下结果:

>>> funny_function("3", 4.0, z="5")
22
>>> help(funny_function)
Help on function funny_function in module __main__:

funny_function(x, y, z=3)
    Computes x*y + 2*z

它唯一的缺点是在 Python 2 中,它不会更新函数的参数列表。在 Python 2 中执行时,它将产生:

>>> help(funny_function)
Help on function funny_function in module __main__:

funny_function(*args, **kwargs)
    Computes x*y + 2*z
于 2015-07-21T13:31:45.450 回答
9

您可以使用带有装饰器的装饰器模块:decorator

@decorator
def args_as_ints(f, *args, **kwargs):
    args = [int(x) for x in args]
    kwargs = dict((k, int(v)) for k, v in kwargs.items())
    return f(*args, **kwargs)

然后保留方法的签名和帮助:

>>> help(funny_function)
Help on function funny_function in module __main__:

funny_function(x, y, z=3)
    Computes x*y + 2*z

编辑:JF Sebastian 指出我没有修改args_as_ints功能 - 现在已修复。

于 2008-09-29T07:49:23.960 回答
8

看一下装饰器模块——特别是装饰器装饰器,它解决了这个问题。

于 2008-09-29T07:43:19.747 回答
6

第二种选择:

  1. 安装包装模块:

$ easy_install 包装

wrapt 有一个奖励,保留类签名。


import wrapt
import inspect

@wrapt.decorator def args_as_ints(wrapped, instance, args, kwargs): if instance is None: if inspect.isclass(wrapped): # Decorator was applied to a class. return wrapped(*args, **kwargs) else: # Decorator was applied to a function or staticmethod. return wrapped(*args, **kwargs) else: if inspect.isclass(instance): # Decorator was applied to a classmethod. return wrapped(*args, **kwargs) else: # Decorator was applied to an instancemethod. return wrapped(*args, **kwargs) @args_as_ints def funny_function(x, y, z=3): """Computes x*y + 2*z""" return x * y + 2 * z >>> funny_function(3, 4, z=5)) # 22 >>> help(funny_function) Help on function funny_function in module __main__: funny_function(x, y, z=3) Computes x*y + 2*z
于 2014-08-28T18:15:30.613 回答
4

正如上面在jfs 的回答中所评论的那样;如果您关心外观(helpinspect.signature)方面的签名,那么使用functools.wraps非常好。

如果您关心行为方面的签名(特别是TypeError在参数不匹配的情况下),请functools.wraps不要保留它。你应该使用decorator它,或者我对其核心引擎的概括,命名为makefun.

from makefun import wraps

def args_as_ints(func):
    @wraps(func)
    def wrapper(*args, **kwargs):
        print("wrapper executes")
        args = [int(x) for x in args]
        kwargs = dict((k, int(v)) for k, v in kwargs.items())
        return func(*args, **kwargs)
    return wrapper


@args_as_ints
def funny_function(x, y, z=3):
    """Computes x*y + 2*z"""
    return x*y + 2*z


print(funny_function("3", 4.0, z="5"))
# wrapper executes
# 22

help(funny_function)
# Help on function funny_function in module __main__:
#
# funny_function(x, y, z=3)
#     Computes x*y + 2*z

funny_function(0)  
# observe: no "wrapper executes" is printed! (with functools it would)
# TypeError: funny_function() takes at least 2 arguments (1 given)

另请参阅这篇关于functools.wraps.

于 2019-03-14T13:29:19.313 回答
0
def args_as_ints(f):
    def g(*args, **kwargs):
        args = [int(x) for x in args]
        kwargs = dict((k, int(v)) for k, v in kwargs.items())
        return f(*args, **kwargs)
    g.__name__ = f.__name__
    g.__doc__ = f.__doc__
    return g

这修复了名称和文档。为了保留函数签名,wrap在与g.__name__ = f.__name__, g.__doc__ = f.__doc__.

本身就是wraps一个装饰器。我们将闭包内部函数传递给该装饰器,它将修复元数据。但是,如果我们只将内部函数传递给wraps,它不会知道从哪里复制元数据。它需要知道需要保护哪个函数的元数据。它需要知道原始功能。

def args_as_ints(f):
    def g(*args, **kwargs):
        args = [int(x) for x in args]
        kwargs = dict((k, int(v)) for k, v in kwargs.items())
        return f(*args, **kwargs)
    g=wraps(f)(g)
    return g

wraps(f)将返回一个函数,该函数将g作为其参数。这将返回闭包并将分配给g然后我们返回它。

于 2021-10-04T10:13:33.620 回答
0
from inspect import signature


def args_as_ints(f):
    def g(*args, **kwargs):
        args = [int(x) for x in args]
        kwargs = dict((k, int(v)) for k, v in kwargs.items())
        return f(*args, **kwargs)
    sig = signature(f)
    g.__signature__ = sig
    g.__doc__ = f.__doc__
    g.__annotations__ = f.__annotations__
    g.__name__ = f.__name__
    return g

@args_as_ints
def funny_function(x, y, z=3):
    """Computes x*y + 2*z"""
    return x*y + 2*z

>>> funny_function("3", 4.0, z="5")
22

我想添加那个答案(因为这首先出现在谷歌中)。检查模块能够获取函数的签名,以便可以将其保存在装饰器中。但这还不是全部。如果要修改签名,可以这样做:

from inspect import signature, Parameter, _ParameterKind


def foo(a: int, b: int) -> int:
    return a + b

sig = signature(foo)
sig._parameters = dict(sig.parameters)
sig.parameters['c'] = Parameter(
    'c', _ParameterKind.POSITIONAL_OR_KEYWORD, 
    annotation=int
)
foo.__signature__ = sig

>>> help(foo)
Help on function foo in module __main__:

foo(a: int, b: int, c: int) -> int

为什么要改变函数的签名?

有足够的关于你的函数和方法的文档是非常有用的。如果您使用该*args, **kwargs语法,然后从 kwargs 弹出参数用于装饰器中的其他用途,则该关键字参数将不会被正确记录,因此会修改函数的签名。

于 2021-12-13T07:12:51.217 回答