webshocket 0.4.0

An enhanced module to provide a robust, socket-like abstraction for WebSockets

[!WARNING] Webshocket is still unfinished and is not ready for proper-project use. It is advised to not expect any stability from this project until it reaches a stable release (>=v0.5.0)

Webshocket

Webshocket is a lightweight Python framework for building WebSocket RPC applications with per-client state and channel routing, built on the WebSocket library.

Usage

Calling RPC Methods

class Handler(webshocket.WebSocketHandler):
    @webshocket.rpc_method(alias_name="add")
    async def add(self, _: webshocket.ClientConnection, a: int, b: int):
        return a + b


async def main():
    server = webshocket.WebSocketServer("127.0.0.1", 5000, clientHandler=Handler)
    await server.start()

    async with webshocket.WebSocketClient("ws://127.0.0.1:5000") as client:
        response_packet = await client.send_rpc("add", 1, 2)

        print(response_packet.data)  # 3

    await server.close()


if __name__ == "__main__":
    asyncio.run(main())

Managing Client State

class Handler(webshocket.WebSocketHandler):
    @webshocket.rpc_method()
    async def register(self, connection: webshocket.ClientConnection, favorite_color: str) -> None:
        connection.favorite_color = favorite_color

    @webshocket.rpc_method(alias_name="my-favorite-color")
    async def tell(self, connection: webshocket.ClientConnection) -> str:
        return connection.session_state["favorite_color"]


async def main():
    server = webshocket.WebSocketServer("127.0.0.1", 5000, clientHandler=Handler)
    await server.start()

    async with webshocket.WebSocketClient("ws://127.0.0.1:5000") as client:
        await client.send_rpc("register", "blue")

        response = await client.send_rpc("my-favorite-color")

        print(response.data)  # blue

    await server.close()


if __name__ == "__main__":
    asyncio.run(main())

Working With Channels

class Handler(webshocket.WebSocketHandler):
    @webshocket.rpc_method()  # Alias name automatically set to the method name if `alias_name` is not provided
    async def subscribe_to(self, connection: webshocket.ClientConnection, channel: str):
        connection.subscribe(channel)


async def main():
    server = webshocket.WebSocketServer("127.0.0.1", 5000, clientHandler=Handler)
    await server.start()

    SportsSubscriber = await webshocket.WebSocketClient("ws://127.0.0.1:5000").connect()
    NewsSubscriber = await webshocket.WebSocketClient("ws://127.0.0.1:5000").connect()

    try:
        await SportsSubscriber.send_rpc("subscribe_to", "sports")
        await NewsSubscriber.send_rpc("subscribe_to", "news")
        await asyncio.sleep(1)

        await server.publish("sports", "Sports News!")
        await server.publish("news", "News update!")
        await asyncio.sleep(1)

        print((await SportsSubscriber.recv()).data)  # Sports News!
        print((await NewsSubscriber.recv()).data)  # News update!

    finally:
        await SportsSubscriber.close()
        await NewsSubscriber.close()

    await server.close()


if __name__ == "__main__":
    asyncio.run(main())

Contributing

Contributions are welcome! Please feel free to open an issue or submit a pull request on our GitHub repository.

License

This project is licensed under the MIT License - see the LICENSE file for details.