强大而灵活的python装饰器

news2024/9/21 10:39:00

装饰器（Decorators）

一、概述

在Python中，装饰器是一种特殊类型的函数，它允许我们修改或增强其他函数的功能，而无需修改其源代码。装饰器在函数定义之后立即调用，并以函数对象作为参数。装饰器返回一个新的函数对象，这个新函数对象通常会“包装”或“装饰”原函数，并在调用时执行额外的操作。

二、基本用法

装饰器的基本语法是使用@符号，后面紧跟装饰器函数的名称。装饰器函数通常接收一个函数作为参数，并返回一个新的函数。

@decorator_function  
def my_function():  
    pass

在上面的代码中，decorator_function是一个装饰器，它接收my_function作为参数，并返回一个新的函数对象。这个新的函数对象在调用时会执行decorator_function中定义的代码，并在适当的时候调用my_function。

三、装饰器函数

装饰器函数通常接收一个函数作为参数，并返回一个新的函数。装饰器函数内部的新函数通常会调用原函数，并在调用前后执行额外的操作。

def decorator_function(func):  
    def wrapper(*args, **kwargs):  
        # 在原函数执行前执行的代码  
        print("Before function call")  
          
        # 调用原函数  
        result = func(*args, **kwargs)  
          
        # 在原函数执行后执行的代码  
        print("After function call")  
          
        return result  
      
    return wrapper

四、使用装饰器

使用装饰器非常简单，只需在函数定义之前加上@符号和装饰器函数的名称即可。

@decorator_function  
def my_function():  
    print("Inside function")  
  
# 调用被装饰的函数  
my_function()

五、使用装饰器的测试示例

下面是一个使用装饰器来实现基准测试的示例：

import time  
from functools import wraps  
  
def benchmark(func):  
    """  
    基准测试装饰器，用于测量函数的执行时间。  
  
    参数:  
        func (callable): 要测试的函数。  
  
    返回:  
        callable: 装饰后的函数，它会打印原始函数的执行时间。  
    """  
    @wraps(func)  
    def wrapper(*args, **kwargs):  
        start_time = time.time()  
        result = func(*args, **kwargs)  
        end_time = time.time()  
          
        elapsed_time = end_time - start_time  
        print(f"执行 {func.__name__} 花费了 {elapsed_time:.6f} 秒")  
        return result  
      
    return wrapper  
  
# 示例函数，我们将对其应用基准测试装饰器  
@benchmark  
def example_function(n):  
    sum = 0  
    for i in range(n):  
        sum += i  
    return sum  
  
# 调用示例函数，装饰器会自动打印执行时间  
print(example_function(1000000))

在这个例子中，benchmark 是一个装饰器函数，它接受一个函数作为参数，并返回一个新的函数 wrapper。wrapper 函数会记录开始和结束时间，然后调用原始函数并打印出执行时间。@wraps(func) 是一个内置装饰器，用于保留原始函数的元信息（如函数名、文档字符串等）。

通过在 example_function 定义之前使用 @benchmark 装饰器，我们告诉Python在调用 example_function 时实际上要调用的是 wrapper 函数，而 wrapper 函数会记录并打印出 example_function 的执行时间。

使用装饰器的好处是你可以在不修改原始函数的情况下轻松添加新功能，例如基准测试。这使得代码更加模块化且易于维护。

六、装饰器的高级用法

1、多个装饰器：

一个函数可以同时使用多个装饰器，只需在函数定义前依次列出它们即可。

@decorator1  
@decorator2  
def my_function():  
    pass

2、带参数的装饰器

装饰器本身也可以接收参数，并在内部定义装饰器函数。

def outer_decorator(param):  
    def decorator_function(func):  
        def wrapper(*args, **kwargs):  
            print(f"Before function call with param: {param}")  
            result = func(*args, **kwargs)  
            print(f"After function call with param: {param}")  
            return result  
          
        return wrapper  
      
    return decorator_function  
  
@outer_decorator("hello")  
def my_function():  
    print("Inside function")  
  
my_function()