当前位置：首页 > article >正文

Python 中的装饰器是什么？

article 2024/11/28 16:41:22

装饰器是Python中一种非常强大的功能，它允许你在不修改原始函数代码的前提下，增加额外的功能或改变函数的行为。

装饰器本质上是一个接受函数作为参数的函数，并返回一个新的函数。

通过装饰器，我们可以轻松地实现诸如日志记录、性能测试、事务处理等功能。

基本概念

装饰器的核心思想是通过一个高阶函数来增强或修改另一个函数的行为。一个简单的装饰器示例如下：

def my_decorator(func):
    def wrapper():
        print("在函数执行前做一些事情")
        func()
        print("在函数执行后做一些事情")
    return wrapper

@my_decorator
def say_hello():
    print("Hello!")

say_hello()

在这个例子中，my_decorator 是一个装饰器函数，它接受一个函数 func 作为参数，并返回一个新的函数 wrapper。当我们使用 @my_decorator 装饰 say_hello 函数时，实际上是在调用 my_decorator(say_hello)，并将返回的 wrapper 函数赋值给 say_hello。

带参数的装饰器

有些情况下，我们需要传递参数给装饰器本身。这可以通过再包裹一层函数来实现：

def repeat(num_times):
    def decorator(func):
        def wrapper():
            for _ in range(num_times):
                func()
        return wrapper
    return decorator

@repeat(3)
def greet():
    print("你好！")

greet()

在这个例子中，repeat 是一个接受参数 num_times 的函数，它返回一个真正的装饰器 decorator。decorator 接受函数 func 作为参数，并返回一个新的函数 wrapper。wrapper 函数会在调用 func 时重复执行 num_times 次。

装饰带有参数的函数

如果被装饰的函数本身带有参数，我们需要在 wrapper 函数中传递这些参数：

def log_function_call(func):
    def wrapper(*args, **kwargs):
        print(f"调用函数 {func.__name__}，参数为：{args}, {kwargs}")
        result = func(*args, **kwargs)
        print(f"函数 {func.__name__} 返回值为：{result}")
        return result
    return wrapper

@log_function_call
def add(a, b):
    return a + b

result = add(3, 4)
print(f"结果是：{result}")

在这个例子中，log_function_call 装饰器会在调用 add 函数前后打印相关信息。wrapper 函数使用 *args 和 **kwargs 来接收任意数量的位置参数和关键字参数，并将它们传递给 func。

使用内置装饰器

Python 提供了一些内置的装饰器，如 @staticmethod、@classmethod 和 @property，这些装饰器用于修改类方法的行为：

class MyClass:
    @staticmethod
    def static_method():
        print("这是一个静态方法")

    @classmethod
    def class_method(cls):
        print(f"这是一个类方法，类名是 {cls.__name__}")

    @property
    def prop(self):
        return "这是一个属性"

MyClass.static_method()
MyClass.class_method()
obj = MyClass()
print(obj.prop)

日常开发中的使用建议

保持装饰器简单：装饰器应该尽量保持简单，只做一件事情。复杂的逻辑应该放在被装饰的函数中。

使用 functools.wraps：为了保持被装饰函数的元数据（如函数名、文档字符串等），可以使用 functools.wraps：

from functools import wraps

def my_decorator(func):
    @wraps(func)
    def wrapper(*args, **kwargs):
        print("在函数执行前做一些事情")
        result = func(*args, **kwargs)
        print("在函数执行后做一些事情")
        return result
    return wrapper

@my_decorator
def say_hello():
    """这是一个打招呼的函数"""
    print("Hello!")

print(say_hello.__name__)  # 输出: say_hello
print(say_hello.__doc__)   # 输出: 这是一个打招呼的函数