websockets

Python 2025-08-22

<span class =WebSockets“ src =”/uploads/20250821/img_68a6e6e92ad8730.svg“ width =“ 480px” style =“ max-width:max-width:100%;>>>>>>>>

什么是websockets ?

websockets是用于在Python中构建WebSocket服务器和客户端的库,重点是正确性,简单,稳健性和性能。

默认实现建立在Python标准异步I/O框架的Asyncio上,提供了优雅的基于Coroutine的API。

还提供了线程和SANS-I/O实现的实现。

可以在阅读文档上获得文档。

这是带有Asyncio API的回声服务器:

websockets.asyncio.server import serve async def echo(websocket): async for message in websocket: await websocket.send(message) async def main(): async with serve(echo, "localhost", 8765) as server: await server.serve_forever() asyncio.run(main())">
 #!/usr/bin/env python

import asyncio
from websockets . asyncio . server import serve

async def echo ( websocket ):
    async for message in websocket :
        await websocket . send ( message )

async def main ():
    async with serve ( echo , "localhost" , 8765 ) as server :
        await server . serve_forever ()

asyncio . run ( main ())

以下是客户端通过线程API发送和接收消息的方式:

websockets.sync.client import connect def hello(): with connect("ws://localhost:8765") as websocket: websocket.send("Hello world!") message = websocket.recv() print(f"Received: {message}") hello()">
 #!/usr/bin/env python

from websockets . sync . client import connect

def hello ():
    with connect ( "ws://localhost:8765" ) as websocket :
        websocket . send ( "Hello world!" )
        message = websocket . recv ()
        print ( f"Received: { message } " )

hello ()

看起来不错吗?

开始教程!


企业的websockets

作为Tidelift订阅的一部分可用

websockets和其他成千上万个软件包的维护者正在与Tidelift合作,为您用于构建应用程序的开源依赖关系提供商业支持和维护。节省时间,降低风险并改善代码健康,同时支付您使用的确切依赖项的维护者。了解更多。


(如果您为websockets做出了贡献,并且想成为官方的支持提供商,请告诉我。)

我为什么要使用websockets ?

websockets的开发是由四个原则塑造的:

  1. 正确性:对websockets符合RFC 6455的大量测试。连续集成在100%分支覆盖范围内失败。
  2. 简单性:您需要了解的只是msg =等待ws.recv()和ws.send(msg)。 websockets负责管理连接,因此您可以专注于应用程序。
  3. 鲁棒性: websockets是用于生产的。例如,这是唯一在Python社区广为人知之前正确处理背压的图书馆。
  4. 性能:内存使用量是优化和配置的。交流扩展加速了昂贵的操作。它是针对Linux,MacOS和Windows预编译的,并针对每个系统和Python版本打包。

文档是项目中的一流问题。前往阅读文档并亲自查看。

我为什么不使用websockets ?

  • 如果您更喜欢回调,而不是Coroutines:创建websockets是为了提供最佳的基于Coroutine的API来管理Python中的WebSocket连接。选择基于回调的API的另一个库。

  • 如果您正在寻找混合的HTTP / WebSocket库: websockets旨在成为RFC 6455的绝佳实现:Websocket协议和RFC 7692:Websocket的压缩扩展。它对HTTP的支持很小 - 足以进行HTTP健康检查。

    如果您想在同一家服务器中同时进行两者,请查看在websockets上构建的HTTP + WebSocket服务器,以支持WebSocket连接,例如Uvicorn或Sanic。

还有什么?

欢迎错误报告,补丁和建议!

要报告安全漏洞,请使用Tidelift安全联系人。 Tidelift将协调修复和披露。

对于其他任何内容,请打开问题或发送拉请请求。

参与者必须维护贡献者盟约行为准则。

websockets根据BSD许可发布。

下载源码

通过命令行克隆项目:

git clone https://github.com/python-websockets/websockets.git