使代码更简洁、更高效的基本 Python 装饰器模式

作为畅销书作家，我邀请您在亚马逊上探索我的书。不要忘记在 Medium 上关注我并表示您的支持。谢谢你！您的支持意味着全世界！

Python 装饰器是一个强大的功能，它允许我们修改或增强函数和类​​，而不改变它们的核心逻辑。作为一名开发人员，我发现掌握装饰器模式可以显着提高代码质量、可重用性和可维护性。让我们探索七种基本的装饰器模式，我发现它们在我的项目中特别有用。

类装饰器

类装饰器提供了一种修改或增强类行为和属性的方法。它们是使用类定义上方的 @decorator 语法应用的。我经常使用类装饰器来添加方法、修改现有方法或更改类属性。

这是一个向类添加新方法的类装饰器示例：

def add_greeting(cls):
    def say_hello(self):
        return f"Hello, I'm {self.name}"
    cls.say_hello = say_hello
    return cls

@add_greeting
class Person:
    def __init__(self, name):
        self.name = name

person = Person("Alice")
print(person.say_hello())  # Output: Hello, I'm Alice

在此示例中，add_greeting 装饰器向 Person 类添加了 say_hello 方法。当您想要跨多个类扩展功能而不修改其源代码时，此模式特别有用。

带参数的函数装饰器

接受参数的函数装饰器提供了更大的灵活性。它们允许我们自定义装饰器本身的行为。我发现这种模式在创建可重复使用的装饰器时非常有用，可以针对不同的用例进行微调。

这是一个可以重复函数调用指定次数的装饰器示例：

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("Bob")
# Output:
# Hello, Bob!
# Hello, Bob!
# Hello, Bob!

在此示例中，repeat 装饰器接受一个参数 times 来确定应调用装饰函数的次数。这种模式为我们如何将装饰器应用到我们的函数提供了极大的灵活性。

保留函数元数据

使用装饰器时，保留原始函数的元数据很重要。这包括函数的名称、文档字符串和其他属性。 Python 标准库中的 functools.wraps 装饰器帮助我们实现了这一点。

这是一个例子：

from functools import wraps

def my_decorator(func):
    @wraps(func)
    def wrapper(*args, **kwargs):
        """This is the wrapper function"""
        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(name):
    """This function greets someone"""
    print(f"Hello, {name}!")

say_hello("Charlie")
print(say_hello.__name__)  # Output: say_hello
print(say_hello.__doc__)   # Output: This function greets someone

通过使用@wraps(func)，我们确保包装函数采用原始函数的元数据。这对于调试和内省至关重要。

堆叠多个装饰器

装饰器可以堆叠，允许将多个装饰器应用于单个函数。装饰的顺序很重要，装饰器是从下到上应用的。

这是一个例子：

def decorator1(func):
    def wrapper(*args, **kwargs):
        print("Decorator 1")
        return func(*args, **kwargs)
    return wrapper

def decorator2(func):
    def wrapper(*args, **kwargs):
        print("Decorator 2")
        return func(*args, **kwargs)
    return wrapper

@decorator1
@decorator2
def greet(name):
    print(f"Hello, {name}!")

greet("David")
# Output:
# Decorator 1
# Decorator 2
# Hello, David!

在此示例中，首先应用decorator2，然后应用decorator1。使用多个装饰器时，理解执行顺序至关重要。

记忆装饰器

记忆化是一种优化技术，它存储昂贵的函数调用的结果，并在相同的输入再次出现时返回缓存的结果。我发现记忆装饰器对于提高递归函数或具有昂贵计算量的函数的性能非常有用。

这是记忆化装饰器的示例：

def add_greeting(cls):
    def say_hello(self):
        return f"Hello, I'm {self.name}"
    cls.say_hello = say_hello
    return cls

@add_greeting
class Person:
    def __init__(self, name):
        self.name = name

person = Person("Alice")
print(person.say_hello())  # Output: Hello, I'm Alice

这个记忆装饰器缓存斐波那契函数的结果，极大地提高了大输入的性能。

计时和记录装饰器

用于计时函数执行和记录函数调用的装饰器对于性能分析和调试非常有用。我在开发过程中经常使用这些。

这是组合计时和日志记录装饰器的示例：

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("Bob")
# Output:
# Hello, Bob!
# Hello, Bob!
# Hello, Bob!

这个装饰器记录函数何时被调用以及执行需要多长时间。我发现这种模式对于识别代码中的性能瓶颈非常有价值。

上下文管理器装饰器

上下文管理器通常与 with 语句一起使用，以进行资源管理和错误处理。我们可以创建将函数转变为上下文管理器的装饰器，从而允许优雅的设置和拆卸操作。

这是一个例子：

from functools import wraps

def my_decorator(func):
    @wraps(func)
    def wrapper(*args, **kwargs):
        """This is the wrapper function"""
        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(name):
    """This function greets someone"""
    print(f"Hello, {name}!")

say_hello("Charlie")
print(say_hello.__name__)  # Output: say_hello
print(say_hello.__doc__)   # Output: This function greets someone

在此示例中，file_manager 装饰器确保文件在操作后正确关闭，即使发生异常也是如此。

创建和使用装饰器的最佳实践

在与装饰者合作时，我学到了一些对我很有帮助的最佳实践：

1. 使用 functools.wraps 保存函数元数据。
2. 保持装饰器简单并专注于单一职责。
3. 当您需要将参数传递给装饰器时，请使用装饰器工厂。
4. 注意装饰器对性能的影响，特别是对于频繁调用的函数。
5. 清楚地记录你的装饰器，解释它们的作用以及它们可能产生的任何副作用。
6. 调试时，请记住装饰器添加了一个间接层。 Python 调试器中的 @ 语法等工具可以帮助您进入修饰函数。

测试修饰代码有时可能很棘手。我经常使用的一种方法是将装饰器与装饰函数分开测试。这允许更精细的测试和更轻松的调试。

以下是如何测试装饰器的示例：

def decorator1(func):
    def wrapper(*args, **kwargs):
        print("Decorator 1")
        return func(*args, **kwargs)
    return wrapper

def decorator2(func):
    def wrapper(*args, **kwargs):
        print("Decorator 2")
        return func(*args, **kwargs)
    return wrapper

@decorator1
@decorator2
def greet(name):
    print(f"Hello, {name}!")

greet("David")
# Output:
# Decorator 1
# Decorator 2
# Hello, David!

在此测试中，我们使用模拟函数来验证我们的装饰器是否正确调用原始函数并返回其结果。

装饰器是 Python 中的一个强大工具，掌握这些模式可以显着增强您的编码能力。它们允许干净地分离关注点，促进代码重用，并且可以使您的代码更具可读性和可维护性。

我发现有效使用装饰器的关键是从简单开始，然后根据需要逐渐增加复杂性。从基本的函数装饰器开始，然后转向类装饰器和更高级的模式，例如装饰器工厂。

请记住，虽然装饰器可以极大地改进您的代码，但应谨慎使用它们。过度使用装饰器可能会导致代码难以理解和调试。始终考虑装饰器是否是适合您的特定用例的最佳解决方案。

当您继续与装饰器合作时，您可能会发现新的模式和用例。 Python 社区不断创新，新的装饰器技术定期出现。保持好奇心，尝试不同的方法，并毫不犹豫地创建自己的装饰器模式来解决项目中的独特问题。

装饰器只是 Python 中众多强大功能之一，可以帮助您编写更干净、更高效的代码。随着您对装饰器越来越熟悉，您会发现它们与其他 Python 功能（例如生成器、上下文管理器和元类）很好地集成，为优雅而强大的代码设计开辟了更多可能性。

---

101 本书

101 Books是一家人工智能驱动的出版公司，由作家Aarav Joshi共同创立。通过利用先进的人工智能技术，我们将出版成本保持在极低的水平——一些书籍的价格低至 4 美元——让每个人都能获得高质量的知识。

查看我们的书Golang Clean Code，亚马逊上有售。

请继续关注更新和令人兴奋的消息。购买书籍时，搜索 Aarav Joshi 以查找更多我们的书籍。使用提供的链接即可享受特别折扣！

我们的创作

一定要看看我们的创作：

投资者中心 | 投资者中央西班牙语 | 投资者中德意志 | 智能生活 | 时代与回响 | 令人费解的谜团 | 印度教 | 精英开发 | JS学校

---

我们在媒体上

科技考拉洞察 | 时代与回响世界 | 投资者中央媒体 | 令人费解的谜团 | 科学与时代媒介 | 现代印度教

以上是使代码更简洁、更高效的基本 Python 装饰器模式的详细内容。更多信息请关注PHP中文网其他相关文章！