本文探讨了在python中如何高效且优雅地处理对象中计算成本高昂、且依赖于其他属性的派生属性。针对传统手动管理初始化状态和更新逻辑的复杂性，文章重点介绍了`functools.cached_property`装饰器。通过结合`__setattr__`方法进行智能缓存失效，`cached_property`提供了一种简洁、高性能的解决方案，确保派生属性仅在必要时重新计算，从而避免了不必要的开销和复杂的逻辑。

在面向对象编程中，我们经常会遇到这样的场景：一个对象的某些属性（例如，一个总和、一个聚合值或一个复杂计算结果）是基于其其他属性派生出来的。当这些基础属性发生变化时，派生属性也需要随之更新。然而，如果派生属性的计算过程非常耗时，我们不希望每次访问它时都重新计算，也不希望在每次基础属性变化时都立即计算，尤其是在对象初始化阶段，基础属性可能尚未完全设置。

挑战：计算密集型派生属性的更新

考虑一个Basket类，它包含多种水果的数量（如apple和orange），并需要一个total属性来表示所有水果的总数。如果这个total的计算在实际应用中非常复杂或耗时，并且total属性会被频繁读取，那么性能优化就变得至关重要。

一个常见的、但不够优雅的解决方案是引入一个内部标志（例如_initialised），来判断对象是否已完成初始化，并结合__setattr__方法手动触发计算。这种方法存在以下问题：

1. 复杂性增加：需要手动管理初始化状态，代码逻辑变得复杂。
2. 错误风险：容易忘记设置或重置标志，导致计算错误或运行时异常。
3. 非Pythonic：违背了Python的简洁和自动化原则。

在对象初始化过程中，如果total依赖的属性尚未全部赋值，手动触发计算会导致AttributeError。因此，我们需要一种机制，既能确保在所有依赖项就绪后才进行计算，又能实现在依赖项变化时自动更新，同时避免不必要的重复计算。

立即学习“Python免费学习笔记（深入）”；

解决方案：functools.cached_property 的应用

Python标准库中的functools.cached_property装饰器为解决此类问题提供了优雅且高性能的方案。cached_property的工作原理类似于property，但它会将计算结果缓存起来。只有在第一次访问时才会执行被装饰的方法，之后每次访问都直接返回缓存的值，直到缓存被明确地清除。

macOS UI 自动化技能包 —— 用 Python 控制你的 Mac

让 macOS 自动化像说话一样简单 —— 用代码控制你的 Mac，无需学习 AppleScript 系统要求 macOS 14+ (Sonoma) Python 3.9+ 需要开启：辅助功能 + 屏幕录制权限

下载

结合__setattr__方法，我们可以实现当派生属性的依赖项发生变化时，自动使缓存失效。

实现步骤

1. 定义cached_property：将计算密集型的派生属性定义为一个方法，并使用@cached_property装饰。
2. 实现缓存失效机制：在类的__setattr__方法中，当检测到影响派生属性的基础属性发生变化时，从实例的__dict__中删除对应的缓存属性。

下面是一个具体的示例，演示了如何使用cached_property来管理Basket类的total属性：

from abc import ABC
from functools import cached_property

# 抽象基类，定义了缓存失效的通用逻辑
class Container(ABC):

    # 定义哪些属性的变化会影响派生属性（例如total）
    _fruits = [] 

    def __setattr__(self, name, value):
        # 首先调用父类的__setattr__来设置属性
        super().__setattr__(name, value)

        # 如果被设置的属性是_fruits中定义的依赖项
        if name in self._fruits:
            # 尝试删除实例字典中的'total'缓存
            # 如果'total'尚未被缓存，del操作会引发KeyError，因此需要捕获
            try:
                del self.__dict__['total']
            except KeyError:
                # 缓存不存在时无需额外处理
                pass

# 具体的容器类，继承自Container
class Basket(Container):

    # 覆盖_fruits，指定Basket中哪些属性是total的依赖项
    _fruits = ['apple', 'orange']

    def __init__(self, apple, orange, color):
        super(Basket, self).__init__()
        self.apple = apple
        self.orange = orange
        self.color = color

    # 使用@cached_property装饰器定义total属性
    # total的计算只在第一次访问或缓存失效后重新计算
    @cached_property
    def total(self):
        print("Calculating total...") # 用于演示何时进行计算
        out = self.apple + self.orange
        return out

# 示例用法
if __name__ == "__main__":
    basket = Basket(apple=10, orange=5, color="red")

    print(f"Initial total: {basket.total}") # 第一次访问，触发计算
    print(f"Access total again: {basket.total}") # 第二次访问，直接返回缓存值

    print("\nChanging apple quantity...")
    basket.apple = 15 # 修改依赖属性，触发缓存失效

    print(f"Total after changing apple: {basket.total}") # 缓存失效，重新计算
    print(f"Access total again: {basket.total}") # 再次访问，返回新缓存值

    print("\nChanging color (non-dependency)...")
    basket.color = "blue" # 修改非依赖属性，不影响total缓存
    print(f"Total after changing color: {basket.total}") # 直接返回现有缓存值

代码解析

1. Container类：

   • 定义了一个类属性_fruits，用于标识哪些属性是派生属性（如total）的依赖项。
   • 重写了__setattr__方法。每当实例的属性被设置时，__setattr__都会被调用。
   • 在__setattr__中，首先通过super().__setattr__(name, value)执行正常的属性设置。
   • 接着，检查被设置的属性name是否在_fruits列表中。如果是，说明这个属性是total的依赖项，它的变化可能导致total失效。
   • 通过del self.__dict__['total']来删除total属性的缓存值。cached_property的实现机制是将计算结果直接存储在实例的__dict__中，键就是属性名。删除它，就意味着下次访问total时，cached_property会重新执行其装饰的方法来获取新值。
   • try-except KeyError块用于处理total尚未被计算（即尚未缓存）的情况，避免不必要的错误。

2. Basket类：

   • 继承自Container，并覆盖_fruits列表，明确指定apple和orange是其total属性的依赖项。
   • __init__方法中，正常初始化apple、orange和color属性。注意：这里不再需要手动设置_initialised标志，也不需要在__init__中手动调用compute_total。cached_property天然地解决了初始化阶段的问题，因为它只在第一次访问时计算。
   • total方法被@cached_property装饰。这意味着total的计算逻辑（self.apple + self.orange）只会在以下两种情况被执行：
     • 第一次访问basket.total时。
     • 在basket.total的缓存被__setattr__删除后，再次访问basket.total时。

cached_property的优势

• 性能优化：避免了不必要的重复计算，尤其适用于计算成本高昂的属性。
• 代码简洁性：消除了手动管理初始化标志和复杂更新逻辑的需要，使代码更清晰、更易维护。
• Pythonic：利用了Python的装饰器和特殊方法机制，符合语言的设计哲学。
• 惰性计算：属性值只在首次被访问时计算，如果某个派生属性从未被访问，其计算成本将完全避免。
• 自动缓存失效：通过巧妙地结合__setattr__，实现了依赖项变化时的自动缓存失效。

注意事项与最佳实践

• 适用场景：cached_property最适合用于那些计算成本高昂、且一旦计算完成其值在依赖项不变的情况下不会再变化的属性。如果属性值需要频繁且实时地变化，或者计算成本很低，直接使用普通property可能更简单。
• 线程安全：cached_property本身不是线程安全的。在多线程环境中，如果多个线程可能同时首次访问一个尚未缓存的cached_property，可能会导致多次计算。对于简单的数值计算通常不是问题，但对于有副作用或耗时长的计算，可能需要额外的同步机制（如threading.Lock）。
• 内存考量：cached_property会将计算结果存储在实例的__dict__中。如果缓存的值非常大，需要考虑其对内存的占用。
• 明确依赖：在_fruits或类似列表中明确列出所有影响派生属性的依赖项至关重要，以确保缓存失效逻辑的正确性。

总结

functools.cached_property为Python开发者提供了一个强大而优雅的工具，用于管理对象中计算密集型派生属性的生命周期。通过结合__setattr__实现智能缓存失效，我们能够构建出高性能、易于维护且符合Pythonic风格的代码，有效避免了手动管理状态和重复计算带来的复杂性和性能开销。这种模式在处理各种需要惰性计算和条件更新的场景中都非常有用。