NiceGUI项目中"Task was destroyed but it is pending"问题分析与解决方案

问题背景

在NiceGUI 2.13.0版本发布后，多个用户报告遇到了"Task was destroyed but it is pending!"的错误提示。这个问题主要出现在Linux环境下，当用户快速刷新页面或频繁切换页面内容时尤为明显。错误信息表明异步任务在尚未完成时就被垃圾回收机制销毁了。

问题现象

错误日志通常显示为：

Task was destroyed but it is pending!
task: <Task pending name='Task-20' coro=<Event.wait() running at /usr/lib/python3.12/asyncio/locks.py:212> wait_for=<Future pending cb=[Task.task_wakeup()]>>

通过添加垃圾回收回调函数，开发者发现错误与垃圾回收机制密切相关。当GC开始执行时，会销毁一些仍在等待中的异步任务，导致asyncio运行时发现任务已被销毁但状态仍为pending的矛盾情况。

根本原因分析

经过深入调查，发现问题源于NiceGUI 2.13.0版本中对连接等待机制的优化。在#4466提交中，开发者将原本每0.1秒轮询一次的机制改为使用asyncio.wait来提高效率。然而，这一改动引入了一个潜在问题：

1. 使用asyncio.create_task创建的任务没有被正确命名，导致调试困难
2. 这些任务没有被适当引用，容易被垃圾回收机制提前销毁
3. 在页面快速刷新时，对象创建和销毁频率增加，问题更容易显现

解决方案

针对这一问题，NiceGUI团队提出了以下修复方案：

1. 使用background_tasks.create替代asyncio.create_task，确保任务有适当的生命周期管理
2. 为所有后台任务添加明确的名称，便于调试和追踪
3. 确保任务在完成前不会被垃圾回收机制意外销毁

修复后的代码会显式地保持对任务的引用，防止它们被过早回收。同时，通过给任务命名，开发者可以更容易地识别和追踪问题任务。

最佳实践建议

基于这一问题的经验，NiceGUI项目提出了以下开发建议：

1. 在NiceGUI项目中，应优先使用background_tasks.create而非asyncio.create_task
2. 所有异步任务都应被赋予有意义的名称
3. 对于需要长时间运行的任务，开发者应确保保持对任务的引用
4. 在页面刷新或关闭时，应妥善处理未完成的任务

影响范围

该问题主要影响：

• 使用NiceGUI 2.13.0版本的项目
• 主要运行在Linux环境下的应用
• 使用async def定义的页面
• 需要频繁刷新或快速切换页面的应用场景

结论

"Task was destroyed but it is pending"错误展示了异步编程中资源管理的重要性。通过这次问题的解决，NiceGUI项目不仅修复了一个具体的技术问题，还完善了项目的异步任务管理规范，为开发者提供了更健壮的异步编程实践指导。

对于遇到类似问题的开发者，建议检查项目中所有异步任务的创建方式，确保它们有适当的生命周期管理和明确的命名，这样可以有效避免类似问题的发生。