两个很实用的Python装饰器详解

1. 什么是Python装饰器

装饰器（Decorator）是Python中一种用于修改函数或类的行为的特殊函数或类。装饰器可以接受一个函数或类作为输入，并返回一个新的函数或类作为输出。通过使用装饰器，我们可以在不修改原有函数或类的情况下，为其添加新的功能或修改其行为。

Python装饰器提供了一种简单而强大的方式来改变或增强函数的功能，它是Python语言中非常重要和常用的特性之一。

2. 装饰器的基本用法

要使用装饰器，首先需要定义一个装饰器函数。装饰器函数要求接受一个函数作为输入，并返回一个函数作为输出。下面是一个简单的装饰器函数示例：

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

上述装饰器函数接受一个函数作为参数，并定义了一个内部函数wrapper，在wrapper函数中可以在调用原函数之前和之后执行一些额外的代码。

要使用装饰器对一个函数进行装饰，可以将装饰器函数使用@符号放置在被装饰的函数定义之前：

@decorator_func
def my_function():
    print("Function execution")

上述代码相当于执行了my_function = decorator_func(my_function)，即将my_function作为参数传递给装饰器函数decorator_func，并将返回的新函数赋值给my_function。

接下来，每次调用my_function时，实际上是调用了装饰器返回的wrapper函数，从而在函数执行前后添加了额外的代码：

my_function()

输出：

Before function execution
Function execution
After function execution

从上述示例可以看出，装饰器在不修改原函数代码的情况下，成功地为my_function函数添加了额外的功能。

3. 装饰器的应用场景

3.1. 日志记录

装饰器可以用于在函数执行前后记录日志。下面是一个用于记录函数执行时间的日志装饰器：

import time
def log_execution_time(func):
    def wrapper(*args, **kwargs):
        start_time = time.time()
        result = func(*args, **kwargs)
        end_time = time.time()
        execution_time = end_time - start_time
        print(f"Function {func.__name__} executed in {execution_time:.2f} seconds")
        return result
    return wrapper
@log_execution_time
def my_function():
    # 模拟函数执行
    time.sleep(1)
    print("Function execution")
my_function()

输出：

Function execution
Function my_function executed in 1.00 seconds

从输出可以看出，装饰器成功地记录了my_function函数的执行时间。

3.2. 输入验证

装饰器还可以用于对函数的输入进行验证。下面是一个用于验证函数参数类型的装饰器：

def validate_arguments(types):
    def decorator_func(func):
        def wrapper(*args):
            for arg, arg_type in zip(args, types):
                if not isinstance(arg, arg_type):
                    raise TypeError(f"Argument {arg} is not of type {arg_type.__name__}")
            return func(*args)
        return wrapper
    return decorator_func
@validate_arguments([int, float])
def calculate_sum(a, b):
    return a + b
print(calculate_sum(2, 3.5))
print(calculate_sum(2, "3.5"))

输出：

5.5
TypeError: Argument 3.5 is not of type int

从输出可以看出，装饰器成功地验证了calculate_sum函数的参数类型，并对不符合要求的参数抛出了异常。

4. 结论

通过使用装饰器，我们可以轻松地实现对函数的增强、修改或验证功能。装饰器是Python中一种非常实用和强大的特性，可以大大提高代码的复用性和可读性。

本文介绍了装饰器的基本用法，并通过日志记录和输入验证两个实际应用场景的示例，展示了装饰器的威力。

使用装饰器时，可以根据具体需求编写不同功能的装饰器函数，并通过@符号将其应用到目标函数上。装饰器可以帮助我们实现一些常见的编程模式，如日志记录、输入验证、性能分析等。