巧用9个Python内置装饰器，大幅优化代码（上）

本文链接：https://blog.csdn.net/Z4400840/article/details/137673040

本文介绍了Python中的五个关键装饰器，包括加速函数的lru_cache、简化排序的total_ordering、自定义上下文管理器contextmanager、设置getter和setter的property，展示了如何用它们提高代码效率和实现面向对象编程的优雅性。

摘要由CSDN通过智能技术生成

前言

“简洁胜于复杂。”

将这个哲学理念应用于Python中的最佳方式就是使用装饰器。

装饰器可以帮助你编写更少、更简单的代码来实现复杂的逻辑，并在各个地方重复使用。

更重要的是，Python内置了许多很棒的装饰器，可以让我们的生活变得更加轻松，因为我们只需使用一行代码就可以为现有的函数或类添加复杂的功能。

空谈无益。接下来让我们看看精心挑选的9个装饰器，它们将向你展示Python是多么优雅。

1. `@lru_cache`：通过缓存加速程序

使用@lru_cache装饰器是加速Python函数的最简单方法之一。

该装饰器可用于缓存函数的结果，因此，在后续调用函数时，将不会再次执行相同的参数。

它对于计算开销较大或经常使用相同参数调用的函数特别有帮助。

让我们来看一个直观的例子：

import time


def fibonacci(n):
    if n < 2:
        return n
    return fibonacci(n - 1) + fibonacci(n - 2)


start_time = time.perf_counter()
print(fibonacci(30))
end_time = time.perf_counter()
print(f"The execution time: {end_time - start_time:.8f} seconds")
# 执行时间：0.18129450秒

上述程序使用Python函数计算第N个斐波那契数。由于在递归过程中计算fibonacci(30)，许多先前的斐波那契数将被重复计算，因此这非常耗时。

现在，让我们使用@lru_cache装饰器来加快计算速度：

from functools import lru_cache
import time


@lru_cache(maxsize=None)
def fibonacci(n):
    if n < 2:
        return n
    return fibonacci(n - 1) + fibonacci(n - 2)


start_time = time.perf_counter()
print(fibonacci(30))
end_time = time.perf_counter()
print(f"The execution time: {end_time - start_time:.8f} seconds")
# 执行时间：0.00002990秒

如上述代码所示，在使用@lru_cache装饰器后，可以在0.00002990秒内获得相同的结果，速度比之前的0.18129450秒要快得多。

@lru_cache装饰器有一个maxsize参数，用于指定缓存中存储的结果的最大数量。当缓存已满且需要存储新的结果时，最近最少使用的结果将从缓存中删除，为新结果腾出空间。这就是所谓的最近最少使用（LRU）策略。

默认情况下，maxsize设置为128。如果将其设置为None，就像我们的示例一样，LRU功能将被禁用，缓存可以无限制地增长。

2. `@total_ordering`：填补缺失的排序方法的类装饰器

functools模块中的@total_ordering装饰器用于根据已定义的比较方法为Python类生成缺失的比较方法。

以下是一个示例：

from functools import total_ordering


@total_ordering
class Student:
    def __init__(self, name, grade):
        self.name = name
        self.grade = grade

    def __eq__(self, other):
        return self.grade == other.grade

    def __lt__(self, other):
        return self.grade < other.grade


student1 = Student("Alice", 85)
student2 = Student("Bob", 75)
student3 = Student("Charlie", 85)

print(student1 < student2)  # False
print(student1 > student2)  # True
print(student1 == student3)  # True
print(student1 <= student3) # True
print(student3 >= student2) # True

如上述代码所示，Student类中没有定义__ge__，__gt__和__le__方法。然而，由于使用了@total_ordering装饰器，我们在不同实例之间的比较结果都是正确的。

这个装饰器的好处显而易见：

它可以使代码更简洁、清晰，并节省时间。因为你不需要编写所有的比较方法。
某些旧的类可能没有定义足够的比较方法。为了进一步使用，为其添加@total_ordering装饰器是更安全的做法。

3. `@contextmanager`：创建自定义上下文管理器

Python具有上下文管理器机制，可帮助你正确管理资源。

大多数情况下，我们只需要使用with语句：

with open("test.txt",'w') as f:
    f.write("Yang is writing!")

如上述代码所示，可以使用with语句打开一个文件，这样在写入完成后文件将自动关闭。不需要显式调用f.close()函数来关闭文件。

有时，我们需要为特殊要求创建一个自定义的上下文管理器。在这种情况下，@contextmanager装饰器可以提供很好的帮助。

例如，以下代码实现了一个简单的自定义上下文管理器，当打开或关闭文件时它可以打印相应的信息。

from contextlib import contextmanager

@contextmanager
def file_manager(filename, mode):
    print("The file is opening...")
    file = open(filename,mode)
    yield file
    print("The file is closing...")
    file.close()

with file_manager('test.txt', 'w') as f:
    f.write('Yang is writing!')
# 文件正在打开...
# 文件正在关闭...

4. `@property`：为Python类设置`getter`（获取器）和`setter`（设置器）方法

在面向对象编程（OOP）中，getter和setter是很重要的概念。

对于类的每个实例变量，getter方法返回其值，而setter方法则设置或更新其值。因此，getter和setter也被称为accessor（访问器）和mutator（修改器）。

它们用于保护数据不被直接访问或意外修改。

不同的OOP语言有不同的机制来定义getter和setter。在Python中，我们可以简单地使用@property装饰器。

class Student:
    def __init__(self):
        self._score = 0

    @property
    def score(self):
        return self._score

    @score.setter
    def score(self, s):
        if 0 <= s <= 100:
            self._score = s
        else:
            raise ValueError('The score must be between 0 ~ 100!')

Yang = Student()

Yang.score=99
print(Yang.score)
# 99

Yang.score = 999
# ValueError：分数必须在0~100之间！