如何在Python中编写带参数的自定义装饰器

酷宇大大_7786

酷宇大大_7786

2026-10-26

623人浏览

原创

带参数的装饰器必须是三层函数,因为@decorator(arg)会先调用decorator(arg)返回一个接收函数的装饰器;外层传参数,中层接函数,内层处理调用,需用functools.wraps保留原函数属性,复杂状态逻辑才考虑类实现。

如何在python中编写带参数的自定义装饰器

带参数的装饰器为什么必须是三层函数

因为 Python 解释器在遇到 @decorator(arg) 语法时,会先调用 decorator(arg),期望它返回一个「真正的装饰器」(即接收函数并返回新函数的可调用对象)。如果只写两层,decorator(arg) 返回的就不是可调用对象,或者无法正确接收被装饰函数,运行时会报 TypeError: 'function' object is not callable 或直接抛出 TypeError 说缺少参数。

常见错误现象:TypeError: wrapper() takes 0 positional arguments but 1 was given —— 这通常是因为最内层函数没接收 *args, **kwargs,或中间层漏掉了返回函数。

  • 外层函数(如 log_calls)负责接收装饰器参数,必须返回中层函数
  • 中层函数(如 decorator)接收被装饰的函数 func,必须返回内层函数
  • 内层函数(如 wrapper)接收实际调用时的参数,执行逻辑并调用原函数

如何正确传递和使用装饰器参数

装饰器参数(比如日志级别、重试次数、超时时间)应在最外层捕获,然后通过闭包传入内层。不能在 wrapper 里重新读取外部变量(除非是不可变且确定不变的),否则容易因作用域或延迟求值出错。

示例:实现一个带 level 参数的日志装饰器:

def log_calls(level="INFO"):
    def decorator(func):
        def wrapper(*args, **kwargs):
            print(f"[{level}] Calling {func.__name__}")
            return func(*args, **kwargs)
        return wrapper
    return decorator
<p>@log_calls(level="DEBUG")
def add(a, b):
return a + b
</p>

注意:level 在 log_calls() 调用时就被固定下来,每个被该装饰器实例修饰的函数都拥有独立的 level 值 —— 这正是闭包的作用。

带参数装饰器与 functools.wraps 的配合要点

如果不加 @functools.wraps(func),被装饰函数的 __name__、__doc__、__module__ 都会变成 wrapper 的,导致调试困难、IDE 提示异常、文档生成失败(如 Sphinx 抓不到 docstring)。

macOS UI 自动化技能包 —— 用 Python 控制你的 Mac
macOS UI 自动化技能包 —— 用 Python 控制你的 Mac

让 macOS 自动化像说话一样简单 —— 用代码控制你的 Mac,无需学习 AppleScript 系统要求 macOS 14+ (Sonoma) Python 3.9+ 需要开启:辅助功能 + 屏幕录制权限

下载

必须把 @functools.wraps(func) 放在最内层函数定义之后、返回之前:

from functools import wraps
<p>def retry(times=3):
def decorator(func):
@wraps(func)  # ← 关键:放在这里,不是在外层或中层
def wrapper(*args, *<em>kwargs):
for i in range(times):
try:
return func(</em>args, **kwargs)
except Exception:
if i == times - 1:
raise
return None
return wrapper
return decorator
</p>

漏掉 @wraps 是生产环境高频踩坑点,尤其当函数需要被反射、序列化或集成进框架(如 FastAPI、pytest)时,行为可能完全不可预期。

什么时候该用类实现带参数装饰器

当装饰器逻辑较重、需要维护状态(如累计调用次数、缓存上次结果)、或参数本身是可变对象(如列表、字典)时,函数式三层嵌套容易混乱,此时用类更清晰。

类装饰器需实现 __init__(接收装饰器参数)、__call__(接收被装饰函数)、再定义一个内部方法或在 __call__ 中返回闭包 —— 但要注意:类实例必须可调用,且要手动处理 __name__ 等属性,或仍需搭配 @wraps(对 __call__ 中包装的函数)。

简单原则:90% 场景用函数式三层足够;只有真正需要实例状态或复杂初始化逻辑时,才切换到类。

容易忽略的一点:类装饰器若未显式定义 __get__ 方法,在装饰实例方法时可能丢失 self 参数,导致 TypeError: wrapper() missing 1 required positional argument: 'self' —— 这比函数式更隐蔽。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

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

下载

相关标签:

python

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

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1811

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4784

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1769

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

28417

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3407

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3427

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1203

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

616

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2643

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习