如何在一个类中实现 asyncio websockets？

Question

我想通过asyncio和websockets连接到一个websocket，格式如下图。我怎样才能做到这一点？

from websockets import connect


class EchoWebsocket:

    def __init__(self):
        self.websocket = self._connect()

    def _connect(self):
        return connect("wss://echo.websocket.org")

    def send(self, message):
        self.websocket.send(message)

    def receive(self):
        return self.websocket.recv()

echo = EchoWebsocket()
echo.send("Hello!")
print(echo.receive())  # "Hello!"

Answer 1

如何编写异步程序？

1. 你应该用async定义异步函数
2. 您应该调用 async 功能与await
3. 你需要event loop 来启动你的异步程序

所有其他几乎与常规 Python 程序相同。

import asyncio
from websockets import connect


class EchoWebsocket:
    async def __aenter__(self):
        self._conn = connect("wss://echo.websocket.org")
        self.websocket = await self._conn.__aenter__()        
        return self

    async def __aexit__(self, *args, **kwargs):
        await self._conn.__aexit__(*args, **kwargs)

    async def send(self, message):
        await self.websocket.send(message)

    async def receive(self):
        return await self.websocket.recv()


async def main():
    async with EchoWebsocket() as echo:
        await echo.send("Hello!")
        print(await echo.receive())  # "Hello!"


if __name__ == '__main__':
    loop = asyncio.get_event_loop()
    loop.run_until_complete(main())

输出：

Hello!

如您所见，代码与您编写的几乎相同。

唯一的区别是websockets.connect 设计为异步上下文管理器（它使用__aenter__、__aexit__）。释放连接是必要的，并且还会帮助您在类初始化期间进行异步操作（因为我们没有 __init__ 的异步版本）。

我建议您以同样的方式组织课程。但是如果你真的因为某种原因不想使用上下文管理器，你可以使用新的__await__ 方法进行异步初始化和其他一些异步函数来释放连接：

import sys
import asyncio
from websockets import connect


class EchoWebsocket:
    def __await__(self):
        # see: http://stackoverflow.com/a/33420721/1113207
        return self._async_init().__await__()

    async def _async_init(self):
        self._conn = connect("wss://echo.websocket.org")
        self.websocket = await self._conn.__aenter__()
        return self

    async def close(self):
        await self._conn.__aexit__(*sys.exc_info())

    async def send(self, message):
        await self.websocket.send(message)

    async def receive(self):
        return await self.websocket.recv()


async def main():
    echo = await EchoWebsocket()
    try:
        await echo.send("Hello!")
        print(await echo.receive())  # "Hello!"
    finally:
        await echo.close()


if __name__ == '__main__':
    loop = asyncio.get_event_loop()
    loop.run_until_complete(main())

您可以在docs 中找到许多使用websockets 的示例。