0

0

Python 装饰器如何保留被装饰函数的 name 和 docstring

冷漠man

冷漠man

发布时间:2026-01-25 19:23:30

|

526人浏览过

|

来源于php中文网

原创

被装饰函数的__name__和__doc__丢失是因为装饰器用新函数替换了原函数,而wrapper默认携带自身元数据;functools.wraps可自动同步__name__、__doc__等属性,避免手动赋值遗漏,类装饰器及嵌套装饰器中同样必须使用。

python 装饰器如何保留被装饰函数的 name 和 docstring

为什么被装饰函数的 __name____doc__ 会丢失

Python 装饰器本质是用新函数替换了原函数对象。如果装饰器内部直接返回一个普通闭包(比如 def wrapper(*args, **kwargs): ...),那么这个 wrapper__name__ 就是 "wrapper"__doc__ 也来自它自身,和原函数无关。常见现象包括:help(my_decorated_func) 显示的是装饰器里的文档,而不是原函数的;my_decorated_func.__name__ 返回 "wrapper" 而非预期名称。

functools.wraps 一键同步元数据

functools.wraps 是标准解法,它本身是个装饰器,作用是把被装饰函数的 __module____name____qualname____doc____annotations__ 等属性复制到包装函数上。

使用方式很简单:

from functools import wraps
<p>def my_decorator(func):
@wraps(func)  # ← 关键:加在这儿
def wrapper(*args, *<em>kwargs):
print("Before")
result = func(</em>args, **kwargs)
print("After")
return result
return wrapper</p><p>@my_decorator
def say_hello():
"""Say hello to the world."""
return "Hello!"

此时 say_hello.__name__"say_hello"say_hello.__doc__ 也是 "Say hello to the world."

立即学习Python免费学习笔记(深入)”;

不使用 @wraps 时手动同步的隐患

有人尝试手动赋值,比如在 wrapper 内部写 wrapper.__name__ = func.__name__,但这只解决表面问题:

Tome
Tome

先进的AI智能PPT制作工具

下载
  • __doc____module____annotations____dict__ 等都得逐个处理,容易遗漏
  • __wrapped__ 属性不会自动建立,导致无法通过 inspect.unwrap() 反向获取原始函数
  • 某些框架(如 Flask、Click)依赖完整的元数据,手动同步可能引发兼容性问题
  • Python 3.12+ 对 __qualname__ 和嵌套函数名更敏感,漏掉会导致调试困难

装饰器类里也要用 wraps

要。即使你写的是类装饰器,只要返回的是可调用对象(比如实现了 __call__),且希望保留原函数元数据,就必须在 __call__ 内部或返回的包装函数上应用 @wraps

例如:

from functools import wraps
<p>class CountCalls:
def <strong>init</strong>(self, func):
self.func = func
self.count = 0</p><h1>注意:这里不能直接 wraps(self),因为 self 不是函数</h1><pre class="brush:php;toolbar:false;">def __call__(self, *args, **kwargs):
    self.count += 1
    @wraps(self.func)  # ← 必须在这里 wrap 包装逻辑
    def wrapped(*a, **kw):
        return self.func(*a, **kw)
    return wrapped(*args, **kwargs)

不过更常见的写法是把 @wraps 放在 __call__ 返回的闭包上,或者直接在 __init__ 中用 wraps 处理 self 的属性 —— 但最稳妥、最符合直觉的方式仍是:**只要你在返回一个新函数,且它替代了原函数,就对那个新函数用 @wraps(func)**。

真正容易被忽略的,是装饰器嵌套场景:比如 @retry @cache @log,每一层都必须正确使用 wraps,否则最外层拿到的就不是原始函数的 __doc__,而是中间某层包装函数的。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

WorkBuddy
WorkBuddy

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
Python Flask框架
Python Flask框架

本专题专注于 Python 轻量级 Web 框架 Flask 的学习与实战,内容涵盖路由与视图、模板渲染、表单处理、数据库集成、用户认证以及RESTful API 开发。通过博客系统、任务管理工具与微服务接口等项目实战,帮助学员掌握 Flask 在快速构建小型到中型 Web 应用中的核心技能。

104

2025.08.25

Python Flask Web框架与API开发
Python Flask Web框架与API开发

本专题系统介绍 Python Flask Web框架的基础与进阶应用,包括Flask路由、请求与响应、模板渲染、表单处理、安全性加固、数据库集成(SQLAlchemy)、以及使用Flask构建 RESTful API 服务。通过多个实战项目,帮助学习者掌握使用 Flask 开发高效、可扩展的 Web 应用与 API。

81

2025.12.15

go语言闭包相关教程大全
go语言闭包相关教程大全

本专题整合了go语言闭包相关数据,阅读专题下面的文章了解更多相关内容。

152

2025.07.29

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

71

2026.03.11

Go高并发任务调度与Goroutine池化实践
Go高并发任务调度与Goroutine池化实践

本专题围绕 Go 语言在高并发任务处理场景中的实践展开,系统讲解 Goroutine 调度模型、Channel 通信机制以及并发控制策略。内容包括任务队列设计、Goroutine 池化管理、资源限制控制以及并发任务的性能优化方法。通过实际案例演示,帮助开发者构建稳定高效的 Go 并发任务处理系统,提高系统在高负载环境下的处理能力与稳定性。

38

2026.03.10

Kotlin Android模块化架构与组件化开发实践
Kotlin Android模块化架构与组件化开发实践

本专题围绕 Kotlin 在 Android 应用开发中的架构实践展开,重点讲解模块化设计与组件化开发的实现思路。内容包括项目模块拆分策略、公共组件封装、依赖管理优化、路由通信机制以及大型项目的工程化管理方法。通过真实项目案例分析,帮助开发者构建结构清晰、易扩展且维护成本低的 Android 应用架构体系,提升团队协作效率与项目迭代速度。

82

2026.03.09

JavaScript浏览器渲染机制与前端性能优化实践
JavaScript浏览器渲染机制与前端性能优化实践

本专题围绕 JavaScript 在浏览器中的执行与渲染机制展开,系统讲解 DOM 构建、CSSOM 解析、重排与重绘原理,以及关键渲染路径优化方法。内容涵盖事件循环机制、异步任务调度、资源加载优化、代码拆分与懒加载等性能优化策略。通过真实前端项目案例,帮助开发者理解浏览器底层工作原理,并掌握提升网页加载速度与交互体验的实用技巧。

97

2026.03.06

Rust内存安全机制与所有权模型深度实践
Rust内存安全机制与所有权模型深度实践

本专题围绕 Rust 语言核心特性展开,深入讲解所有权机制、借用规则、生命周期管理以及智能指针等关键概念。通过系统级开发案例,分析内存安全保障原理与零成本抽象优势,并结合并发场景讲解 Send 与 Sync 特性实现机制。帮助开发者真正理解 Rust 的设计哲学,掌握在高性能与安全性并重场景中的工程实践能力。

223

2026.03.05

PHP高性能API设计与Laravel服务架构实践
PHP高性能API设计与Laravel服务架构实践

本专题围绕 PHP 在现代 Web 后端开发中的高性能实践展开,重点讲解基于 Laravel 框架构建可扩展 API 服务的核心方法。内容涵盖路由与中间件机制、服务容器与依赖注入、接口版本管理、缓存策略设计以及队列异步处理方案。同时结合高并发场景,深入分析性能瓶颈定位与优化思路,帮助开发者构建稳定、高效、易维护的 PHP 后端服务体系。

458

2026.03.04

热门下载

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

精品课程

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

共4课时 | 22.5万人学习

Django 教程
Django 教程

共28课时 | 4.9万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.9万人学习

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

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