python装饰器如何获得函数的参数

Python装饰器可以通过使用args和kwargs参数获得被装饰函数的参数、使用functools.wraps保留被装饰函数的元数据、通过内嵌函数访问外部函数的变量*。通过这些方法，装饰器不仅可以灵活地访问和操作被装饰函数的参数，还能确保函数的元数据（如名称、文档字符串）不被丢失。在实际应用中，这种技术可以用来记录函数调用、验证参数、缓存结果等，极大地增强了函数的功能和可维护性。

为了更深入地理解这一点，让我们详细说明其中一个重要的方法：使用args和kwargs参数*。

当你创建一个装饰器时，你通常会定义一个嵌套函数，这个嵌套函数接收任意数量的位置参数和关键字参数。通过这种方式，装饰器可以捕获所有传递给被装饰函数的参数，并在调用被装饰函数时将这些参数传递过去。这种技术确保了装饰器的通用性和灵活性，因为它能够处理各种不同的函数签名。

例如：

from functools import wraps
def my_decorator(func):
    @wraps(func)
    def wrapper(*args, kwargs):
        print(f"Arguments were: {args}, {kwargs}")
        return func(*args, kwargs)
    return wrapper
@my_decorator
def example_function(a, b, c):
    return a + b + c
example_function(1, 2, 3)

在这个例子中，wrapper函数捕获了传递给example_function的所有参数，并在调用example_function之前打印这些参数。这样，装饰器就可以访问和操作被装饰函数的参数。

接下来，我们将进一步探讨Python装饰器的工作机制，并探讨一些高级用例。

一、什么是装饰器？

装饰器是Python中一个非常强大的功能，它允许你在不修改原函数代码的前提下，动态地添加功能。这种特性使得装饰器在编写可重用代码方面非常有用。装饰器本质上是一个返回函数的函数。

例如：

def simple_decorator(func):
    def wrapper():
        print("Something is happening before the function is called.")
        func()
        print("Something is happening after the function is called.")
    return wrapper
@simple_decorator
def say_hello():
    print("Hello!")
say_hello()

在这个例子中，simple_decorator是一个装饰器，它在say_hello函数的调用前后添加了一些行为。

二、装饰器的基本用法

1、捕获参数

要捕获被装饰函数的参数，你可以使用*args和kwargs。这些特殊符号允许你捕获任意数量的位置参数和关键字参数。

def my_decorator(func):
    def wrapper(*args, kwargs):
        print(f"Arguments were: {args}, {kwargs}")
        return func(*args, kwargs)
    return wrapper
@my_decorator
def example_function(a, b, c):
    return a + b + c
example_function(1, 2, 3)

在这个例子中，wrapper函数捕获了传递给example_function的所有参数，并在调用example_function之前打印这些参数。

2、保留元数据

当你使用装饰器时，被装饰函数的元数据（如名称、文档字符串）可能会丢失。为了保留这些元数据，你可以使用functools.wraps。

from functools import wraps
def my_decorator(func):
    @wraps(func)
    def wrapper(*args, kwargs):
        print(f"Arguments were: {args}, {kwargs}")
        return func(*args, kwargs)
    return wrapper
@my_decorator
def example_function(a, b, c):
    """This is an example function"""
    return a + b + c
print(example_function.__name__)
print(example_function.__doc__)

在这个例子中，wraps装饰器确保了example_function的名称和文档字符串在装饰后仍然可用。

三、实际应用中的高级用例

1、记录函数调用

装饰器可以用来记录函数的调用，例如，记录函数的输入和输出。这在调试和性能分析中非常有用。

from functools import wraps
def log_calls(func):
    @wraps(func)
    def wrapper(*args, kwargs):
        print(f"Calling {func.__name__} with {args} and {kwargs}")
        result = func(*args, kwargs)
        print(f"{func.__name__} returned {result}")
        return result
    return wrapper
@log_calls
def add(a, b):
    return a + b
add(2, 3)

在这个例子中，log_calls装饰器记录了add函数的调用及其返回值。

2、验证参数

装饰器还可以用来验证函数的参数，例如，检查参数是否符合预期的类型或值。

from functools import wraps
def validate_args(func):
    @wraps(func)
    def wrapper(*args, kwargs):
        if not all(isinstance(arg, int) for arg in args):
            raise ValueError("All arguments must be integers")
        return func(*args, kwargs)
    return wrapper
@validate_args
def multiply(a, b):
    return a * b
multiply(2, 3)

在这个例子中，validate_args装饰器确保multiply函数的所有参数都是整数。

3、缓存结果

装饰器还可以用来缓存函数的结果，以提高性能。这在计算成本高昂的函数中尤其有用。

from functools import wraps
def cache(func):
    _cache = {}
    @wraps(func)
    def wrapper(*args, kwargs):
        key = (args, tuple(sorted(kwargs.items())))
        if key in _cache:
            return _cache[key]
        result = func(*args, kwargs)
        _cache[key] = result
        return result
    return wrapper
@cache
def fibonacci(n):
    if n in (0, 1):
        return n
    return fibonacci(n - 1) + fibonacci(n - 2)
print(fibonacci(10))

在这个例子中，cache装饰器缓存了fibonacci函数的结果，从而避免了重复计算。

四、装饰器的嵌套使用

你可以将多个装饰器应用于同一个函数，从而组合多个功能。装饰器的应用顺序是自下而上，即最靠近函数的装饰器最先应用。

from functools import wraps
def decorator1(func):
    @wraps(func)
    def wrapper(*args, kwargs):
        print("Decorator 1")
        return func(*args, kwargs)
    return wrapper
def decorator2(func):
    @wraps(func)
    def wrapper(*args, kwargs):
        print("Decorator 2")
        return func(*args, kwargs)
    return wrapper
@decorator1
@decorator2
def say_hello():
    print("Hello!")
say_hello()

在这个例子中，decorator2首先应用，然后是decorator1。

五、类装饰器

除了函数装饰器，Python还支持类装饰器。类装饰器是一个实现了__call__方法的类。

class MyDecorator:
    def __init__(self, func):
        self.func = func
    def __call__(self, *args, kwargs):
        print(f"Arguments were: {args}, {kwargs}")
        return self.func(*args, kwargs)
@MyDecorator
def example_function(a, b, c):
    return a + b + c
example_function(1, 2, 3)

在这个例子中，MyDecorator类捕获了传递给example_function的所有参数，并在调用example_function之前打印这些参数。

六、参数化装饰器

有时，你可能希望装饰器接受参数。你可以通过定义一个返回装饰器的函数来实现这一点。

def repeat(n):
    def decorator(func):
        def wrapper(*args, kwargs):
            for _ in range(n):
                result = func(*args, kwargs)
            return result
        return wrapper
    return decorator
@repeat(3)
def say_hello():
    print("Hello!")
say_hello()