一、需求引入
在日常工作中,经常会需要对一些方法的执行耗时进行统计,也方便优化性能,在一些自动化测试时需要判断被测对象的执行耗时是否超时。要实现这些功能的,并且可复用的话,装饰器是一个不错的选择。
二、计算执行耗时装饰器
同步方法装饰器
import time
def timeit(func):
def wrapper(*args, **kwargs):
start_time = time.time()
result = func(*args, **kwargs)
end_time = time.time()
print(f"{func.__name__} finished in {end_time - start_time:.6f} seconds.")
return result
return wrapper
# 示例同步函数
@timeit
def some_sync_task(sleep_duration: float):
time.sleep(sleep_duration)
# 运行示例
if __name__ == "__main__":
some_sync_task(0.5) # 让同步任务模拟运行2秒
异步方法装饰器
import asyncio
import time
def async_timeit(func):
async def wrapper(*args, **kwargs):
start_time = time.time()
await func(*args, **kwargs)
end_time = time.time()
print(f"{func.__name__} finished in {end_time - start_time:.6f} seconds.")
return wrapper
# 示例异步函数
@async_timeit
async def some_async_task(sleep_duration: float):
await asyncio.sleep(sleep_duration)
# 运行示例
async def main():
await some_async_task(0.5) # 让异步任务模拟运行2秒
if __name__ == "__main__":
asyncio.run(main())
三、超时装饰器
其实我一开始使用的timeout参数是int
类型的,但考虑到超时不一定是整数值,比如0.5秒之类的是现实中更实用的场景,因此把timeout参数改为float
类型。
1. 丐版超时装饰器
适用于对执行耗时比较敏感,需要尽量减少装饰器本身耗时的场景。 缺点是比较简陋,只能以秒为单位设置timeout
.
# 异步装饰器(包含实际执行耗时)
import asyncio
import time
from functools import wraps
class TimeOutErr(Exception):
def __init__(self, message: str = "Function execution timed out", exec_time: float = None):
self.message = message
self.exec_time = exec_time
super().__init__(message)
def async_timeout(timeout: float):
def decorator(func):
@wraps(func)
async def wrapper(*args, **kwargs):
start_time = time.time()
try:
result = await asyncio.wait_for(func(*args, **kwargs), timeout=timeout)
r