一文搞懂Python装饰器

简介: 一文搞懂Python装饰器

一、前言


本不打算专门写文来讲装饰器的,但有不少粉丝问到了,自己查阅了一些网上的装饰器教程,发现讲的通俗易懂的不多,也有不少照搬的文章。所以我这里专门来讲一讲它。


二、举例说明


假如我们需要对每个函数方法的执行时间做记录,想知道执行一个函数花费了多长时间。

现在先不用装饰器来写,在函数方法体内的开始和结尾各加一个当前时间的输出,然后print打印他们的差值:

import time
import datetime
def test():
    start_time = datetime.datetime.now()
    for i in range(3):
        time.sleep(1)
    end_time = datetime.datetime.now()
    print('执行结束,执行时间为:', end_time - start_time)
test()

输出结果


执行结束,执行时间为: 0:00:03.025049


成功的实现了这个需求,但是出现了一个问题,如果有多个函数方法需要计算执行时间的话,那不就每个函数方法都要加这些代码吗?这样代码量不就大了,还很繁琐冗余吗?


这个时候装饰器就可以大显身手了!

我们可以通过写一个装饰器来实现这个需求,装饰器代码如下:


def take_up_time(func):
    def run_time():
        start_time = datetime.datetime.now()
        func() # 执行被装饰的函数
        end_time = datetime.datetime.now()
        print('执行结束,执行时间为:', end_time - start_time)
    return run_time

加入到需要记录执行时间的方法上


@take_up_time
def test():
    for i in range(3):
        time.sleep(1)
test()


输出结果

执行结束,执行时间为: 0:00:03.035180


这样就算需要统计多个方法的执行时间,我们只需要在对应函数方法上方加入该装饰器就能实现了,是不是简单多了!


Python语法糖@定义了装饰器,Python装饰器是基于闭包原理对已存在的函数增加额外的功能的设计模式,使得代码简洁且易于维护。因为装饰器本身就是一个闭包,对于上面的代码我们可以改为这样:

# 删除@take_up_time的引入
def test():
    for i in range(3):
        time.sleep(1)
y = take_up_time(test)  # 直接将test函数传入take_up_time方法中
y()  # 执行y,这两行代码也可以直接写成一行:take_up_time(test)()


三、装饰器详解


上述例子的装饰器会不会感觉跟其他地方看到的有些许不一样,它们写的装饰器参数都带有*args,**kwargs,类似下面这样的:


def log(func):
    def warp(*args, **kwargs):
        print("准备开始了")
        #对于这个例子,这里代码可理解为:result=add(1,7)
        result = func(*args, **kwargs)  
        print("马上结束了")
        return result
    return warp
@log
def add(a, b):
    return a + b
print('计算结果为:', add(1, 7))

输出结果


准备开始了
马上结束了
计算结果为: 8


带了这些参数的和之前的举例有什么区别呢?下面为你讲解:


上述代码带了*args,**kwargs参数用于获取传递给方法add的参数,上面的add(1,7)中的1和7在装饰器中进行了获取,然后原封不动的将参数传递给被装饰的函数result = func(*args, **kwargs),现在我们把装饰器中将传递的参数打印出来:

def log(func):
    def warp(*args, **kwargs):
        print('传递的参数为:',args)
        result = func(*args, **kwargs)
        print("马上结束了")
        return result
    return warp


装饰器输出结果


传递的参数为 (1, 7)
马上结束了


有没有发现上述*args就把传递的参数(1,7)涵盖了,好像跟**kwargs没什么关系。确实是这样的。对于上面的代码确实与**kwargs无关,甚至我们可以去掉**kwargs这样写:

def log(func):
    def warp(*args):
        print('传递的参数为:',args)
        result = func(*args)
        print("马上结束了")
        return result
    return warp

哪种情况需要**kwargs呢?

当你的参数是默认值参数时,类似下面的代码,c就是一个默认值参数 (如果调用函数的时候未指定c的值则c=0,不然则等于指定的值)


def log(func):
    def warp(*args, **kwargs):
        print('传递的参数为:',args,kwargs)
        result = func(*args, **kwargs)
        print("马上结束了")
        return result
    return warp
@log
def add(a, b,c=0):  # 未传递参数C的值时,默认等于0
    return a + b+c
print('计算结果为:', add(1, 7,c=1))   # 未传递参数C的值时,默认等于0

输出结果


传递的参数为: (1, 7) {'c': 1}
马上结束了
计算结果为: 9


通过打印我们发现,c参数的值被放入到kwargs中了。如果我们去掉**kwargs的话,再执行上面的代码就会报错:

def log(func):
    def warp(*args):
        print('传递的参数为:',args)
        result = func(*args)
        print("马上结束了")
        return result
    return warp
@log
def add(a, b,c=0):
    return a + b+c
print('计算结果为:', add(1, 7, c=1))


输出结果

9dcb5f86130847e8af05b9da4b4ff42f.png

另外我们还可直接对装饰器进行参数的传递:

def log(value):
    def decorator(func):
        print('传递给装饰器的值为:',value)  # 会打印直接传递给装饰器的值
        def warp(*args, **kwargs):
            print('传递的参数为:', args, kwargs)
            result = func(*args, **kwargs)
            return result
        return warp
    return decorator
@log(123)  # 传递给装饰器的值
def add(a, b, c=0):  # 未传递参数C的值时,默认等于0
    return a + b + c
print(add(7, 1))


输出结果


传递给装饰器的值为: 123
传递的参数为: (1, 7) {}
计算结果为: 8


当然,装饰器同样也可以被装饰,因为它本质上就是一个函数:


def log2(func):
    def warp(*args, **kwargs):
        print("准备开始了2")
        result = func(*args, **kwargs)
        print("马上结束了2")
        return result
    return warp
def log(func):
    def warp(*args, **kwargs):
        print("准备开始了1")
        result = func(*args, **kwargs)
        print("马上结束了1")
        return result
    return warp
@log
@log2
def add(a, b):
    return a + b
print('计算结果为:', add(1, 7))


输出结果


准备开始了1
准备开始了2
马上结束了2
马上结束了1
计算结果为: 8


四、类装饰器


Python中的类对象是不可被调用的,但通过魔术方法__call__就可以将类变为一个函数,从而实现装饰器的功能,比如最开始我们记录函数执行的例子,通过类装饰器就可以这样写:


import time
import datetime
class TakeUpTime:
    def __init__(self, func):
        self.func = func
    # 对于该例子,*args, **kwargs可以去掉
    def __call__(self, *args, **kwargs):
        start_time = datetime.datetime.now()
        self.func()
        end_time = datetime.datetime.now()
        print('执行结束,执行时间为:', end_time - start_time)
@TakeUpTime
def test():
    for i in range(3):
        time.sleep(1)


五、总结


装饰器的应用场景其实很常见,我们常见的判断用户是否登录(token校验的判断)、用户是否有访问权限很多都是使用装饰器来判断的,在DRF(django restframework)中的@api_view、@permission_classes就是对请求方法和用户权限的校验:

6d010fd3c94c47e8a58d382721c22c37.png


完全掌握装饰器相对来说有点难度,需要花一些时间,但这也是必须掌握的python技能。





目录
相关文章
|
7天前
|
开发者 Python
探索Python中的装饰器:从基础到高级应用
本文将带你深入了解Python中的装饰器,这一强大而灵活的工具。我们将一起探讨装饰器的基本概念,它们如何工作,以及如何使用它们来增强函数和类的功能,同时不改变其核心逻辑。通过具体代码示例,我们将展示装饰器的创建和使用,并探索一些高级应用,比如装饰器堆栈和装饰带参数的装饰器。无论你是初学者还是有经验的开发者,这篇文章都将为你提供新的视角,帮助你更有效地使用装饰器来简化和优化你的代码。
|
8天前
|
测试技术 数据安全/隐私保护 开发者
探索Python中的装饰器:从基础到高级应用
装饰器在Python中是一个强大且令人兴奋的功能,它允许开发者在不修改原有函数代码的前提下增加额外的功能。本文将通过具体代码示例,带领读者从装饰器的基础概念入手,逐步深入到高级用法,如带参数的装饰器和装饰器嵌套等。无论你是初学者还是有经验的开发者,这篇文章都将为你提供有价值的见解和技巧。
|
8天前
|
开发框架 数据建模 中间件
Python中的装饰器:简化代码,增强功能
在Python的世界里,装饰器是那些静悄悄的幕后英雄。它们不张扬,却能默默地为函数或类增添强大的功能。本文将带你了解装饰器的魅力所在,从基础概念到实际应用,我们一步步揭开装饰器的神秘面纱。准备好了吗?让我们开始这段简洁而富有启发性的旅程吧!
20 6
|
10天前
|
测试技术 Python
探索Python中的装饰器:简化代码,增强功能
在Python的世界中,装饰器是那些能够为我们的代码增添魔力的小精灵。它们不仅让代码看起来更加优雅,还能在不改变原有函数定义的情况下,增加额外的功能。本文将通过生动的例子和易于理解的语言,带你领略装饰器的奥秘,从基础概念到实际应用,一起开启Python装饰器的奇妙旅程。
28 11
|
7天前
|
测试技术 开发者 Python
探索Python中的装饰器:从入门到实践
装饰器,在Python中是一块强大的语法糖,它允许我们在不修改原函数代码的情况下增加额外的功能。本文将通过简单易懂的语言和实例,带你一步步了解装饰器的基本概念、使用方法以及如何自定义装饰器。我们还将探讨装饰器在实战中的应用,让你能够在实际编程中灵活运用这一技术。
23 7
|
6天前
|
Python
探索Python中的装饰器:简化代码,增强功能
在Python的世界里,装饰器就像是给函数穿上了一件神奇的外套,让它们拥有了超能力。本文将通过浅显易懂的语言和生动的比喻,带你了解装饰器的基本概念、使用方法以及它们如何让你的代码变得更加简洁高效。让我们一起揭开装饰器的神秘面纱,看看它是如何在不改变函数核心逻辑的情况下,为函数增添新功能的吧!
|
7天前
|
程序员 测试技术 数据安全/隐私保护
深入理解Python装饰器:提升代码重用与可读性
本文旨在为中高级Python开发者提供一份关于装饰器的深度解析。通过探讨装饰器的基本原理、类型以及在实际项目中的应用案例,帮助读者更好地理解并运用这一强大的语言特性。不同于常规摘要,本文将以一个实际的软件开发场景引入,逐步揭示装饰器如何优化代码结构,提高开发效率和代码质量。
29 6
|
6天前
|
存储 缓存 Python
Python中的装饰器深度解析与实践
在Python的世界里,装饰器如同一位神秘的魔法师,它拥有改变函数行为的能力。本文将揭开装饰器的神秘面纱,通过直观的代码示例,引导你理解其工作原理,并掌握如何在实际项目中灵活运用这一强大的工具。从基础到进阶,我们将一起探索装饰器的魅力所在。
|
7天前
|
测试技术 开发者 Python
深入理解Python装饰器:从基础到高级应用
本文旨在为读者提供一个全面的Python装饰器指南,从其基本概念讲起,逐步深入探讨其高级应用。我们将通过实例解析装饰器的工作原理,并展示如何利用它们来增强函数功能、控制程序流程以及实现代码的模块化。无论你是Python初学者还是经验丰富的开发者,本文都将为你提供宝贵的见解和实用的技巧,帮助你更好地掌握这一强大的语言特性。
20 4
|
8天前
|
开发者 Python
Python中的装饰器:从入门到实践
本文将深入探讨Python的装饰器,这一强大工具允许开发者在不修改现有函数代码的情况下增加额外的功能。我们将通过实例学习如何创建和应用装饰器,并探索它们背后的原理和高级用法。
24 5