解决Python异步函数在Jupyter与独立脚本中行为不一致的问题

聖光之護

发布时间：2025-12-13 22:32:13

907人浏览过

来源于php中文网

原创

解决python异步函数在jupyter与独立脚本中行为不一致的问题

本文旨在解决Python异步函数在使用`asyncio.run()`时，在Jupyter Notebook(`.ipynb`)中运行正常，但在独立Python脚本(`.py`)中表现异常的问题。我们将探讨`asyncio`事件循环的管理机制，特别是`nest_asyncio`的作用，并提供一个健壮的代码结构，确保基于`binance.websockets`的实时数据流在两种环境中都能稳定运行，强调了虚拟环境和模块版本的重要性。

理解异步编程与事件循环

Python的asyncio库提供了一种编写并发代码的方式，通过单线程协作式多任务处理实现非阻塞I/O。在处理网络请求、实时数据流（如WebSocket）等场景时，asyncio能够显著提高程序的效率和响应速度。

asyncio的核心是事件循环（event loop），它负责调度协程（coroutine）的执行。当你调用asyncio.run(main())时，它会启动一个新的事件循环，运行main()协程，并在main()执行完毕后关闭事件循环。

Jupyter Notebook与独立脚本的差异

Jupyter Notebook环境与标准Python脚本在处理asyncio事件循环方面存在关键差异：

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

Jupyter Notebook: Jupyter环境本身可能已经运行着一个事件循环，或者其内部机制允许更灵活地管理事件循环。当你尝试在已存在事件循环的环境中再次调用asyncio.run()时，通常会遇到错误。nest_asyncio库的作用就是解决这个问题，它允许在已运行的事件循环中嵌套运行新的事件循环，使得asyncio.run()在Jupyter中也能顺利执行。
独立Python脚本 (.py): 在一个全新的Python进程中运行.py文件时，通常没有预先存在的事件循环。asyncio.run()会创建一个新的事件循环并运行你的协程。理论上，这应该工作正常。如果出现问题，往往与环境配置、依赖版本或代码结构有关。

本教程的场景中，Jupyter Notebook中使用了nest_asyncio.apply()，这使得代码在Notebook中能够无缝运行。但在独立脚本中，即使移除了nest_asyncio.apply()，或者在有它的情况下，代码依然可能在await ts.recv()处阻塞，无法接收数据。这通常不是asyncio本身的问题，而是环境或依赖的特定交互。

构建健壮的实时数据流客户端

为了确保在不同环境中都能稳定运行，特别是针对Binance WebSocket数据流，我们需要一个可靠的代码结构。以下是一个经过验证的实现方案，它封装了异步逻辑，并通过if __name__ == '__main__'保护块确保在脚本直接执行时的正确性。

环境准备：

在开始之前，强烈建议使用Python虚拟环境来管理项目依赖。这可以避免不同项目间的依赖冲突，并确保所有开发者使用相同的库版本。

HaiSnap

一站式AI应用开发和部署工具

下载

# 创建虚拟环境
python -m venv venv

# 激活虚拟环境 (Windows)
venv\Scripts\activate
# 激活虚拟环境 (macOS/Linux)
source venv/bin/activate

# 安装所需库
pip install python-binance nest_asyncio

请确保您使用的库版本与已知工作版本一致，例如：

Python: 3.12.1
python-binance: 1.0.19
nest_asyncio: 1.5.8

核心代码实现：

以下代码展示了如何连接Binance WebSocket并接收实时交易数据。为了在独立脚本中稳定运行，我们将异步入口点封装在一个函数中，并在if __name__ == '__main__':块中调用它。

import asyncio
import nest_asyncio
import sys

from binance.client import Client
from binance import BinanceSocketManager

# 在独立脚本中，nest_asyncio通常不是必需的，但在某些复杂环境中或调试时可能有用。
# 如果你确定脚本总是在没有预设事件循环的环境中运行，可以移除此行。
# 但为了与Jupyter环境保持一致性，此处保留。
nest_asyncio.apply()

async def stream_btc_data():
    """
    异步函数，连接Binance WebSocket并持续接收BTCUSDT交易数据。
    """
    client = Client() # 可以在此处传入API_KEY和API_SECRET

    bsm = BinanceSocketManager(client)
    socket = bsm.trade_socket('BTCUSDT')

    try:
        async with socket as ts:
            print("正在连接Binance WebSocket...")
            while True:
                msg = await ts.recv()
                print(f"收到数据: {msg}")
    except asyncio.CancelledError:
        print("数据流已取消。")
    except Exception as e:
        print(f"数据流发生错误: {e}")
    finally:
        await client.close_connection() # 确保关闭客户端连接
        print("Binance WebSocket连接已关闭。")

def run_async_application():
    """
    运行异步主应用，处理事件循环。
    """
    print("启动异步应用...")
    try:
        asyncio.run(stream_btc_data())
    except KeyboardInterrupt:
        print("\n用户中断程序。")
    except RuntimeError as e:
        # 捕获可能由于事件循环已在运行导致的错误
        print(f"运行时错误: {e}")
        print("尝试使用nest_asyncio修复，但如果问题持续，请检查环境。")

if __name__ == '__main__':
    run_async_application()

代码说明：

nest_asyncio.apply(): 尽管在独立脚本中通常不需要，但为了兼容Jupyter Notebook的场景，并避免潜在的“事件循环已在运行”错误，我们保留了它。在纯净的.py环境中，即使没有它，asyncio.run()也会正常工作。
Client(): 初始化Binance客户端。如果需要进行认证操作（如交易），请在此处传入API Key和Secret。对于公共数据流，通常不需要。
BinanceSocketManager: python-binance库提供的WebSocket管理器，简化了连接和数据接收。
bsm.trade_socket('BTCUSDT'): 创建一个用于接收BTCUSDT交易数据的WebSocket连接。
async with socket as ts:: 这是一个异步上下文管理器，它确保WebSocket连接被正确建立和关闭。
while True: msg = await ts.recv(): 循环不断地从WebSocket接收数据。await关键字在这里是关键，它允许程序在等待数据时释放控制权给事件循环，从而执行其他任务（如果存在）。
错误处理: 添加了try...except...finally块来优雅地处理程序中断 (asyncio.CancelledError 或 KeyboardInterrupt) 和其他潜在的网络或运行时错误，并确保资源（客户端连接）被正确关闭。
run_async_application(): 将asyncio.run()的调用封装在一个函数中。这使得代码结构更清晰。
if __name__ == '__main__':: 这是Python脚本的标准入口点。当脚本作为主程序直接运行时，此块内的代码会被执行。这对于组织代码和避免在模块被导入时意外执行异步函数至关重要。

运行与验证

将上述代码保存为.py文件（例如binance_stream.py），然后在激活的虚拟环境中运行：

python binance_stream.py

您应该会看到程序输出“正在连接Binance WebSocket...”然后开始持续打印接收到的BTCUSDT交易数据。通过按下Ctrl+C可以优雅地中断程序。

注意事项与最佳实践

虚拟环境: 始终使用虚拟环境来隔离项目依赖，避免版本冲突。
依赖版本: 确保python-binance和nest_asyncio的版本与已知稳定版本一致。不兼容的版本可能会导致意外行为。
API Key/Secret: 如果需要进行交易或访问私有数据，请务必安全地管理您的Binance API Key和Secret，切勿硬编码在代码中。建议使用环境变量或配置文件。
错误处理与重连: 在生产环境中，应实现更 robust 的错误处理机制，包括网络断开后的自动重连逻辑，以及指数退避策略，以避免频繁重试导致API限制。
日志记录: 使用Python的logging模块来记录程序运行状态、接收到的数据和任何错误信息，以便于调试和监控。
资源清理: 确保在程序退出时关闭所有打开的连接和资源，例如client.close_connection()。

总结

异步编程是处理高并发I/O操作的强大工具。理解asyncio事件循环在不同Python执行环境中的行为差异，并采用健壮的代码结构，是确保异步应用稳定运行的关键。通过遵循本文提供的指南，您可以在Jupyter Notebook和独立Python脚本中都成功地构建和运行基于Binance WebSocket的实时数据流客户端。核心在于正确的环境配置、依赖管理以及对asyncio.run()和事件循环生命周期的深刻理解。

Python 如何限制函数/脚本最大运行时间（超时杀掉）

如何判断一个路径是否为挂载点而不调用 os.statvfs

多进程写文件时如何使用文件锁（fcntl 或 msvcrt）

pathlib 如何判断两个不同路径是否指向同一个真实文件

如何安全递归删除目录树（即使包含只读文件）