使用functools.wraps可保留被装饰函数的元信息,避免函数名、文档字符串等丢失。1. 不使用wraps时,装饰器会掩盖原函数的__name__和__doc__;2. 使用@wraps(func)后,wrapper继承原函数的元数据,确保调试和文档正确;3. 适用于日志、计时、权限等通用装饰器,提升代码可维护性。

functools.wraps 是 Python 中用于装饰器开发的一个实用工具,它的主要作用是保留被装饰函数的元信息(如函数名、文档字符串、参数列表等)。如果不使用 wraps,装饰器会“掩盖”原函数的这些信息,给调试和文档生成带来困扰。
为什么需要 wraps?
考虑一个简单的装饰器:
def my_decorator(func): def wrapper(*args, **kwargs): print("调用前") result = func(*args, **kwargs) print("调用后") return result return wrapper@my_decoratordef say_hello():"""打招呼函数"""print("Hello!")
print(say_hello.name) # 输出:wrapperprint(say_hello.doc) # 输出:None
可以看到,函数名变成了 wrapper,文档字符串丢失了。这在实际开发中不利于调试和框架识别。
使用 wraps 保留原函数信息
通过 functools.wraps 可以解决这个问题:
from functools import wrapsdef my_decorator(func):@wraps(func)def wrapper(*args, *kwargs):print("调用前")result = func(args, **kwargs)print("调用后")return resultreturn wrapper
@my_decoratordef say_hello():"""打招呼函数"""print("Hello!")
print(say_hello.name) # 输出:say_helloprint(say_hello.doc) # 输出:打招呼函数
加上 @wraps(func) 后,wrapper 函数会复制 func 的名称、文档字符串、模块名等元数据,使装饰后的函数看起来更“像”原函数。
实际应用场景
wraps 在编写通用装饰器时非常有用,比如:日志记录装饰器性能计时装饰器权限校验装饰器缓存装饰器例如一个计时装饰器:
from functools import wrapsimport timedef timer(func):@wraps(func)def wrapper(*args, *kwargs):start = time.time()result = func(args, **kwargs)end = time.time()print(f"{func.name} 执行耗时: {end - start:.2f}s")return resultreturn wrapper
@timerdef slow_function():time.sleep(1)
slow_function() # 输出函数名和耗时
动态WEB网站中的PHP和MySQL:直观的QuickPro指南第2版查看详情动态WEB网站中的PHP和MySQL详细反映实际程序的需求,仔细地探讨外部数据的验证(例如信用卡卡号的格式)、用户登录以及如何使用模板建立网页的标准外观。动态WEB网站中的PHP和MySQL的内容不仅仅是这些。书中还提到如何串联JavaScript与PHP让用户操作时更快、更方便。还有正确处理用户输入错误的方法,让网站看起来更专业。另外还引入大量来自PEAR外挂函数库的强大功能,对常用的、强大的包
508
![]()
基本上就这些。只要写装饰器,建议都用 @wraps,避免丢失函数元信息,提升代码可维护性。不复杂但容易忽略。
以上就是python中wraps函数如何使用?的详细内容,更多请关注创想鸟其它相关文章!
版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/905305.html
微信扫一扫
支付宝扫一扫