装饰器(Decorator)的工作原理与手写实现

装饰器是Python中通过函数闭包和语法糖实现功能扩展的机制,核心步骤包括定义外层接收函数、内层包装逻辑并返回wrapper;使用functools.wraps可保留原函数元信息;多个装饰器按从内到外顺序执行,适用于日志、权限等分层场景。

装饰器(decorator)的工作原理与手写实现

装饰器(Decorator),在我看来,是Python语言里一种非常巧妙且强大的设计模式,它本质上就是一个函数,接收另一个函数作为参数,然后返回一个新的函数。它的核心思想在于,你可以在不修改原始函数代码的前提下,动态地给它“包裹”上额外的功能,比如日志记录、权限校验、性能监控、缓存等等。这就像给一个礼物盒外面再套一层包装纸,里面的礼物没变,但外在的呈现或附加价值却增加了。

装饰器的工作原理,其实可以拆解成几个关键点。首先,Python中的函数是“一等公民”,这意味着它们可以像普通变量一样被传递、赋值和返回。其次,闭包(Closure)的概念在这里至关重要:内部函数可以记住并访问其外部(封闭)作用域的变量,即使外部函数已经执行完毕。最后,Python的语法糖

@decorator

简化了

func = decorator(func)

这种写法,让代码看起来更简洁、更具可读性。当你定义一个函数并用

@decorator

修饰时,Python解释器会在函数定义完成后,自动执行

decorator(func)

,并将返回的新函数重新绑定到原函数名上。

手写一个Python装饰器,核心步骤有哪些?

要亲手实现一个装饰器,你需要理解它内部的构造逻辑。最基础的结构通常包含一个外层函数和一个内层函数(即

wrapper

)。外层函数负责接收被装饰的函数作为参数,而内层函数则是实际执行额外逻辑和调用原始函数的地方。

我们来写一个简单的计时器装饰器,看看它是怎么运作的:

import timedef timer_decorator(func):    """    一个简单的计时器装饰器,用于测量函数执行时间。    """    def wrapper(*args, **kwargs):        start_time = time.time()        result = func(*args, **kwargs) # 调用原始函数        end_time = time.time()        print(f"函数 '{func.__name__}' 执行耗时: {end_time - start_time:.4f} 秒")        return result    return wrapper# 使用装饰器@timer_decoratordef long_running_function(n):    """一个模拟耗时操作的函数"""    total = 0    for i in range(n):        total += i * i    time.sleep(0.1) # 模拟一些I/O等待    return total# 调用被装饰的函数long_running_function(1000000)# 输出: 函数 'long_running_function' 执行耗时: 0.1xxx 秒

在这个例子中,

timer_decorator

就是我们的外层函数,它接收

long_running_function

作为

func

参数。

wrapper

是内层函数,它包裹了

long_running_function

的实际调用,并在前后添加了计时逻辑。

wrapper

必须能够接受任意参数(

*args

,

**kwargs

),这样才能确保被装饰的函数无论接受什么参数,都能正常工作。最后,

timer_decorator

返回了这个

wrapper

函数。当

long_running_function(1000000)

被调用时,实际上是

wrapper(1000000)

在执行。

装饰器在处理函数元信息时会遇到什么坑?如何使用

functools.wraps

解决?

当我们用装饰器包裹一个函数后,会发现一个“副作用”:被装饰后的函数,其一些元信息(如

__name__

__doc__

__module__

等)会丢失,取而代之的是

wrapper

函数的元信息。这在调试、文档生成或者某些依赖函数签名的工具中,可能会引发一些不必要的困扰。比如,如果你尝试打印

long_running_function.__name__

,你会得到

wrapper

而不是

long_running_function

这是一个实际的例子:

# 沿用上面的 timer_decorator@timer_decoratordef another_function():    """这是另一个函数的文档字符串。"""    print("Hello from another function!")print(f"原始函数名: {another_function.__name__}")print(f"原始函数文档: {another_function.__doc__}")# 输出:# 原始函数名: wrapper# 原始函数文档: None

显然,这并不是我们想要的结果。为了解决这个问题,Python标准库提供了

functools

模块,其中的

wraps

装饰器就是专门用来处理这个问题的。

@functools.wraps(func)

这个装饰器会将被装饰函数

func

的元信息,自动复制到

wrapper

函数上。

让我们修改一下

timer_decorator

import timeimport functools # 引入 functools 模块def timer_decorator_fixed(func):    """    修复了元信息丢失问题的计时器装饰器。    """    @functools.wraps(func) # 使用 functools.wraps    def wrapper(*args, **kwargs):        start_time = time.time()        result = func(*args, **kwargs)        end_time = time.time()        print(f"函数 '{func.__name__}' 执行耗时: {end_time - start_time:.4f} 秒")        return result    return wrapper@timer_decorator_fixeddef yet_another_function():    """这是又一个函数的文档字符串。"""    print("Hello from yet another function!")print(f"修复后的函数名: {yet_another_function.__name__}")print(f"修复后的函数文档: {yet_another_function.__doc__}")# 输出:# 修复后的函数名: yet_another_function# 修复后的函数文档: 这是又一个函数的文档字符串。

通过

@functools.wraps(func)

,我们确保了

yet_another_function

在被装饰后,依然能正确地暴露其原始的元信息,这对于维护代码的清晰性和可调试性至关重要。

链式装饰器(Decorator Chaining)是如何工作的,以及它有什么使用场景?

装饰器的一个很酷的特性是它们可以被“链式”应用,也就是一个函数可以同时被多个装饰器修饰。这就像层层叠叠的包装,每个装饰器都在前一个装饰器返回的新函数上再加一层功能。

当你在一个函数上应用多个装饰器时,例如:

@decorator_a@decorator_bdef my_function():    pass

它的执行顺序是从“最靠近函数”的装饰器开始,向外层依次应用。等价于:

my_function = decorator_a(decorator_b(my_function))

这意味着

decorator_b

会先装饰

my_function

,返回一个新函数

new_my_function_b

。然后,

decorator_a

再装饰这个

new_my_function_b

,最终返回的函数才是绑定到

my_function

上的。

一个常见的应用场景是权限校验和日志记录的组合。假设你有一个API端点,既需要验证用户身份,又需要记录每次访问。

import functoolsdef log_access(func):    @functools.wraps(func)    def wrapper(*args, **kwargs):        print(f"访问日志: 调用函数 '{func.__name__}'")        return func(*args, **kwargs)    return wrapperdef require_admin(func):    @functools.wraps(func)    def wrapper(*args, **kwargs):        # 实际场景中会检查用户session或token        is_admin = True # 简化示例,假设总是管理员        if is_admin:            print(f"权限检查: 用户是管理员,允许访问 '{func.__name__}'")            return func(*args, **kwargs)        else:            print(f"权限检查: 用户不是管理员,拒绝访问 '{func.__name__}'")            raise PermissionError("需要管理员权限")    return wrapper@log_access@require_admindef delete_critical_data(user_id):    """删除关键数据,仅限管理员操作并记录日志"""    print(f"正在删除用户 {user_id} 的关键数据...")    return f"数据已删除 for user {user_id}"# 尝试调用try:    print(delete_critical_data(123))except PermissionError as e:    print(e)# 预期输出:# 权限检查: 用户是管理员,允许访问 'delete_critical_data'# 访问日志: 调用函数 'delete_critical_data'# 正在删除用户 123 的关键数据...# 数据已删除 for user 123

在这个例子中,

delete_critical_data

函数首先被

require_admin

装饰,然后

log_access

装饰器再包裹

require_admin

返回的函数。当调用

delete_critical_data

时,最外层的

log_access

wrapper

会先执行,然后它会调用

require_admin

wrapper

require_admin

wrapper

在权限通过后,最终才会调用原始的

delete_critical_data

函数。这种分层处理逻辑的方式,让代码职责分离,模块化程度更高,也更易于维护。不过,需要注意装饰器的顺序,因为它会影响功能的执行次序。

以上就是装饰器(Decorator)的工作原理与手写实现的详细内容,更多请关注创想鸟其它相关文章!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/1369736.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2025年12月14日 09:55:19
下一篇 2025年12月14日 09:55:34

相关推荐

  • 什么是Python的Type Hints?它有什么好处?

    Type Hints提升代码可读性、可维护性与开发效率,通过静态检查提前发现类型错误,增强IDE智能提示,且不影响运行时性能,可逐步引入大型项目,与单元测试互补而非替代,共同保障代码质量。 Python的Type Hints(类型提示)是一种在代码中声明变量、函数参数和返回值的预期类型的方式,但它并…

    好文分享 2025年12月14日
    000
  • Discord.py 机器人获取用户头像命令教程

    本教程详细指导如何在 discord.py 机器人中实现一个命令,以获取被提及用户的个人资料图片(头像)。文章首先展示在 on_message 事件中实现该功能的基本方法,随后重点介绍如何使用 discord.ext.commands 模块构建更结构化、易于维护的机器人,并提供完整的示例代码和重要注…

    2025年12月14日
    000
  • CI/CD 流水线在 Python 项目中的实践

    CI/CD流水线在Python项目中至关重要,因其能通过自动化测试与部署提升开发效率与代码质量。1. Python动态特性导致运行时错误多,需依赖自动化测试在CI阶段及时发现问题;2. GitHub Actions和GitLab CI是主流工具,前者适合GitHub生态项目,后者更适合一体化DevO…

    2025年12月14日
    000
  • 什么是Python的wheel包?

    Wheel包是预编译的二进制分发格式,安装快且稳定;2. 与需编译的源码包不同,wheel即装即用,尤其利于含C扩展的库;3. 多数情况应优先选用wheel,特殊情况如定制代码或无匹配包时用sdist;4. 构建wheel需setuptools和wheel,运行python setup.py bdi…

    2025年12月14日
    000
  • 如何打包你的 Python 项目?setuptools 与 wheel

    答案:Python项目打包需用pyproject.toml定义元数据和依赖,结合setuptools生成wheel包,实现代码分发、依赖管理与跨环境部署,提升可维护性和协作效率。 打包Python项目,核心在于将其代码、依赖和元数据组织成一个可分发的格式,最常见的就是使用 setuptools 来定…

    2025年12月14日
    000
  • is和==在Python中有什么区别?

    is比较对象身份,==比较对象值;is用于身份判断如None检查,==用于内容相等性比较,应根据语义选择。 在Python中, is 和 == 虽然都用于比较,但它们关注的侧重点截然不同。简单来说, is 比较的是两个变量是否指向内存中的同一个对象,也就是它们的“身份”是否一致;而 == 比较的则是…

    2025年12月14日
    000
  • 如何求一个数的平方根?

    求平方根的核心是找到非负数x使x²=S,常用牛顿迭代法:xₙ₊₁=0.5(xₙ+S/xₙ),收敛快;手算可用分组试商法;负数无实平方根因实数平方非负;估算可找邻近完全平方数夹逼,如√150≈12.24。 求一个数的平方根,核心在于找到一个非负数,它与自身相乘后等于我们想要开平方的那个数。这听起来简单…

    2025年12月14日
    000
  • 如何用Python处理大文件?

    处理大文件的核心是避免一次性加载,采用逐行或分块读取,利用迭代器、生成器、pandas分块和mmap等方法实现流式处理,确保内存可控。 在Python中处理大文件,最核心的思路就是“不要一次性把所有数据都加载到内存里”。无论是文本文件、日志还是大型数据集,我们都需要采用流式处理或分块处理的策略,避免…

    2025年12月14日
    000
  • 迭代器(Iterator)与生成器(Generator)详解

    迭代器和生成器通过按需生成数据提升内存效率与代码简洁性,迭代器需实现__iter__和__next__方法,生成器则用yield简化迭代器创建,适用于处理大数据、无限序列及延迟计算场景。 迭代器(Iterator)和生成器(Generator)在Python编程中是处理序列数据,尤其是大型或无限序列…

    2025年12月14日
    000
  • Python字典的底层实现原理是什么?

    Python字典通过哈希表实现O(1)平均时间复杂度,其核心在于哈希函数、开放寻址冲突解决和动态扩容机制。 Python字典的底层实现核心在于其哈希表(Hash Table)的实现。它通过将键(Key)映射到一个存储位置来快速存取值(Value),这使得大多数操作都能保持接近常数时间复杂度,也就是我…

    2025年12月14日
    000
  • 可变对象与不可变对象在 Python 中的区别

    可变对象创建后可修改内容而不改变内存地址,如列表、字典;不可变对象一旦创建内容不可变,任何修改都会生成新对象,如整数、字符串、元组。 Python中的可变对象和不可变对象,核心区别在于对象创建后其内部状态是否可以被修改。简单来说,如果一个对象在内存中的值(或者说它引用的数据)可以在不改变其内存地址的…

    2025年12月14日
    000
  • Python中的*args和**kwargs有什么作用和区别?

    args和kwargs用于增强函数灵活性,args收集位置参数为元组,kwargs收集关键字参数为字典,二者在函数定义中收集参数,在调用时可解包传递,适用于可变参数场景。 *args 和 **kwargs 是Python中两个非常强大的语法糖,它们允许函数接受可变数量的参数。简单来说, *args …

    2025年12月14日
    000
  • 如何使用Python发送HTTP请求(requests库)?

    答案:使用requests库可简洁发送HTTP请求。通过get()、post()等方法发送请求,配合params、headers、json等参数传递数据,利用raise_for_status()处理错误,使用Session保持会话、复用连接,提升效率与代码可读性。 Python中发送HTTP请求,最…

    2025年12月14日
    000
  • 如何反转一个字符串?

    反转字符串的核心是将字符顺序倒置,常用方法包括语言内置函数(如Python切片、JavaScript的split-reverse-join)、手动循环和递归。内置方法最简洁高效,时间复杂度O(n),推荐优先使用;手动循环适用于需精细控制的场景;递归虽优雅但有栈溢出风险,慎用于长字符串。实际应用包括回…

    2025年12月14日
    000
  • 使用 Matplotlib 和 Seaborn 进行数据可视化

    Matplotlib 提供精细控制,Seaborn 简化统计绘图,两者结合可高效实现数据可视化:先用 Seaborn 快速探索数据,再用 Matplotlib 调整细节与布局,实现美观与功能的统一。 在使用 Python 进行数据可视化时,Matplotlib 和 Seaborn 无疑是两把利器。它…

    2025年12月14日
    000
  • Python中处理包含转义字符的JSON字符串:深入理解原始字符串与F-字符串

    本文深入探讨了在Python中处理包含转义字符的JSON字符串时,原始字符串(r前缀)和F-字符串(f前缀)的使用误区与正确实践。核心问题在于Python字符串字面量解析与JSON转义规则之间的差异,特别是在使用json.loads()解析嵌套JSON或包含反斜杠的字符串时。文章将通过具体示例,阐明…

    2025年12月14日
    000
  • 优雅地终止长时间运行的Asyncio任务:Asyncio.Event的实践指南

    本文深入探讨了在Python asyncio中优雅地终止长时间运行的异步任务的有效方法。针对Task.cancel()方法在某些场景下无法立即停止任务的问题,本文提出并详细阐述了如何利用asyncio.Event机制实现任务的受控停止。通过具体代码示例,读者将学习如何构建响应式、可控的异步任务,确保…

    2025年12月14日
    000
  • 优雅地终止异步任务:asyncio.Event的实践应用

    在asyncio编程中,Task.cancel()方法有时无法按预期停止长时间运行的任务,因为它依赖于任务内部处理CancelledError或在await点检查取消状态。本文将深入探讨Task.cancel()的局限性,并介绍一种更可靠、更优雅的协作式终止机制:使用asyncio.Event。通过…

    2025年12月14日
    000
  • Pandas中条件滚动累加的向量化实现

    本文旨在解决Pandas DataFrame中基于条件和时间窗口进行累加计算的效率问题。通过详细分析迭代方法的局限性,并引入Pandas groupby_rolling函数,展示了如何高效地对指定分组内的历史数据在特定时间窗内进行条件求和。教程提供了示例代码,并强调了数据预处理、排序及窗口定义等关键…

    2025年12月14日
    000
  • asyncio 长运行任务的优雅终止策略:告别 cancel() 的局限性

    本文探讨了 asyncio 中 Task.cancel() 方法在终止长时间运行任务时的局限性,特别是当任务内部循环紧密或不频繁地让出控制权时。我们提出并详细演示了使用 asyncio.Event 实现协作式、优雅的任务终止机制,通过共享事件对象,允许主程序安全地向后台任务发送停止信号,确保任务能够…

    2025年12月14日
    000

发表回复

登录后才能评论
关注微信