保留装饰功能的签名

Question

假设我编写了一个装饰器，它执行了非常通用的操作。例如，它可能会将所有参数转换为特定类型，执行日志记录，实现备忘录等。

这是一个例子：

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

由于重复，这很糟糕。签名仍不会在自动生成的文档中正确显示。更新函数很容易，而不必更改文档字符串，也不会打错字。[
并且是的，我知道docstring已经复制了函数主体。 请忽略此；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构造修饰的函数？

还有其他方法吗？

Answer 1

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 xy + 2z”“”
   return xy + 2z

   print funny_function(“3”, 4.0, z=”5”)

   help(funny_function)

   Help on function funny_function in module main:

   funny_function(x, y, z=3)

   Computes xy + 2z

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。