编写自己的Python装饰器

自定义装饰器是Python编程中非常实用的技巧之一。它可以帮助我们简化代码、增加代码的复用性，并提高代码的可读性。在本文中，我们将从不同的角度进行详细阐述，如何编写自己的Python装饰器。

一、装饰器的基本概念

1、装饰器的作用是什么？

装饰器是一个用来包装其他函数或类的函数。它可以在被装饰的对象执行前后额外执行一些操作，比如日志记录、性能监控等。

2、装饰器的使用方法：

def decorator(func):
    def wrapper(*args, **kwargs):
        # 在被装饰的函数执行前的操作
        print("Before function execution.")
        
        # 调用被装饰的函数
        result = func(*args, **kwargs)
        
        # 在被装饰的函数执行后的操作
        print("After function execution.")
        
        return result
    
    return wrapper

@decorator
def my_function():
    print("Hello, world!")

my_function()

上述代码定义了一个装饰器函数decorator，它将其接收的函数func进行装饰，并返回一个新的函数wrapper。这个新的函数在被装饰的函数执行前后会额外执行一些操作。

在my_function函数定义的上方使用@decorator语法糖，表示将其装饰为被decorator函数包装后的函数。

二、装饰器的参数

1、装饰器接收参数的方法：

def param_decorator(param):
    def decorator(func):
        def wrapper(*args, **kwargs):
            print(f"Decorator parameter: {param}")
            result = func(*args, **kwargs)
            return result
        return wrapper
    return decorator

@param_decorator("Hello, parameter!")
def my_function():
    print("Hello, world!")

my_function()

上述代码中，param_decorator是一个装饰器工厂，它接收一个参数param，并返回一个装饰器函数decorator。这个装饰器函数可以用来装饰其他函数。

当装饰器函数decorator被调用时，它还会接收被装饰的函数作为参数，所以我们可以在装饰器函数中通过闭包的方式，将外部参数param传递给内部包装函数wrapper。

在my_function函数定义的上方使用@param_decorator("Hello, parameter!")，表示将其装饰为被param_decorator装饰器包装后的函数，并传递参数"Hello, parameter!"给装饰器。

三、带有参数的装饰器

有时候，我们可能需要编写一个带有参数的装饰器。这样的装饰器可以接收额外的参数，并根据这些参数进行不同的处理。

def timeout(seconds):
    def decorator(func):
        def wrapper(*args, **kwargs):
            import time
            start_time = time.time()
            result = func(*args, **kwargs)
            end_time = time.time()

            execution_time = end_time - start_time

            if execution_time > seconds:
                print("Function execution time exceeds timeout.")
                print(f"Timeout: {seconds} seconds")
                print(f"Execution time: {execution_time} seconds")

            return result
        return wrapper
    return decorator

@timeout(3)
def my_function():
    import time
    time.sleep(5)
    print("Function executed successfully.")

my_function()

上述代码中，我们定义了一个带有参数的装饰器timeout，它接收一个参数seconds，表示函数的最大执行时间。

装饰器timeout内部的包装函数wrapper会使用time.time()来计算函数执行的时间。如果超过了设定的最大执行时间，则会输出相应的提示信息，并返回函数的结果。

在my_function函数定义的上方使用@timeout(3)，表示将其装饰为被timeout装饰器包装后的函数，并传递参数3给装饰器。

四、多个装饰器的叠加

在Python中，我们可以将多个装饰器叠加使用，对目标函数进行多重包装。具体的装饰顺序取决于装饰器的定义顺序。

def decorator1(func):
    def wrapper(*args, **kwargs):
        print("Decorator 1")
        result = func(*args, **kwargs)
        return result
    return wrapper

def decorator2(func):
    def wrapper(*args, **kwargs):
        print("Decorator 2")
        result = func(*args, **kwargs)
        return result
    return wrapper

@decorator1
@decorator2
def my_function():
    print("Hello, world!")

my_function()

上述代码中，我们定义了两个装饰器decorator1和decorator2，它们分别在函数执行前后输出不同的提示信息。

在my_function函数定义的上方使用@decorator1和@decorator2，表示先将其传给decorator2装饰器进行包装，然后再将结果传给decorator1装饰器进行包装。

当我们调用my_function函数时，会按照由内到外的顺序，依次执行装饰器函数中的代码。

五、总结

本文介绍了如何编写自己的Python装饰器。我们了解了装饰器的基本概念、装饰器的参数、带有参数的装饰器以及多个装饰器的叠加使用。

通过使用装饰器，我们可以轻松地实现代码的复用和功能的扩展，提高代码的可读性和可维护性。