Skip to main content

WebSocket connector for Ypy

Project description

Build Status Code style: black

ypy-websocket

ypy-websocket is an async WebSocket connector for Ypy.

Usage

Client

Here is a code example:

import asyncio
import y_py as Y
from websockets import connect
from ypy_websocket import WebsocketProvider

async def client():
    ydoc = Y.YDoc()
    async with connect("ws://localhost:1234/my-roomname") as websocket:
        WebsocketProvider(ydoc, websocket)
        ymap = ydoc.get_map("map")
        with ydoc.begin_transaction() as t:
            ymap.set(t, "key", "value")

asyncio.run(client())

Server

Here is a code example:

import asyncio
from websockets import serve
from ypy_websocket import WebsocketServer

async def server():
    websocket_server = WebsocketServer()
    async with serve(websocket_server.serve, "localhost", 1234):
        await asyncio.Future()  # run forever

asyncio.run(server())

WebSocket API

The WebSocket object passed to WebsocketProvider and WebsocketServer.serve must respect the following API:

class WebSocket:

    @property
    def path(self) -> str:
        # can be e.g. the URL path
        # or a room identifier
        return "my-roomname"

    def __aiter__(self):
        return self

    async def __anext__(self) -> bytes:
        # async iterator for receiving messages
        # until the connection is closed
        try:
            message = await self.recv()
        except:
            raise StopAsyncIteration()
        return message

    async def send(self, message: bytes):
        # send message
        pass

    async def recv(self) -> bytes:
        # receive message
        return b""

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ypy_websocket-0.4.0.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

ypy_websocket-0.4.0-py3-none-any.whl (8.7 kB view details)

Uploaded Python 3

File details

Details for the file ypy_websocket-0.4.0.tar.gz.

File metadata

  • Download URL: ypy_websocket-0.4.0.tar.gz
  • Upload date:
  • Size: 7.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.23.0

File hashes

Hashes for ypy_websocket-0.4.0.tar.gz
Algorithm Hash digest
SHA256 b96114ef4a2aa493974b6838c21333438711e0a183c4e40146f3a303d10c0a6d
MD5 d193c5d02d3ccceb97e5d80d0dbceec4
BLAKE2b-256 7290623b3a34ec0f6f5df33790a394ee7545b36ef1f6ac76b952013a51a0c623

See more details on using hashes here.

Provenance

File details

Details for the file ypy_websocket-0.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for ypy_websocket-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2b1e589a628b5da1509beb2e19e082f87639aba0bdee5b5154b2ee03072f1552
MD5 17775128c66b319a3e90e2222a3769e4
BLAKE2b-256 10d8177aa15a4b9c393d095fd1b969abdd235f15d60d52e8cd6c56097f589208

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page