如何使用 Python 装饰器来增强函数

Python 装饰器是一种强大而灵活的修改或增强函数和方法的方法。装饰器提供了一种用附加功能包装函数的方法，允许您扩展其行为而无需修改其实际代码。本文将向您介绍装饰器的概念、如何创建和使用它们，并探讨一些实际示例。

什么是装饰器？

装饰器是一种函数，它接受另一个函数并扩展其行为，而无需明确修改它。在 Python 中，装饰器通常用于向现有函数或方法添加日志记录、访问控制或性能测量等功能。使用 @decorator_name 语法将装饰器应用于函数。

# Basic example of a decorator
def my_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

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

say_hello()

装饰器如何工作

当将装饰器应用于函数时，Python 基本上执行以下步骤：

装饰器函数以原始函数作为其参数进行调用。
装饰器函数定义了一个新函数（通常称为 wrapper），用于增强或修改原始函数的行为。
装饰器函数返回新函数。
当调用被装饰的函数时，它实际上调用的是装饰器返回的新函数。

创建一个简单的装饰器

让我们创建一个简单的装饰器来测量函数的执行时间。这对于性能测试和优化很有用。

import time

def timing_decorator(func):
    def wrapper(*args, **kwargs):
        start_time = time.time()
        result = func(*args, **kwargs)
        end_time = time.time()
        print(f"Execution time: {end_time - start_time} seconds")
        return result
    return wrapper

@timing_decorator
def slow_function():
    time.sleep(2)
    print("Function finished!")

slow_function()

使用带参数的装饰器

有时，您可能希望将参数传递给装饰器。为此，您需要创建一个装饰器工厂 - 一个返回装饰器的函数。以下是一个接受参数来指定自定义消息的装饰器示例。

def custom_message_decorator(message):
    def decorator(func):
        def wrapper(*args, **kwargs):
            print(message)
            return func(*args, **kwargs)
        return wrapper
    return decorator

@custom_message_decorator("Starting the function...")
def greet(name):
    print(f"Hello, {name}!")

greet("Alice")

类中方法的装饰器

装饰器还可以用于类内的方法。常见用途包括记录方法调用、访问控制和缓存结果。以下是使用装饰器记录类中的方法调用的示例。

def log_method_call(method):
    def wrapper(self, *args, **kwargs):
        print(f"Calling {method.__name__} with arguments {args} and keyword arguments {kwargs}")
        return method(self, *args, **kwargs)
    return wrapper

class MyClass:
    @log_method_call
    def my_method(self, x, y):
        print(f"Result: {x + y}")

obj = MyClass()
obj.my_method(5, 7)

链接装饰器

您可以将多个装饰器应用于单个函数。它们从最内层的装饰器应用到最外层的装饰器。这允许您将不同的功能组合在一起。以下是链接两个装饰器的示例：

def uppercase_decorator(func):
    def wrapper(*args, **kwargs):
        result = func(*args, **kwargs)
        return result.upper()
    return wrapper

def exclamation_decorator(func):
    def wrapper(*args, **kwargs):
        result = func(*args, **kwargs)
        return result + "!"
    return wrapper

@exclamation_decorator
@uppercase_decorator
def greet(name):
    return f"Hello, {name}"

print(greet("Alice"))

结论

装饰器是 Python 中的一种多功能工具，可用于增强或修改函数和方法的行为。通过使用装饰器，您可以在代码库中添加可重复使用的功能，而无需更改函数的核心逻辑。无论是用于记录、计时还是修改输出，装饰器都有助于保持代码整洁且易于维护。练习使用装饰器，以提高熟练程度，并在 Python 项目中充分利用其强大功能。

python 装饰器函数增强语法包装器参数日志记录性能方法类自定义执行