文章/答案/技术大牛

发布

社区首页 >专栏 >一则小故事带你弄清Python装饰器

一则小故事带你弄清Python装饰器

原创

忆想不到的晖

修改于 2021-05-07 02:15:27

4520

文章被收录于专栏：huihui

装饰器

装饰器是程序开发中经常会用到的一个功能，用好了装饰器，开发效率如虎添翼，所以这也是Python面试中必问的问题。装饰器 (Decorators) 是 Python 的一个重要部分。简而言之：Python中的装饰器就是拓展原来函数功能的一种函数。

回顾函数引用

#### 第一波 ####
def func():
    print("func() called")

func    # 表示是函数
func()  # 表示执行func函数

#### 第二波 ####
def func():
    print("func() called")

func = lambda x: x + 1

func()  # 执行lambda表达式，而不再是原来的func函数，因为func这个名字被重新指向了另外一个匿名函数

从上一文深入浅出Python闭包中，就知道函数名仅仅是个变量，只不过指向了定义的函数而已，所以才能通过 函数名() 调用，如果 函数名 = xxx 被修改了，那么当在执行函数名() 时，调用的就不知之前的那个函数了。

这里又提到 lambda 表达式，其就是一个 匿名函数。下面一图就可参透

小故事带你了解装饰器的功能

初创公司有N个业务部门，基础平台部门负责提供底层的功能，如：数据库操作、redis调用、监控API等功能。业务部门使用基础功能时，只需调用基础平台提供的功能即可。如下：

############### 基础平台提供的功能如下 ###############

def f1():
    print('f1')

def f2():
    print('f2')

def f3():
    print('f3')

def f4():
    print('f4')

############### 业务部门A 调用基础平台提供的功能 ###############

f1()
f2()
f3()
f4()

############### 业务部门B 调用基础平台提供的功能 ###############

f1()
f2()
f3()
f4()

目前公司有条不紊的进行着，但是，以前基础平台的开发人员在写代码时候没有关注验证相关的问题，即：基础平台的提供的功能可以被任何人使用。现在需要对基础平台的所有功能进行重构，为平台提供的所有功能添加验证机制，即：执行功能前，先进行验证。

老大把工作交给 Low B，他是这么做的：

跟每个业务部门交涉，让每个业务部门自己写代码，调用基础平台的功能之前先验证。诶，这样一来基础平台就不需要做任何修改了。太棒了，有充足的时间泡妹子...

当天Low B 被开除了…

老大把工作交给 Low BB，他是这么做的：

############### 基础平台提供的功能如下 ############### 

def f1():
    # 验证1
    # 验证2
    # 验证3
    print('f1')

def f2():
    # 验证1
    # 验证2
    # 验证3
    print('f2')

def f3():
    # 验证1
    # 验证2
    # 验证3
    print('f3')

def f4():
    # 验证1
    # 验证2
    # 验证3
    print('f4')

############### 业务部门不变 ############### 
### 业务部门A 调用基础平台提供的功能### 

f1()
f2()
f3()
f4()

### 业务部门B 调用基础平台提供的功能 ### 

f1()
f2()
f3()
f4()

过了一周 Low BB 被开除了…

老大把工作交给 Low BBB，他是这么做的：

只对基础平台的代码进行重构，其他业务部门无需做任何修改

############### 基础平台提供的功能如下 ############### 

# 新增一个验证函数
def check():
    # 验证1
    # 验证2
    # 验证3
    pass

def f1():
    check()
    print('f1')

def f2():
    check()
    print('f2')
    
def f3():
    check()
    print('f3')

def f4():
    check()
    print('f4')

老大看了下Low BBB 的实现，嘴角漏出了一丝的欣慰的笑，语重心长的跟Low BBB聊了个天：

老大说：

写代码要遵循 开放封闭 原则，虽然在这个原则是用的面向对象开发，但是也适用于函数式编程，简单来说，它规定已经实现的功能代码不允许被修改，但可以被扩展，即：

封闭：已实现的功能代码块
开放：对扩展开发

如果将开放封闭原则应用在上述需求中，那么就不允许在函数 f1、f2、f3、f4 的内部进行修改代码，老板就给了Low BBB一个实现方案：

# 这个就是闭包应用，只不过传递过来的 func 是函数的引用
def check(func):
    def inner():
        # 验证1
        # 验证2
        # 验证3
        func()
    return inner

@check
def f1():
    print('f1')
    
@check
def f2():
    print('f2')
    
@check
def f3():
    print('f3')
    
@check
def f4():
    print('f4')

对于上述代码，也是仅仅对基础平台的代码进行修改，就可以实现在其他人调用函数 f1, f2, f3, f4 之前都进行【验证】操作，并且其他业务部门无需做任何操作。

Low BBB心惊胆战的问了下，这段代码的内部执行原理是什么呢？

老大正要生气，突然Low BBB的手机掉到地上，恰巧屏保就是Low BBB的女友照片，老大一看一紧一抖，喜笑颜开，决定和Low BBB交个好朋友。

详细的开始讲解了：

单独以 f1() 为例：

def check(func):
    def inner():
        # 验证1
        # 验证2
        # 验证3
        func()
    return inner

@check
def f1():
    print('f1')

Python解释器就会从上到下解释代码，步骤如下：

def check(func): ==> 将check函数加载到内存
@check

没错，从表面上看解释器仅仅会解释这两句代码，因为函数在没有被调用之前其内部代码不会被执行。

从表面上看解释器着实会执行这两句，但是 @check 这一句代码里却有大文章， @函数名是Python的一种语法糖。

上例@check内部会执行一下操作：

执行check函数

执行check函数，并将 @check 下面的函数作为 check函数的参数
即：@check 等价于 check(f1) 所以内部就会去执行：

def inner(): 
    #验证 1
    #验证 2
    #验证 3
    func()    # func是参数，此时 func 等于 f1 
return inner

返回的 inner，inner代表的是函数，非执行函数 ,其实就是将原来的 f1 函数塞进另外一个函数中

check函数的返回值

将执行完的check函数返回值赋值给@check下面的函数的函数名f1 即将check的返回值再重新赋值给 f1，即：

新f1 = def inner(): 
            # 验证 1
            # 验证 2
            # 验证 3
            原来f1()
        return inner

所以，以后业务部门想要执行 f1 函数时，就会执行新f1 函数，在新f1 函数内部先执行验证，再执行原来的f1函数，然后将原来f1 函数的返回值返回给了业务调用者。

如此一来，即执行了验证的功能，又执行了原来f1函数的内容，并将原f1函数返回值返回给业务调用着

Low BBB 你明白了吗？要是没明白的话，我晚上去你家帮你解决吧！！！

这则生动形象的小故事是引用网上的。

Python 装饰器简单应用

Python中装饰器的语法以 @ 开头，接着是装饰器函数的名字、可选参数。
紧跟装饰器声明的是被装饰的函数和被装饰的函数的可选参数，如下：

@decorator(装饰器的可选参数)
def func(函数参数):
	......

计算函数运行时间

寻找0, 1000之间三个数，条件: a + b + c = 1000，且符合a*a + b*b = c*c，结果不能重复，
如(0, 500, 500) 和 (500, 0, 500)只能出现一个，注：a, b, c 就是要寻找的三个数。

"""
Python 重点知识装饰器
"""
import time


print("# -------------------- 计算函数运行时间 -------------------- #")

def calc_time(func):
    """
    计算函数运行时间
    """
    def calc():
        # 函数调用前，记录开始时间
        start_time = time.time()
        func()
        # 函数结束，计算运行时间
        use_time = time.time() - start_time
        print(func.__name__, "use time {} seconds".format(use_time))

    return calc


@calc_time
def fun1():
    """
    寻找[0, 1000]之间三个数
    条件: a + b + c = 1000,
         且符合a*a + b*b = c*c,
         结果不能重复
    """
    ret_set = set()
    for i in range(0, 1001):
        for j in range(0, 1001):
            for m in range(0, 1001):
                if (i + j + m) == 1000 and (i*i + j*j) == m*m:
                    # print(i, j, m)
                    li = [i, j, m]
                    
                    # 记得排序后再去添加到集合中
                    # 防止[0, 500, 500]、[500, 0, 500]等不去重
                    li.sort()   
                    ret_set.add(tuple(li))

    print(ret_set)
    

@calc_time
def fun2():
    """
    改进版
    """
    ret_set = set()
    for i in range(10001):
        for j in range(1001 - i):
            m = 1000 - i - j
            if i*i + j*j == m*m:
                # print(i, j, m)
                li = [i, j, m]
                li.sort()
                ret_set.add(tuple(li))
    print(ret_set)


def main():
    fun1()
    print()
    fun2()


if __name__ == '__main__':
    main()

运行结果

# -------------------- 计算函数运行时间 -------------------- #
{(0, 500, 500), (200, 375, 425)}
fun1 use time 99.87939643859863 seconds

{(0, 500, 500), (200, 375, 425)}
fun2 use time 0.12499618530273438 seconds

这段程序不仅说明了装饰器的强大，可复用性高，还提醒大家设计一个好程序，程序性能倍翻。