Python-参数化装饰器

参数化的装饰器简介

装饰器是 Python 中非常强大的功能，允许我们为函数或方法添加功能，而无需修改原始代码。参数化的装饰器是装饰器的一种变体，它允许我们向装饰器传递额外的参数，从而动态调整装饰器的行为。

普通的装饰器只接受一个被装饰的函数作为输入，而参数化的装饰器允许传递自定义参数，并根据这些参数来改变装饰器的功能。

参数化的装饰器实现步骤

参数化的装饰器实际上是一个 返回装饰器的函数。它可以拆分为以下几个层次：

1. 外层函数：接受自定义参数。
2. 中间层函数：接受被装饰的函数。
3. 内层函数：实现装饰器的核心逻辑。

语法结构

def decorator_with_args(arg1, arg2):
    def actual_decorator(func):
        def wrapper(*args, **kwargs):
            # 在这里可以使用 arg1 和 arg2 自定义装饰器行为
            print(f"Decorator parameters: {arg1}, {arg2}")
            result = func(*args, **kwargs)
            return result
        return wrapper
    return actual_decorator

参数化装饰器的应用

示例 1：日志装饰器

我们可以创建一个日志装饰器，它根据传入的日志级别动态调整输出内容：

def log(level):
    def decorator(func):
        def wrapper(*args, **kwargs):
            print(f"[{level.upper()}] {func.__name__} is called with arguments {args} and {kwargs}")
            result = func(*args, **kwargs)
            print(f"[{level.upper()}] {func.__name__} returned {result}")
            return result
        return wrapper
    return decorator

# 使用不同的参数
@log("info")
def add(a, b):
    return a + b

@log("debug")
def multiply(a, b):
    return a * b

# 调用
add(2, 3)
multiply(4, 5)

输出：

[INFO] add is called with arguments (2, 3) and {}
[INFO] add returned 5
[DEBUG] multiply is called with arguments (4, 5) and {}
[DEBUG] multiply returned 20

示例 2：访问控制

通过参数化装饰器，我们可以实现访问控制。例如，只允许指定用户访问某些功能：

def access_control(allowed_user):
    def decorator(func):
        def wrapper(user, *args, **kwargs):
            if user != allowed_user:
                print(f"Access denied for user: {user}")
                return None
            print(f"Access granted for user: {user}")
            return func(*args, **kwargs)
        return wrapper
    return decorator

@access_control("admin")
def delete_database(user):
    print("Database deleted!")

# 调用
delete_database("guest")  # 输出: Access denied for user: guest
delete_database("admin")  # 输出: Access granted for user: admin
                         #       Database deleted!

参数化装饰器的常见用途

1. 日志记录：动态调整日志的输出级别或格式。
2. 权限验证：根据用户角色或权限控制函数执行。
3. 性能监控：允许通过参数控制是否启用性能监控。
4. 输入校验：根据参数动态调整校验逻辑。
5. 重试机制：实现动态的重试次数或间隔时间。

注意事项

1. 保持内层函数的签名： 如果需要保留被装饰函数的原始签名和元数据，可以使用 functools.wraps。 from functools import wraps def decorator_with_args(arg): def actual_decorator(func): @wraps(func) def wrapper(*args, **kwargs): print(f"Decorator parameter: {arg}") return func(*args, **kwargs) return wrapper return actual_decorator
2. 参数范围： 参数化装饰器的外层参数是固定的，因此它只能改变装饰器的行为，而无法动态改变函数定义。
3. 嵌套复杂性： 参数化装饰器引入了额外的函数嵌套，可能导致可读性下降。适当使用注释或简化逻辑有助于维护代码。

总结

参数化装饰器通过引入额外的参数，极大地增强了装饰器的灵活性。它们在日志记录、权限控制和动态行为调整等场景中非常实用。通过将逻辑分层设计，参数化装饰器可以轻松适应复杂的需求，同时保持代码的可复用性和清晰性。