Python Decorators进阶秘籍：打造自定义装饰器的6大策略

# 1. Python Decorators概念解析

装饰器是Python中一个强大的特性，它允许我们以非侵入式的方式修改或增强函数的行为。在深入探讨自定义装饰器之前，让我们先理解装饰器的基本概念。

## 1.1 什么是装饰器？

装饰器本质上是一个Python函数，它接受另一个函数作为参数并返回一个新函数。这个新函数通常会包含原函数的一些附加功能，而无需修改原函数的代码。

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()

在上面的代码中，`my_decorator` 就是一个装饰器，它在`say_hello`函数执行前后添加了额外的打印语句。使用`@my_decorator`语法糖可以简洁地将装饰器应用于函数。

## 1.2 装饰器的应用场景

装饰器广泛应用于日志记录、权限验证、性能监测等场景。它们可以极大地减少代码冗余，提高代码的可读性和可维护性。

- **日志记录**：在函数调用前后添加日志记录语句，帮助追踪程序执行流程。
- **权限验证**：在执行函数前检查用户权限，确保安全性。
- **性能监测**：测量函数执行时间，帮助分析性能瓶颈。

通过这些例子，我们可以看到装饰器在提升代码复用性和维护性方面的巨大潜力。接下来的章节将深入探讨如何创建和优化自定义装饰器。

# 2. 自定义装饰器的基本原理

## 2.1 装饰器的核心机制

### 2.1.1 函数作为一等公民

在Python中，函数是一等公民，这意味着函数可以被赋值给变量，作为参数传递给其他函数，以及从其他函数返回。这一特性为装饰器的实现提供了基础。装饰器本质上是一个接收函数作为参数并返回一个新函数的高阶函数。这种机制允许我们在不修改原始函数代码的情况下，增加额外的功能。

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

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

# 将装饰器应用于函数
say_hello = my_decorator(say_hello)

# 调用装饰后的函数
say_hello()

在这个例子中，`my_decorator` 接受一个函数 `func` 作为参数，并返回一个新的函数 `wrapper`。`wrapper` 在 `func` 执行前后添加了额外的行为。这种方式使得我们可以动态地修改函数的行为，而不需要修改函数的原始定义。

### 2.1.2 高阶函数的使用

高阶函数是指至少满足下列一个条件的函数：

- 接受一个或多个函数作为输入
- 输出一个函数

装饰器是一个典型的高阶函数，它接受一个函数作为输入，并输出一个新的函数。这种机制使得装饰器能够修改函数的行为，而不需要修改原始函数的代码。

def apply_twice(func):
    def wrapper(arg):
        func(arg)
        return func(arg)
    return wrapper

def shout(text):
    return text.upper()

# 将装饰器应用于函数
shout_twice = apply_twice(shout)

# 调用装饰后的函数
print(shout_twice('hello'))

在这个例子中，`apply_twice` 是一个高阶函数，它接受一个函数 `func` 作为输入，并返回一个新的函数 `wrapper`，该函数调用 `func` 两次。

## 2.2 创建简单的装饰器

### 2.2.1 理解@语法糖

Python提供了一种方便的语法糖 `@decorator_name` 来应用装饰器。这个语法糖等同于 `my_function = decorator_name(my_function)`。

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()

在这个例子中，`@my_decorator` 语法糖自动将 `say_hello` 函数作为参数传递给 `my_decorator` 装饰器。

### 2.2.2 实现第一个装饰器

通过理解装饰器的工作原理，我们可以实现一个简单的装饰器，例如一个记录函数执行时间的装饰器。

import time

def timer(func):
    def wrapper(*args, **kwargs):
        start_time = time.time()
        result = func(*args, **kwargs)
        end_time = time.time()
        print(f"Function {func.__name__!r} executed in {end_time - start_time:.4f}s")
        return result
    return wrapper

@timer
def sleep_some_time():
    time.sleep(2)
    print("Done sleeping")

# 调用装饰后的函数
sleep_some_time()

在这个例子中，`timer` 装饰器记录了 `sleep_some_time` 函数的执行时间，并在控制台打印出来。

## 2.3 装饰器的参数化

### 2.3.1 接受参数的装饰器

有时候，我们需要创建一个可以接受参数的装饰器。这可以通过定义一个装饰器工厂函数来实现，该工厂函数返回一个装饰器。

def repeat(times):
    def decorator_repeat(func):
        def wrapper(*args, **kwargs):
            for _ in range(times):
                result = func(*args, **kwargs)
            return result
        return wrapper
    return decorator_repeat

@repeat(times=3)
def greet(name):
    print(f"Hello {name}")

# 调用装饰后的函数
greet("Alice")

在这个例子中，`repeat` 是一个装饰器工厂函数，它接受一个参数 `times` 并返回一个装饰器 `decorator_repeat`。这个装饰器 `decorator_repeat` 本身是一个接受函数 `func` 作为参数的高阶函数。

### 2.3.2 使用 functools.wraps 保留原函数信息

在装饰器中使用 `functools.wraps` 是一个好习惯，它可以保留原始函数的元数据，如函数名和文档字符串。

from functools import wraps

def my_decorator(func):
    @wraps(func)
    def wrapper(*args, **kwargs):
        print("Something is happening before the function is called.")
        result = func(*args, **kwargs)
        print("Something is happening after the function is called.")
        return result
    return wrapper

@my_decorator
def say_hello():
    """Greet the user."""
    print("Hello!")

print(say_hello.__name__)  # 输出: say_hello
print(say_hello.__doc__)   # 输出: Greet the user.

在这个例子中，`@wraps(func)` 装饰器应用于 `wrapper` 函数，保留了 `say_hello` 函数的名称和文档字符串。

# 3. 打造自定义装饰器的六大策略

在本章节中，我们将深入探讨自定义装饰器的六大策略，这些策略将帮助我们更好地理解和应用装饰器模式。我们将从状态保持策略开始，逐步深入到参数化装饰器，以及如何实现装饰器的叠加。每个策略都会通过实际的例子和详细的解释来展示其应用和效果。

## 3.1 状态保持策略

### 3.1.1 使用闭包捕获状态

闭包是Python中一个强大的特性，它允许一个函数返回另一个函数，并且这个返回的函数能够访问到其外部函数的变量。这种特性在创建装饰器时非常有用，因为它可以用来保持状态。

def count_calls(func):
    def wrapper(*args, **kwargs):
        wrapper.calls += 1
        print(f"Call {wrapper.calls} of {func.__name__!r}")
        return func(*args, **kwargs)
    wrapper.calls = 0
    return wrapper

@count_calls
def say_hello(name):
    print(f"Hello, {name}!")

say_hello("Alice")
say_hello("Bob")

在上述代码中，`count_calls`装饰器通过闭包保持了一个状态`calls`，这个状态记录了函数被调用的次数。每次调用`wrapper`函数时，都会增加`calls`的值。

### 3.1.2 利用类实例存储状态

另一种保持状态的方式是使用类实例。类实例可以存储任意数据，并且可以通过方法来修改这些数据。

class CountCalls:
    def __init__(self, func):
        self.func = func
        self.calls = 0

    def __call__(self, *args, **kwargs):
        self.calls += 1
        print(f"Call {self.calls} of {self.func.__name__!r}")
        return self.func(*args, **kwargs)

@CountCalls
def say_hello(name):
    print(f"Hello, {name}!")

say_hello("Alice")
say_hello("Bob")

在这个例子中，`CountCalls`类在初始化时接收一个函数，并存储为实例变量。每次调用`say_hello`时，都会通过`CountCalls`类的`__call__`方法来调用原函数，并更新`calls`计数。

## 3.2 参数化装饰器

### 3.2.1 增强装饰器灵活性

参数化装饰器可以接收参数，并将这些参数传递给内部的包装函数。这使得装饰器更加灵活和通用。

def repeat(times):
    def decorator(func):
        def wrapper(*args, **kwargs):
            for _ in range(times):
                result = func(*args, **kwargs)
            return result
        return wrapper
    return decorator

@repeat(times=3)
def greet(name):
    print(f"Hello, {name}!")

greet("Alice")

在这个例子中，`repeat`装饰器接收一个参数`times`，并将其传递给内部的`decorator`函数。`decorator`函数再将其传递给`wrapper`函数，从而实现多次调用原函数的功能。

### 3.2.2 应用场景分析

参数化装饰器在许多场景中都非常有用，例如：

- 限制函数的执行次数
- 执行前和执行后的日志记录
- 缓存函数结果

这些场景都需要根据不同的需求来定制装饰器的行为，参数化装饰器正是为此而生。

## 3.3 装饰器的叠加

### 3.3.1 多层装饰器的应用

装饰器可以叠加使用，这意味着我们可以将多个装饰器应用于同一个函数。Python会从最后一个装饰器开始应用，逐层向外。

def debug(func):
    def wrapper(*args, **kwargs):
        args_repr = [repr(a) for a in args]
        kwargs_repr = [f"{k}={v!r}" for k, v in kwargs.items()]
        signature = ", ".join(args_repr + kwargs_repr)
        print(f"Calling {func.__name__}({signature})")
        result = func(*args, **kwargs)
        print(f"{func.__name__!r} returned {result!r}")
        return result
    return wrapper

def slow_down(func):
    def wrapper(*args, **kwargs):
        time.sleep(1)
        return func(*args, **kwargs)
    return wrapper

@slow_down
@debug
def say_hello(name):
    time.sleep(2)
    print(f"Hello, {name}!")

say_hello("Alice")

在这个例子中，`say_hello`函数被两个装饰器`debug`和`slow_down`装饰。首先，`slow_down`装饰器被应用，然后是`debug`装饰器。因此，当我们调用`say_hello("Alice")`时，首先会看到慢速执行的输出，然后是调试信息。

### 3.3.2 装饰器链的控制流

理解装饰器链的控制流对于编写复杂的装饰器逻辑至关重要。每个装饰器都应该有一个清晰的入口和出口，以便正确地控制函数的执行流程。

graph TD
A[函数调用] -->|调用| B(装饰器1)
B -->|执行| C(装饰器2)
C -->|执行| D(装饰器3)
D -->|返回| E[函数执行]
E -->|返回| C
C -->|返回| B
B -->|返回| A

在上述Mermaid流程图中，我们可以看到装饰器链的控制流是如何工作的。每个装饰器在执行完自己的逻辑后，将控制权返回给上一个装饰器，最终返回给原始函数调用。这种模式使得装饰器链能够保持正确的执行顺序。

在本章节中，我们介绍了自定义装饰器的三大策略：状态保持、参数化以及装饰器的叠加。每种策略都有其独特的用途和应用场景。通过具体的例子和代码分析，我们展示了如何实现和应用这些策略。在下一章节中，我们将继续深入探讨高级装饰器的实战应用，包括日志记录、缓存策略和异常处理等。

# 4. 高级装饰器实战应用

## 4.1 日志记录装饰器

### 4.1.1 实现基本的日志记录

在软件开发中，日志记录是一种常见的需求，它可以帮助开发者追踪程序的运行情况，快速定位和解决问题。使用装饰器实现日志记录是一种优雅的方式，它可以将日志记录的逻辑与业务逻辑分离，提高代码的可读性和可维护性。

首先，我们创建一个简单的日志记录装饰器，它可以捕获函数的调用信息，并将其记录到日志文件中。这里我们使用Python标准库中的`logging`模块来处理日志记录。

import logging
from functools import wraps

# 设置日志的基本配置
logging.basicConfig(level=***, filename='app.log', filemode='a')

def log_decorator(func):
    @wraps(func)
    def wrapper(*args, **kwargs):
        ***(f"Function '{func.__name__}' is called with args: {args} and kwargs: {kwargs}")
        result = func(*args, **kwargs)
        ***(f"Function '{func.__name__}' returned {result}")
        return result
    return wrapper

@log_decorator
def add(x, y):
    return x + y

# 测试日志记录装饰器
add(1, 2)

在上述代码中，我们定义了一个名为`log_decorator`的装饰器，它接受一个函数`func`作为参数，并返回一个新的函数`wrapper`。`wrapper`函数会在被装饰函数调用前后分别记录日志信息。我们使用`logging`模块的`info`方法来记录信息，并通过`@wraps`装饰器保留了被装饰函数的元数据。

### 4.1.2 集成日志系统

在实际应用中，日志系统可能需要更复杂的配置，比如日志的格式化、不同的日志级别、多个日志处理器等。我们可以进一步扩展我们的日志记录装饰器，以支持这些高级特性。

import logging
from functools import wraps

# 创建一个日志器
logger = logging.getLogger('myapp')
logger.setLevel(***)

# 创建一个日志文件处理器
file_handler = logging.FileHandler('app.log')
file_handler.setLevel(***)

# 创建一个控制台处理器
console_handler = logging.StreamHandler()
console_handler.setLevel(***)

# 创建一个日志格式化器
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
file_handler.setFormatter(formatter)
console_handler.setFormatter(formatter)

# 将处理器添加到日志器
logger.addHandler(file_handler)
logger.addHandler(console_handler)

def log_decorator(func):
    @wraps(func)
    def wrapper(*args, **kwargs):
        ***(f"Function '{func.__name__}' is called with args: {args} and kwargs: {kwargs}")
        result = func(*args, **kwargs)
        ***(f"Function '{func.__name__}' returned {result}")
        return result
    return wrapper

@log_decorator
def add(x, y):
    return x + y

# 测试集成日志系统的装饰器
add(1, 2)

在这个扩展版本中，我们创建了一个日志器`logger`，并为其添加了两个处理器：`file_handler`用于写入日志文件，`console_handler`用于在控制台输出日志。我们还定义了一个日志格式化器`formatter`，用于格式化日志信息。这样，我们的日志记录装饰器就可以将日志同时输出到文件和控制台，并且具有时间戳、日志级别和日志消息的详细信息。

通过本章节的介绍，我们展示了如何使用装饰器来实现基本和高级的日志记录功能。这不仅提高了代码的可读性和可维护性，还提供了灵活的日志配置选项。在下一节中，我们将探讨如何使用装饰器实现函数缓存，以提高程序的性能。

# 5. 装饰器的性能考量

在本章节中，我们将深入探讨装饰器对代码性能的影响，包括性能影响的原因分析以及优化策略。此外，我们还将讨论装饰器的内存占用问题和并发安全的重要性。通过本章节的介绍，你将能够理解如何编写高性能且安全的装饰器。

## 5.1 装饰器的性能影响

装饰器在提升代码复用性的同时，可能会对性能造成一定的影响。我们将从两个方面来分析装饰器如何影响函数性能，以及如何优化装饰器以减少性能开销。

### 5.1.1 装饰器对函数性能的影响

装饰器通过包装原始函数来扩展其功能，这一过程会在函数调用时引入额外的计算。例如，一个简单的日志装饰器可能会在每次函数调用时记录日志，这将比直接调用原函数花费更多的时间。

import time

def timer_decorator(func):
    def wrapper(*args, **kwargs):
        start_time = time.time()
        result = func(*args, **kwargs)
        end_time = time.time()
        print(f"Function {func.__name__} took {end_time - start_time}s to execute")
        return result
    return wrapper

@timer_decorator
def slow_function(delay):
    time.sleep(delay)
    return "Done"

slow_function(3)

在上述代码中，`timer_decorator` 装饰器会在被装饰的函数执行前后添加计时功能。虽然这增加了功能性，但也会引入性能开销。

### 5.1.2 优化装饰器性能的方法

为了优化装饰器的性能，我们可以采取以下策略：

- **使用内置函数和模块：** 减少装饰器内部不必要的计算和资源消耗。
- **缓存装饰器：** 对于无状态且不经常改变的函数，使用缓存装饰器可以避免重复计算。
- **延迟装饰器应用：** 只有在必要时才应用装饰器，例如在生产环境中。

from functools import lru_cache

@lru_cache(maxsize=None)
def expensive_function(x):
    # 这是一个计算密集型函数
    return x * x

# 只有首次调用时会进行计算，之后调用会直接从缓存中获取结果
expensive_function(100)
expensive_function(100)

在上述代码中，`lru_cache` 装饰器用于缓存函数的返回值，从而减少了重复计算的性能开销。

## 5.2 装饰器的内存占用

装饰器可能会导致内存占用增加，尤其是在使用闭包的情况下。我们将分析闭包的内存占用，并提供减少内存占用的技巧。

### 5.2.1 分析闭包的内存占用

闭包在Python中是非常有用的特性，但它们也会增加内存的使用。闭包会保持对外部变量的引用，即使这些变量在其他地方不再需要。

def make_multiplier_of(n):
    def multiplier(x):
        return x * n
    return multiplier

# 创建两个闭包实例
mult3 = make_multiplier_of(3)
mult5 = make_multiplier_of(5)

print(mult3.__closure__[0].cell_contents)  # 输出 3
print(mult5.__closure__[0].cell_contents)  # 输出 5

在上述代码中，每个闭包实例都保持了对外部变量 `n` 的引用，即使 `make_multiplier_of` 函数已经返回。

### 5.2.2 减少内存占用的技巧

为了减少内存占用，可以采取以下措施：

- **避免不必要的闭包引用：** 及时释放不再使用的闭包引用。
- **使用类实例代替闭包：** 类实例不会保持对所有外部变量的引用，从而减少内存占用。

class Multiplier:
    def __init__(self, n):
        self.n = n

    def __call__(self, x):
        return x * self.n

mult3 = Multiplier(3)
mult5 = Multiplier(5)

print(mult3.n)  # 输出 3
print(mult5.n)  # 输出 5

在上述代码中，我们使用类实例来代替闭包，这样可以更灵活地管理内存。

## 5.3 装饰器的并发安全

在多线程环境中，装饰器可能会导致线程安全问题。我们将讨论如何实现线程安全的装饰器。

### 5.3.1 线程安全问题

线程安全问题通常发生在多个线程访问和修改共享资源时。装饰器可能会在多个线程之间共享状态，从而导致数据不一致。

import threading

counter = 0

def increment():
    global counter
    counter += 1

def thread_task():
    for _ in range(1000):
        increment()

threads = [threading.Thread(target=thread_task) for _ in range(10)]
for thread in threads:
    thread.start()

for thread in threads:
    thread.join()

print(counter)  # 输出通常小于 10000

在上述代码中，`increment` 函数在多个线程中被调用，但由于缺乏同步机制，最终的 `counter` 值通常小于预期。

### 5.3.2 实现线程安全的装饰器

为了实现线程安全的装饰器，我们可以使用锁来同步线程对共享资源的访问。

import threading

counter = 0
counter_lock = threading.Lock()

def thread_safe_increment():
    global counter
    with counter_lock:
        counter += 1

def thread_task():
    for _ in range(1000):
        thread_safe_increment()

threads = [threading.Thread(target=thread_task) for _ in range(10)]
for thread in threads:
    thread.start()

for thread in threads:
    thread.join()

print(counter)  # 输出 10000

在上述代码中，我们使用 `threading.Lock()` 来确保每次只有一个线程可以修改 `counter` 变量。这解决了线程安全问题，并确保最终的 `counter` 值为 10000。

通过本章节的介绍，我们了解了装饰器对性能的影响，包括性能影响的原因分析以及优化策略。此外，我们还探讨了装饰器的内存占用问题和并发安全的重要性。在下一章节中，我们将讨论如何对装饰器进行单元测试以及最佳实践。

# 6. 装饰器的测试和最佳实践

装饰器作为一种强大的代码复用工具，在Python编程中扮演着重要角色。然而，随着代码库的增长，装饰器的正确性、性能和文档变得尤为重要。在本章中，我们将深入探讨如何对装饰器进行单元测试、设计模式以及如何编写有效的文档和注释。

## 6.1 装饰器的单元测试

装饰器的单元测试是确保装饰器按预期工作的重要步骤。它不仅需要测试装饰器的核心逻辑，还需要测试装饰器可能产生的副作用。

### 6.1.1 测试装饰器的逻辑

为了测试装饰器的逻辑，我们可以编写测试用例来检查装饰器的行为是否符合我们的预期。以下是一个简单的示例，展示了如何测试一个简单的日志记录装饰器：

import unittest

def log_decorator(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

class TestLogDecorator(unittest.TestCase):
    def test_log_decorator(self):
        @log_decorator
        def add(x, y):
            return x + y

        captured_output = io.StringIO()
        sys.stdout = captured_output
        add(2, 3)
        sys.stdout = sys.__stdout__
        expected_output = (
            f"Calling add with (2, 3) and {{}}\n"
            f"add returned 5\n"
        )
        assert captured_output.getvalue() == expected_output

# 运行测试
if __name__ == '__main__':
    unittest.main()

在这个例子中，我们首先定义了一个简单的日志记录装饰器`log_decorator`，它会打印出函数调用信息和返回值。然后，我们创建了一个`TestLogDecorator`测试类，它继承自`unittest.TestCase`。在这个类中，我们定义了一个测试方法`test_log_decorator`，它使用`unittest`模块的功能来捕获输出并验证是否与预期相符。

### 6.1.2 测试装饰器的副作用

装饰器可能会引入副作用，比如修改全局变量或产生异常。因此，测试这些副作用也是至关重要的。以下是一个测试装饰器副作用的示例：

def exception_decorator(func):
    def wrapper(*args, **kwargs):
        try:
            return func(*args, **kwargs)
        except Exception as e:
            raise RuntimeError(f"Error in {func.__name__}: {str(e)}")
    return wrapper

class TestExceptionDecorator(unittest.TestCase):
    def test_exception_decorator(self):
        @exception_decorator
        def raise_exception():
            raise ValueError("Test exception")

        with self.assertRaises(RuntimeError) as context:
            raise_exception()

        self.assertIn("Error in raise_exception: Test exception", str(context.exception))

# 运行测试
if __name__ == '__main__':
    unittest.main()

在这个例子中，我们定义了一个装饰器`exception_decorator`，它会在函数抛出异常时捕获它并抛出一个新的异常。我们的测试类`TestExceptionDecorator`中的`test_exception_decorator`方法测试了这个装饰器是否正确地捕获并抛出了新的异常。

## 6.2 装饰器的设计模式

装饰器模式是一种结构型设计模式，它允许用户在不修改现有对象代码的情况下为对象添加新的功能。这种模式在Python中通过装饰器轻松实现。

### 6.2.1 装饰器模式的引入

装饰器模式通常用于在运行时为对象动态添加额外的责任或行为。在Python中，装饰器可以作为函数或类实现，它们可以包装其他函数或类，为它们添加新的功能。

### 6.2.2 装饰器模式与传统编程方式的比较

相比于传统的继承方式，装饰器模式提供了更大的灵活性和可维护性。它允许我们在不创建子类的情况下增强对象的功能，并且可以轻松地堆叠多个装饰器，为对象添加多个不同的行为。

class MyClass:
    def __init__(self, value):
        self.value = value

# 使用装饰器模式增强MyClass的功能
@decorator_with_behavior_one
@decorator_with_behavior_two
def MyClass(*args, **kwargs):
    instance = original_MyClass(*args, **kwargs)
    # ...增强行为...
    return instance

# 使用增强后的类
my_instance = MyClass(10)

在上面的例子中，我们使用了两个装饰器`decorator_with_behavior_one`和`decorator_with_behavior_two`来增强`MyClass`的功能。这种方式比传统的继承更为灵活，因为我们可以在不修改`MyClass`的情况下，为它添加任何数量的行为。

## 6.3 装饰器的文档和注释

良好的文档和注释是维护任何代码库的关键部分，装饰器也不例外。正确地记录装饰器的功能和使用方法对于开发者理解和正确使用装饰器至关重要。

### 6.3.1 装饰器文档的重要性

装饰器文档应该清晰地说明装饰器的作用、它接受的参数（如果有的话）、以及它如何改变被装饰函数的行为。这有助于其他开发者理解装饰器的目的和用途。

### 6.3.2 编写清晰的装饰器文档和注释

装饰器的文档应该使用标准的Python文档字符串（docstrings）格式编写。此外，如果装饰器有特定的使用条件或依赖关系，这些也应该在文档中明确指出。

def debug_decorator(func):
    """A decorator for debugging a function call.

    This decorator prints out the function's arguments, the return value,
    and any exception raised during the function call.

    Args:
        func (callable): The function to be decorated.

    Returns:
        callable: The decorated function.
    """

    def wrapper(*args, **kwargs):
        try:
            result = func(*args, **kwargs)
            print(f"{func.__name__} returned {result}")
            return result
        except Exception as e:
            print(f"{func.__name__} raised an exception: {e}")
            raise

    return wrapper

在上面的例子中，我们使用了三引号字符串来定义装饰器的文档字符串。这个文档字符串不仅描述了装饰器的作用，还说明了它如何改变被装饰函数的行为，并指出了任何潜在的异常处理。

通过遵循以上的方法，我们可以确保装饰器的测试、设计模式和文档是清晰、有效和易于理解的。这将有助于提高代码库的可维护性和可扩展性。