函数专题2:装饰器
知识点回顾:
- 装饰器的思想:进一步复用
- 函数的装饰器写法
- 注意内部函数的返回值
昨天我们接触到了函数大部分的功能,然后在你日常ctrl点进某个复杂的项目,发现函数上方有一个@xxx,它就是装饰器
装饰器本质上是一个 Python 函数,它可以让其他函数或方法在不需要做任何代码修改的前提下增加额外功能。--本质是如果让一个函数具备太多功能,那么他看起来就会比较乱,可读性比较差,如果把其中一部分相同甚至可以复用的功能用一个新的函数来调用,然后让2个函数同时实现,就会做到
装饰器可以看作是给函数“穿衣服”,让函数在执行时能有额外的功能,但又不改变函数本身的核心功能,同时要注意“衣服”怎么穿才合适,也就是内部函数返回值的问题。
1. 进一步封装了函数的一些用法,做到dry原则(don't repeat yourself)
2. 使函数更加具有可性
所以装饰器本身就是函数中调用其他函数,实现先拆分函数,再合并函数的功能。
装饰器的思想:进一步复用
装饰器就像是餐厅的服务提升计划。餐厅(程序)有基本的出餐功能(函数),但为了提供更好的体验,可以增加一些额外的服务,比如上菜前的开胃小吃、上菜后的甜点等。这些额外服务可以复用在不同的菜品上,而不需要修改每道菜的制作流程。
普通的函数
下面这个函数实现的是计算2到9999的所有质数(在大于 1 的自然数中,除了 1 和它自身外,不能被其他自然数整除的数),并且打印找到这些数需要的时间
1. 定义一个判断是否为质数
2. 定义一个函数,循环2到9999的数,通过判断质数函数来筛选每个数
3. 在函数中通过time模块进行记时
会发现,这个time模块让整个代码逻辑很混乱,因为函数的主体是找质数,time模块是找质数的时间,如果可以time模块放在函数外,这样逻辑才清晰
import time
def is_prime(num):
if num < 2:
return False
elif num == 2:
return True
else:
for i in range(2, num):
if num % i == 0:
return False
return True
def prime_nums():
t1 = time.time()
for i in range(2, 10000):
if is_prime(i):
print(i)
t2 = time.time()
print(f"执行时间:{t2 - t1}秒")
prime_nums()
函数的装饰器写法
假设我们有一个装饰器,用于记录每道菜的上菜时间,以提高服务效率。
import time
# 装饰器函数:记录上菜时间
def timing_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:.2f} 秒")
return result # 返回上菜的结果
return wrapper
# 使用装饰器
@timing_decorator
def order_dish(dish):
print(f"开始制作 {dish}...")
time.sleep(2) # 模拟制作时间
print(f"{dish} 上菜啦!")
return f"{dish} 完成"
# 调用被装饰的函数
result = order_dish("宫保鸡丁")
print(result)
装饰器的本质是一个高阶函数,它接收一个函数作为参数,并返回一个新函数来替代原函数。这个新函数需要:
1. 保留原函数的调用方式(参数和返回值)。
2. 在原函数执行前后添加额外逻辑(如计时、日志等)。
因此,我们需要在装饰器内部定义一个新函数来实现这些功能。
# 继续定义判断质数的函数
def is_prime(num):
"""
判断一个数是否为素数
"""
if num < 2:
return False
elif num == 2:
return True
else:
for i in range(2, num):
if num % i == 0:
return False
return True
# 装饰器的标准写法
@display_time
def prime_nums(): # 这2行是一个整体
"""
找出2到10000之间的所有素数并打印
"""
for i in range(2, 10000):
if is_prime(i):
print(i)
prime_nums()
# 执行时间每次都会变,但是变动不大,一般计算稳定的执行时间我们都是重复1000遍,然后取平均
内部函数的返回值
在上面的例子中,wrapper
函数是装饰器的内部函数,它负责执行原函数 func
并记录时间。注意,wrapper
函数必须返回 func
的结果(return result
),否则调用被装饰的函数时将无法获取到原函数的返回值。
就像服务员在上菜后,必须把菜端给顾客,否则顾客就吃不到菜。如果 wrapper
不返回 result
,顾客(调用者)就无法获得上菜的结果。
总结
装饰器就像是给函数“穿衣服”,通过装饰器可以在不修改原函数的情况下,增加额外的功能。而内部函数的返回值就像是“服务员端菜”,必须确保把结果返回给调用者,否则就失去了原函数的意义。
作业:
编写一个装饰器 logger,在函数执行前后打印日志信息(如函数名、参数、返回值)
@logger
def multiply(a, b):
return a * b
multiply(2, 3)
# 输出:
# 开始执行函数 multiply,参数: (2, 3), {}
# 函数 multiply 执行完毕,返回值: 6
def logger(func):
def wrapper(*args, **kwargs): # args 是元组,kwargs 是字典
print(f"开始执行函数 {func.__name__},参数: {args}, {kwargs}")
result = func(*args, **kwargs)
print(f"函数 {func.__name__} 执行完毕,返回值: {result}")
return result
return wrapper
@logger
def multiply(a, b):
return a * b
multiply(2, 3) # 调用 multiply 函数,观察日志输出