使用 Streamlit 和 asyncio 模块进行异步编程

概述

Streamlit 是一个用于构建数据应用程序的强大工具，但它本身并不直接支持异步编程。然而，通过结合 Python 的 asyncio 模块，我们可以在 Streamlit 应用中实现异步处理，从而提高应用的响应性和效率。

为什么需要异步编程

在数据科学和机器学习领域，我们经常需要处理长时间运行的任务，例如文档嵌入、模型训练等。如果这些任务在主线程中运行，将会阻塞用户界面，导致用户体验不佳。通过使用 asyncio，我们可以在不阻塞用户界面的情况下执行这些任务，并在任务完成后通知用户。

实现步骤

1. 安装必要的库

首先，确保你已经安装了 Streamlit 和 asyncio 库。通常情况下，Streamlit 会自动安装 asyncio，但为了确保，你可以运行以下命令：

pip install streamlit

2. 创建一个基本的 Streamlit 应用程序

创建一个新的 Python 文件（例如 app.py），并编写一个基本的 Streamlit 应用程序：

import streamlit as st

def main():
    st.title("Streamlit Asyncio Example")
    st.write("Welcome to the Streamlit Asyncio example.")

if __name__ == "__main__":
    main()

3. 集成 asyncio

为了在 Streamlit 中使用 asyncio，我们需要创建一个异步函数，并在应用程序中调用它。我们可以使用 asyncio.run 来运行异步函数。

import streamlit as st
import asyncio

async def async_function():
    st.write("Starting async function...")
    await asyncio.sleep(2)  # Simulate an asynchronous operation
    st.write("Async function completed.")

def main():
    st.title("Streamlit Asyncio Example")
    st.write("Welcome to the Streamlit Asyncio example.")

    if st.button("Run Async Function"):
        asyncio.run(async_function())

if __name__ == "__main__":
    main()

4. 运行应用程序

现在，你可以运行你的 Streamlit 应用程序：

streamlit run app.py

当你点击“Run Async Function”按钮时，应用程序将运行异步函数，并在完成后显示消息。

5. 处理异步任务

如果你有多个异步任务需要处理，可以使用 asyncio.gather 来同时运行它们。

import streamlit as st
import asyncio

async def async_task1():
    st.write("Starting async task 1...")
    await asyncio.sleep(2)
    st.write("Async task 1 completed.")

async def async_task2():
    st.write("Starting async task 2...")
    await asyncio.sleep(3)
    st.write("Async task 2 completed.")

async def run_tasks():
    await asyncio.gather(async_task1(), async_task2())

def main():
    st.title("Streamlit Asyncio Example")
    st.write("Welcome to the Streamlit Asyncio example.")

    if st.button("Run Async Tasks"):
        asyncio.run(run_tasks())

if __name__ == "__main__":
    main()

6. 注意事项

• Streamlit 的会话状态和缓存机制可能需要特殊处理，以确保异步操作的正确性。
• 在某些情况下，你可能需要使用 st.experimental_singleton 或 st.experimental_memo 来缓存异步函数的结果。

通过以上步骤，你可以在 Streamlit 应用程序中成功集成和使用 asyncio 模块，从而实现更高效的异步编程。