Python札记22_装饰器（更新）

装饰器从何而来

• Long long ago, 你写了一段代码，一段非常漂亮的代码。
• 现在你想看看这段代码在你机器上运行了多长时间。
• 你可能需要修改源代码，给它加上新的计时功能time()函数。
• 加上计时功能之前，你至少需要阅读源代码，理清它的逻辑，才敢加上新的功能。
• 如果代码比较少的话，还是ok；如果代码很庞大，你通读下来岂不是很费时间呢？
• 有没有一种方法：无论源代码多长，不修改源代码，就可以实现加上其他功能的这个需求呢？The answer is :YES!
• 装饰器由此而来

装饰器本身就是个函数，将被装饰的类或者函数当做参数传递给装饰器函数。它的功能是用来扩展原来函数功能的一种函数。它经常用于有切面需求的场景，比如：插入日志、性能测试、事务处理、缓存、权限校验等场景。装饰器的特殊之处在于：它的返回值也是一个函数。总结特点：

• 本身是函数
• 返回值也是函数
• 装饰器是一种特殊的闭包

• 切面需求的场景

python装饰器简介
Python装饰器
如何理解Python装饰器

---

看一个简单而经典的例子：

def foo(fun):   # foo函数的参数是个函数fun
    def wrap():
        print("start")
        fun()
        print("end")
        print(fun.__name__)
    return wrap

def bar():
    print("I am in bar()")
    
f = foo(bar)       # 给foo函数一个参数bar，bar就是函数，与定义相同；即：向foo()传递了函数对象bar()
f()

结果

start
I am in bar()
end
bar

image.png

• 加上装饰器@foo：

def foo(fun):   # foo函数的参数是个函数fun
    def wrap():
        print("start")
        fun()
        print("end")
        print(fun.__name__)
    return wrap

@foo   # 增加的内容：称为语法糖；增减程序的可读性，减少代码出错的机会。
def bar():
    print("I am in bar()")
    
bar()    

image.png

---

判断某个数是否是质数，并输出2-10000之间的所有质数

def is_prime(num):   #  判断一个数是否是质数
    if num < 2:   # 即num为1
        return False  #返回结果1不是质数
    elif num == 2:  # 判断num为2
        return True   # 判断2是质数
    else:
        for i in range(2, num):   # 判断2到num之间是否还有num的因素
            if num % i == 0:   # 如果存在某个数i使的num除以i的结果为0，那么i是num的因数，num就不是质数。
                return False  # 结果判断不是质数
        return True
    
def prime_nums():
    for i in range(2, 10000):
        if is_prime(i):  # 如果某个数是质数，默认条件为真True
            print(i)
            
prime_nums()

结果

2
3
5
7
11
......（省略）
9973

引入time模块，计算代码运行时间

import time   # 导入计时模块

def is_prime(num):   #  判断一个数是否是质数
    if num < 2:   # 即num为1
        return False  #返回结果1不是质数
    elif num == 2:  # 判断num为2
        return True   # 判断2是质数
    else:
        for i in range(2, num):   # 判断2到num之间是否还有num的因素
            if num % i == 0:   # 如果存在某个数i使的num除以i的结果为0，那么i是num的因数，num就不是质数。
                return False  # 结果判断不是质数
        return True
    
def prime_nums():
    t1 = time.time()   # 开始时间
    for i in range(2, 10000):
        if is_prime(i):  # 如果某个数是质数，默认条件为真True
            print(i)
            
    t2 = time.time()  # 结束时间
    print(t2 - t1)
    
prime_nums()

代码部分包含逻辑判断部分和计时部分，写在一起比较混乱。怎么简写将逻辑部分和计时部分分开呢？最好的方法就是使用装饰器

• 一部分函数执行逻辑
• 一部分函数执行计时功能

import time

# 定义装饰器函数display_time
def display_time(func):    # 找到display_time()装饰器下面的count_prime_nums()函数
    def wrapper(*args):      #  不确定参数的个数，通过*args以元组的方式统一进行收集；参数就是count_prime_nums函数中的参数
        t1 = time.time()        # 第一步：执行获取时间t1 
        result = func(*args)  #第二步： 执行装饰器里面的函数，将count保存在result中；同时打印时间差
        t2 = time.time()    # 第三步：执行获取时间t2
        print("total time:{:.4} s".format(t2 - t1))
        return result     # 第四步：将result进行返回
    return wrapper

def is_prime(num):   # 判断一个数是否是质数
    if num < 2:   # 即num为1
        return False  #返回结果1不是质数
    elif num == 2:  # 判断num为2
        return True   # 判断2是质数
    else:
        for i in range(2, num):   # 判断2到num之间，是否还有num的因数
            if num % i == 0:   # 如果存在某个数i使的num除以i结果的余数为0，则i是num的因数，num就不是质数。
                return False  # 结果判断不是质数
        return True

# 装饰器函数需要执行的部分
@display_time
def count_prime_nums(maxnum):
    count = 0
    for i in range(2,  maxnum):
        if is_prime(i):  # 如果某个数是质数，默认条件为真True
            count += 1   
    return count     # 返回质数的个数

count = count_prime_nums(5000)
count

结果

total time:0.1446 s
669

image.png

加强理解

• 整个代码中有三个函数，分别实现三个功能
  • 1、display_time() ：为装饰器函数
  • 2、is_prime()：为判断是否为质数的函数
  • 3、count_prime_nums()：为统计质数个数的函数
• 注意函数1中的执行顺序：先计算time1，再执行装饰器里面的函数，当遇到func，执行函数3，最后计算time2
• 当函数3中有多个参数，且不确定个数的时候，通过*args以元组的形式进行收集