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

一、使用*args和kwargs

当编写装饰器时，最简单的方法是使用*args和kwargs来捕获传递给被装饰函数的所有参数和关键字参数。以下是一个示例：

import functools

def my_decorator(func):
    @functools.wraps(func)
    def wrapper(*args, kwargs):
        print("Positional arguments:", args)
        print("Keyword arguments:", kwargs)
        result = func(*args, kwargs)
        return result
    return wrapper
@my_decorator
def greet(name, age=None):
    if age:
        print(f"Hello {name}, you are {age} years old.")
    else:
        print(f"Hello {name}!")
greet("Alice", age=30)

在这个示例中，装饰器my_decorator捕获了传递给greet函数的参数和关键字参数，并在调用原始函数之前打印它们。

二、利用functools.wraps保持原函数签名

当编写装饰器时，使用functools.wraps来装饰内部的包装函数是一个好习惯，这样可以保持原始函数的签名和文档字符串。functools.wraps的使用在上面的示例中已经展示。

三、解析函数签名

在某些情况下，您可能希望更详细地解析函数的参数。Python的inspect模块提供了这种功能。以下是一个示例：

import inspect

def my_decorator(func):
    @functools.wraps(func)
    def wrapper(*args, kwargs):
        signature = inspect.signature(func)
        bound_arguments = signature.bind(*args, kwargs)
        bound_arguments.apply_defaults()
        print("Arguments:", bound_arguments.arguments)
        result = func(*args, kwargs)
        return result
    return wrapper
@my_decorator
def greet(name, age=None):
    if age:
        print(f"Hello {name}, you are {age} years old.")
    else:
        print(f"Hello {name}!")
greet("Alice", age=30)

在这个示例中，装饰器使用inspect.signature来获取被装饰函数的签名，并使用bind方法将传递的参数绑定到签名上。这使得我们可以更详细地访问每个参数的名称和值。

四、实际应用

1、记录函数调用

一种常见的使用场景是记录函数的调用，包括其参数和值。以下是一个示例：

import logging

logging.basicConfig(level=logging.INFO)
def log_decorator(func):
    @functools.wraps(func)
    def wrapper(*args, kwargs):
        logging.info(f"Calling {func.__name__} with args: {args} and kwargs: {kwargs}")
        result = func(*args, kwargs)
        logging.info(f"{func.__name__} returned {result}")
        return result
    return wrapper
@log_decorator
def multiply(a, b):
    return a * b
multiply(2, 3)

2、验证参数

您还可以使用装饰器来验证传递给函数的参数。例如：

def validate_decorator(func):

    @functools.wraps(func)
    def wrapper(*args, kwargs):
        if 'age' in kwargs and kwargs['age'] < 0:
            raise ValueError("Age cannot be negative")
        return func(*args, kwargs)
    return wrapper
@validate_decorator
def create_user(name, age):
    print(f"User {name} of age {age} created.")
create_user("Alice", age=25)
create_user("Bob", age=-5)  # This will raise ValueError

五、总结

通过使用*args和kwargs捕获参数、利用functools.wraps保持函数签名、使用inspect模块解析函数签名，可以在装饰器中方便地获取和处理传递给函数的参数。这些方法使得装饰器在进行参数记录、验证和其他复杂操作时变得更加灵活和强大。

相关问答FAQs：

如何在Python装饰器中获取被装饰函数的参数？
在Python中，装饰器可以通过在内部函数中使用*args和**kwargs来获取被装饰函数的参数。这种方式允许你接受任意数量的位置参数和关键字参数，从而灵活地处理不同的函数调用。

使用装饰器时，参数传递会影响性能吗？
一般情况下，使用装饰器所带来的性能开销是微乎其微的。装饰器的主要目的是增强函数功能或添加额外的逻辑。对于大多数应用而言，这种开销可以忽略不计，但在性能敏感的场景中，建议进行基准测试以评估影响。

装饰器可以应用于类方法吗？
是的，装饰器不仅可以用于普通函数，也可以应用于类的方法。当装饰器应用于类方法时，可以通过self参数来访问类实例。需要确保装饰器能够处理实例方法的调用方式，以保持功能的一致性。