0

0

python中wraps函数如何使用?

冷炫風刃

冷炫風刃

发布时间:2025-11-27 18:48:46

|

857人浏览过

|

来源于php中文网

原创

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

python中wraps函数如何使用?

functools.wraps 是 Python 中用于装饰器开发的一个实用工具,它的主要作用是保留被装饰函数的元信息(如函数名、文档字符串、参数列表等)。如果不使用 wraps,装饰器会“掩盖”原函数的这些信息,给调试和文档生成带来困扰。

为什么需要 wraps?

考虑一个简单的装饰器:

def my_decorator(func):
    def wrapper(*args, **kwargs):
        print("调用前")
        result = func(*args, **kwargs)
        print("调用后")
        return result
    return wrapper
<p>@my_decorator
def say_hello():
"""打招呼函数"""
print("Hello!")</p><p>print(say_hello.<strong>name</strong>)  # 输出:wrapper
print(say_hello.<strong>doc</strong>)   # 输出:None</p>

可以看到,函数名变成了 wrapper,文档字符串丢失了。这在实际开发中不利于调试和框架识别。

使用 wraps 保留原函数信息

通过 functools.wraps 可以解决这个问题:

from functools import wraps
<p>def my_decorator(func):
@wraps(func)
def wrapper(*args, *<em>kwargs):
print("调用前")
result = func(</em>args, **kwargs)
print("调用后")
return result
return wrapper</p><p>@my_decorator
def say_hello():
"""打招呼函数"""
print("Hello!")</p><p>print(say_hello.<strong>name</strong>)  # 输出:say_hello
print(say_hello.<strong>doc</strong>)   # 输出:打招呼函数</p>

加上 @wraps(func) 后,wrapper 函数会复制 func 的名称、文档字符串、模块名等元数据,使装饰后的函数看起来更“像”原函数。

实际应用场景

wraps 在编写通用装饰器时非常有用,比如:
  • 日志记录装饰器
  • 性能计时装饰器
  • 权限校验装饰器
  • 缓存装饰器
例如一个计时装饰器:

from functools import wraps
import time
<p>def timer(func):
@wraps(func)
def wrapper(*args, *<em>kwargs):
start = time.time()
result = func(</em>args, **kwargs)
end = time.time()
print(f"{func.<strong>name</strong>} 执行耗时: {end - start:.2f}s")
return result
return wrapper</p><p>@timer
def slow_function():
time.sleep(1)</p><p>slow_function()  # 输出函数名和耗时</p><div class="aritcle_card flexRow">
                                                        <div class="artcardd flexRow">
                                                                <a class="aritcle_card_img" href="/ai/2457" title="PathFinder"><img
                                                                                src="https://img.php.cn/upload/ai_manual/001/246/273/176646000963539.png" alt="PathFinder"  onerror="this.onerror='';this.src='/static/lhimages/moren/morentu.png'" ></a>
                                                                <div class="aritcle_card_info flexColumn">
                                                                        <a href="/ai/2457" title="PathFinder">PathFinder</a>
                                                                        <p>AI驱动的销售漏斗分析工具</p>
                                                                </div>
                                                                <a href="/ai/2457" title="PathFinder" class="aritcle_card_btn flexRow flexcenter"><b></b><span>下载</span> </a>
                                                        </div>
                                                </div>

基本上就这些。只要写装饰器,建议都用 @wraps,避免丢失函数元信息,提升代码可维护性。不复杂但容易忽略。

相关文章

python速学教程(入门到精通)
python速学教程(入门到精通)

python怎么学习?python怎么入门?python在哪学?python怎么学才快?不用担心,这里为大家提供了python速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

760

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

221

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1567

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

649

2023.11.24

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

1228

2024.03.22

php中定义字符串的方式
php中定义字符串的方式

php中定义字符串的方式:单引号;双引号;heredoc语法等等。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

1204

2024.04.29

go语言字符串相关教程
go语言字符串相关教程

本专题整合了go语言字符串相关教程,阅读专题下面的文章了解更多详细内容。

193

2025.07.29

c++字符串相关教程
c++字符串相关教程

本专题整合了c++字符串相关教程,阅读专题下面的文章了解更多详细内容。

131

2025.08.07

Python异步编程与Asyncio高并发应用实践
Python异步编程与Asyncio高并发应用实践

本专题围绕 Python 异步编程模型展开,深入讲解 Asyncio 框架的核心原理与应用实践。内容包括事件循环机制、协程任务调度、异步 IO 处理以及并发任务管理策略。通过构建高并发网络请求与异步数据处理案例,帮助开发者掌握 Python 在高并发场景中的高效开发方法,并提升系统资源利用率与整体运行性能。

37

2026.03.12

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 22.5万人学习

Django 教程
Django 教程

共28课时 | 5万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号