python装饰器简单应用记录函数开始和结束、测量函数的执行时间、强制函数重试、限制函数的调用速度、脚本意外终止处理

# !/usr/bin/env python
# -*-coding:utf-8 -*-
# File       : 装饰器.py
# Time       ：2023/8/30 12:38
# Author     ：QQ736592720

# @logger
# 我们从最简单的装饰器开始，手动实现一个可以记录函数开始和结束的装饰器。被修饰函数的输出结果如下所示：
def logger(func):
    def wrapper(*args, **kwargs):
        print(f"----- {func.__name__}: start -----")
        ret = func(*args, **kwargs)
        print(f"----- {func.__name__}: end -----")
        return ret

    return wrapper


@logger
def test(x):
    print("test")


test(123)

# @timeit
# 该装饰器用来测量函数的执行时间并打印出来。这对调试和监控非常有用。
# 在下面的代码片段中，@timeit装饰器测量process_data函数的执行时间，并以秒为单位打印所用的时间。
import time
from functools import wraps


def timeit(func):
    @wraps(func)
    def wrapper(*args, **kwargs):
        start = time.perf_counter()
        result = func(*args, **kwargs)
        end = time.perf_counter()
        print(f'{func.__name__} 耗时 {end - start:.6f} 秒')
        return result

    return wrapper


@timeit
def process_data():
    time.sleep(1)


process_data()

# @retry
# 当函数遇到异常时，该装饰器会强制函数重试多次。它接受三个参数：重试次数、捕获的异常以及重试之间的间隔时间。
import random
import time
from functools import wraps


def retry(num_retries, exception_to_check, sleep_time=0):
    """
    遇到异常尝试重新执行装饰器
    """

    def decorate(func):
        @wraps(func)
        def wrapper(*args, **kwargs):
            for i in range(1, num_retries + 1):
                try:
                    return func(*args, **kwargs)
                except exception_to_check as e:
                    print(f"{func.__name__} raised {e.__class__.__name__}. Retrying...")
                    if i < num_retries:
                        time.sleep(sleep_time)
            # 尝试多次后仍不成功则抛出异常
            raise e

        return wrapper

    return decorate


@retry(num_retries=3, exception_to_check=ValueError, sleep_time=1)
def random_value():
    value = random.randint(1, 5)
    if value == 3:
        raise ValueError("Value cannot be 3")
    return value


random_value()

# 限制函数的调用速度。这在模拟、爬虫、接口调用防过载等场景下非常有用。用第三方包，名叫ratelimit。
# pip install ratelimit
from ratelimit import limits

import requests

FIFTEEN_MINUTES = 900


@limits(calls=15, period=FIFTEEN_MINUTES)
def call_api(url):
    response = requests.get(url)

    if response.status_code != 200:
        raise Exception('API response: {}'.format(response.status_code))
    return response


# @register
# 如果你的Python脚本意外终止，但你仍想执行一些任务来保存你的工作、执行清理或打印消息，
# 那么@register在这种情况下非常方便。

from atexit import register


@register
def terminate():
    print("Goodbye!")


while True:
    print("Hello")

# 运行上面的代码会不断在控制台输出"Hello"，点击Ctrl + C强制终止脚本运行，
# 你会看到控制台输出"Goodbye"，说明程序在中断后执行了@register装饰器装饰的terminate()函数。


# 结论

# 装饰器是一个重要的抽象思想，可以在不改变原始代码的情况下扩展代码，

# 记录函数开始和结束
#
# 测量函数的执行时间
#
# 函数遇到异常时，该装饰器会强制函数重试多次
#
# 限制函数的调用速度，防过载
#
# 脚本意外终止处理