Python-functools.wraps是做什么的?
在对另一个问题的答案发表评论时,有人说他们不确定自己functools.wraps
在做什么。所以,我问这个问题,以便在StackOverflow
上有它的记录,以备将来参考:到底是functools.wraps
做什么的?
回答:
使用装饰器时,你将一个功能替换为另一个。换句话说,如果你有一个装饰器
def logged(func): def with_logging(*args, **kwargs):
print(func.__name__ + " was called")
return func(*args, **kwargs)
return with_logging
然后当你说
@loggeddef f(x):
"""does some math"""
return x + x * x
这和说的完全一样
def f(x):
"""does some math"""
return x + x * x
f = logged(f)
并且你的函数f将替换为function with_logging
。不幸的是,这意味着如果你然后说
print(f.__name__)
它会打印出来,with_logging
因为那是新功能的名称。实际上,如果你查看的文档字符串f,则将为空,因为with_logging
没有文档字符串,因此你编写的文档字符串将不再存在。另外,如果你查看该函数的pydoc结果,它将不会被列为带有一个参数x;相反,它将被列为“接受” *args
,**kwargs
因为那是with_logging
的需要。
如果使用装饰器总是意味着丢失有关功能的信息,那将是一个严重的问题。这就是为什么functools.wraps
。这需要一个装饰器中使用的函数,并添加了复制该函数名,文档字符串,参数列表等的功能。由于wraps
它本身是一个装饰器,因此以下代码可以正确执行操作:
from functools import wrapsdef logged(func):
@wraps(func)
def with_logging(*args, **kwargs):
print(func.__name__ + " was called")
return func(*args, **kwargs)
return with_logging
@logged
def f(x):
"""does some math"""
return x + x * x
print(f.__name__) # prints 'f'
print(f.__doc__) # prints 'does some math'
以上是 Python-functools.wraps是做什么的? 的全部内容, 来源链接: utcz.com/qa/423604.html