在Python asyncio中构建可等待的懒加载属性

本文探讨在python `asyncio`环境中实现懒加载异步属性的挑战与解决方案。核心在于，由于描述符的`__get__`方法无法直接声明为`async`，我们不能在其内部直接使用`await`。正确的做法是让`__get__`方法（或其所代表的`@property`）返回一个可等待对象（coroutine），然后由调用方显式地对其进行`await`操作，从而实现异步数据的按需加载。

异步懒加载属性的需求与挑战

在异步编程场景中，我们经常需要实现某些属性的懒加载（lazy loading），即仅在首次访问时才执行耗时的数据加载操作，例如从网络或数据库获取数据。理想情况下，如果数据加载本身是异步的，我们希望能够在一个非阻塞的方式下完成。

然而，Python中描述符的__get__方法是一个同步方法，它不能直接被声明为async def，这意味着我们无法在__get__方法内部直接使用await关键字来等待一个异步操作的完成。尝试在同步方法中直接调用异步函数而不await会导致RuntimeWarning: coroutine '...' was never awaited。而如果尝试在已运行的asyncio事件循环中再次调用asyncio.get_event_loop().run_until_complete()，则会抛出RuntimeError: This event loop is already running。

这些限制使得在__get__方法中实现异步懒加载成为一个挑战。问题的核心在于，如果属性的值需要通过异步操作才能获得，那么访问该属性的代码也必须能够等待这个异步操作。

核心解决方案：返回可等待对象

解决这个问题的关键在于改变思维模式：不是让__get__方法在内部等待异步操作完成并直接返回最终值，而是让__get__方法（或其所代表的@property）返回一个可等待对象（awaitable），然后由属性的调用方负责对这个可等待对象进行await操作。

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

这意味着，当您访问一个异步懒加载属性时，您不会立即得到其最终值，而是得到一个协程对象。您必须使用await来执行这个协程并获取最终结果。

使用 @property 和 async def 实现

Python的@property装饰器可以与async def结合使用，以声明一个返回可等待对象的属性。

即构数智人

即构数智人是由即构科技推出的AI虚拟数字人视频创作平台，支持数字人形象定制、短视频创作、数字人直播等。

36

查看详情

考虑以下示例，它展示了一个A类，其中包含一个异步懒加载的name属性：

import asyncio

class A:
    _name: str
    def __init__(self):
        self._name = ""
        self._is_loading = False # 用于防止重复加载的标志

    async def _load_name_async(self):
        """内部异步方法，用于模拟从网络加载数据。"""
        if not self._name and not self._is_loading:
            self._is_loading = True
            print("正在异步加载名称...")
            await asyncio.sleep(1) # 模拟I/O操作耗时
            self._name = "Jax"
            self._is_loading = False
        return self._name

    @property
    async def name(self):
        """
        一个异步属性，返回一个可等待对象。
        首次访问时触发异步加载，后续访问直接返回已加载的值。
        """
        return await self._load_name_async()

async def main():
    a = A()
    print(f"首次访问 a.name: {await a.name}") # 必须await
    print(f"再次访问 a.name: {await a.name}") # 再次访问，直接返回已加载值

if __name__ == "__main__":
    asyncio.run(main())

代码解析：

1. _load_name_async(self): 这是一个私有的async方法，负责实际的异步数据加载逻辑。它通过await asyncio.sleep(1)模拟了一个耗时的网络请求。_is_loading标志用于确保在并发访问时，加载操作只执行一次。
2. @property async def name(self): 这里的关键在于async def。它将name属性定义为一个异步函数。当您访问a.name时，它不会立即返回一个字符串，而是返回一个协程对象。
3. return await self._load_name_async(): 在name属性的实现中，我们await了内部的_load_name_async()方法。这意味着当a.name被await时，它会执行_load_name_async()并等待其结果。
4. print(f"首次访问 a.name: {await a.name}"): 在main函数中，对a.name的访问必须使用await。await a.name会暂停main函数的执行，直到name属性所代表的协程完成并返回其值。

替代方案：@property 返回协程对象

实际上，@property async def 是一种语法糖。您也可以让一个普通的 @property 方法直接返回一个协程对象，效果是相同的：

import asyncio

class A:
    _name: str
    def __init__(self):
        self._name = ""
        self._is_loading = False

    async def _load_name_async(self):
        if not self._name and not self._is_loading:
            self._is_loading = True
            print("正在异步加载名称...")
            await asyncio.sleep(1)
            self._name = "Jax"
            self._is_loading = False
        return self._name

    @property
    def name(self):
        """
        一个同步属性，但直接返回一个协程对象。
        调用方仍需await。
        """
        return self._load_name_async() # 直接返回协程对象，不在此处await

async def main():
    a = A()
    print(f"首次访问 a.name: {await a.name}") # 必须await
    print(f"再次访问 a.name: {await a.name}")

if __name__ == "__main__":
    asyncio.run(main())

这两种方式在功能上是等价的。第一种方式（@property async def）可能在语义上更清晰，因为它明确地表明该属性的访问需要await。

关键考量与最佳实践

1. 调用方的await是强制性的：一旦您设计了一个异步懒加载属性，任何访问该属性的代码都必须使用await关键字。这改变了类的接口，因此在设计时需要清晰地沟通这一要求。
2. 避免在已运行的事件循环中阻塞：切勿尝试在__get__方法或属性访问点内部使用asyncio.run_until_complete()来阻塞当前事件循环。这通常会导致RuntimeError: This event loop is already running，因为asyncio.run()或其他任务已经启动了事件循环。asyncio程序的核心原则是协作式多任务，而不是阻塞。
3. 简化设计，使用标准@property：对于异步懒加载属性，通常无需自定义复杂的描述符类（如LazyLoadableProperty）。Python内置的@property装饰器，结合async def或直接返回协程的模式，已经足够强大和灵活。
4. 状态管理：确保您的懒加载逻辑正确处理了状态。例如，使用一个内部标志（如_is_loading）来防止在数据加载过程中重复触发加载操作，或者在数据已加载后直接返回缓存值。
5. 错误处理：在实际应用中，异步加载操作应包含适当的错误处理机制（例如try-except块），以优雅地处理网络中断、API错误等情况。

总结

在Python asyncio环境中实现异步懒加载属性的核心在于理解__get__方法的同步性质，并接受属性访问需要await这一事实。通过让@property装饰的方法返回一个协程对象（无论是通过async def声明属性方法，还是在同步属性方法中直接返回协程），我们可以优雅地将异步加载的责任转移给调用方。这种模式不仅符合asyncio的设计哲学，也使得代码更加清晰和可维护。

以上就是在Python asyncio中构建可等待的懒加载属性的详细内容，更多请关注php中文网其它相关文章！