在Python中如何派发和处理自定义回调事件

85 阅读2分钟

引言

在现代应用开发中,回调机制被广泛应用于事件驱动的编程模型中。在这篇文章中,我们将深入探讨如何在Python中派发和处理自定义回调事件,帮助开发者更有效地监控和管理长时间运行的任务流程。

主要内容

自定义回调事件的概念

自定义回调事件是用户定义的事件类型,用于在应用程序中传递特定信息。你可以为每个事件定义一个namedata属性,前者是事件的标识符,后者是与事件相关的数据(建议使用JSON可序列化的数据)。

LangChain支持

LangChain 提供了一组工具,帮助开发者创建和派发自定义回调事件。通过adispatch_custom_event API,开发者可以在异步环境中派发事件。需要注意的是,自定义事件必须在一个已经存在的Runnable中派发。

兼容性注意

  • Python <= 3.10: 需要手动将RunnableConfig对象传递给子Runnable
  • Python >= 3.11: RunnableConfig会自动传播,但仍建议手动处理以确保兼容性。

代码示例

以下是一个完整的代码示例,展示了如何派发和处理自定义回调事件。

from langchain_core.callbacks.manager import (
    adispatch_custom_event,
)
from langchain_core.runnables import RunnableLambda
from langchain_core.runnables.config import RunnableConfig

@RunnableLambda
async def custom_task(x: str, config: RunnableConfig) -> str:
    """在Python <= 3.10 中手动传播配置"""
    await adispatch_custom_event("progress_event", {"step": "start"}, config=config)
    # 模拟长时间运行任务
    await adispatch_custom_event("progress_event", {"step": "processing"}, config=config)
    await adispatch_custom_event("progress_event", {"step": "completed"}, config=config)
    return x

async for event in custom_task.astream_events("Running Task", version="v2"):
    print(event)

常见问题和解决方案

为什么我没有看到事件被派发?

  • 确保你正在使用version='v2'来查看自定义事件。
  • 检查是否在Python <= 3.10中手动传播了RunnableConfig

总结和进一步学习资源

自定义回调事件是一种强大的工具,能够帮助开发者更好地管理和监控应用程序流程。要进一步了解和实验,建议查看Astream Events API的官方文档

参考资料

如果这篇文章对你有帮助,欢迎点赞并关注我的博客。您的支持是我持续创作的动力!

---END---