python基础篇：什么是装饰器？装饰器有什么用？

Posted 2023-03-30 didiplus

上一篇介绍了python的函数，本文将介绍Python的装饰器，装饰器应用非常广泛，一定要好好掌握啊

什么是装饰器

装饰器是一种Python语言的特性，它允许在不修改已有函数的情况下，向函数添加额外的功能。装饰器本质上是一个函数，它接受一个函数作为参数，并返回一个新的函数。

装饰器应用场景

• 记录函数的执行时间
• 缓存函数的结果，以避免重复计算
• 检查函数的参数是否合法
• 为函数添加日志记录
• 为函数添加事务处理
• 为函数添加权限检查

简单的装饰器

以下是一个简单的装饰器的示例，它向函数添加了计时功能：

import time

def timer(func):
    def wrapper(*args, **kwargs):
        start_time = time.time()
        result = func(*args, **kwargs)
        end_time = time.time()
        print("Time elapsed: ", end_time - start_time)
        return result
    return wrapper

@timer
def my_function():
    time.sleep(2)

my_function()

在上面的示例中，timer是装饰器函数的名称。它接受一个函数作为参数，并返回一个新的函数wrapper。wrapper函数计算函数执行的时间，并打印出来。@timer语法将my_function函数传递给timer装饰器，这意味着my_function函数将被timer装饰器包装。

当my_function函数被调用时，它实际上是wrapper函数被调用。wrapper函数计算函数执行的时间，并打印出来。最后，wrapper函数返回my_function函数的结果。

这将打印Time elapsed: 2.000000238418579到控制台上。

带参数的装饰器

装饰器可以接受参数，以便在运行时自定义装饰器的行为。要创建带参数的装饰器，需要编写一个函数，该函数接受装饰器参数，并返回一个装饰器函数。

以下是一个带参数的装饰器的示例，它允许指定函数的重试次数：

import time

def retry(max_retries):
    def decorator(func):
        def wrapper(*args, **kwargs):
            for i in range(max_retries):
                try:
                    result = func(*args, **kwargs)
                    return result
                except Exception as e:
                    print("Error:", e)
                    time.sleep(1)
            raise Exception("Max retries exceeded")
        return wrapper
    return decorator

@retry(max_retries=3)
def my_function():
    print("Trying...")
    raise Exception("Something went wrong")

my_function()

在上面的示例中，retry是带参数的装饰器函数的名称。它接受一个参数max_retries，并返回一个装饰器函数decorator。decorator函数接受一个函数作为参数，并返回一个新的函数wrapper。wrapper函数尝试调用原始函数，如果发生异常，则等待1秒钟并重试，最多重试max_retries次。

@retry(max_retries=3)语法将my_function函数传递给retry装饰器，并指定max_retries参数为3。

当my_function函数被调用时，它实际上是wrapper函数被调用。wrapper函数尝试调用原始函数，如果发生异常，则等待1秒钟并重试，最多重试3次。

这将打印以下内容到控制台上：

Trying...
Error: Something

@wraps()语法糖

@wraps()是一个装饰器，它用于将被装饰函数的元数据复制到装饰器函数中。这包括函数名称、文档字符串、参数列表等。使用@wraps()装饰器可以确保装饰器函数的元数据与原始函数的元数据相同，这对于调试和文档编写非常有用。

这个装饰器丢失了原来函数对象的一些属性，比如：__name__，__doc__等属性。使用wraps语法糖可以保留这些属性。

以下是一个使用@wraps()装饰器的示例：

from functools import wraps

def my_decorator(func):
    @wraps(func)
    def wrapper(*args, **kwargs):
        print("Before function")
        result = func(*args, **kwargs)
        print("After function")
        return result
    return wrapper

@my_decorator
def my_function():
    print("Function called")

print(my_function.__name__)

总结

装饰器可以接受参数，以便在运行时自定义装饰器的行为。要创建带参数的装饰器，需要编写一个函数，该函数接受装饰器参数，并返回一个装饰器函数。