WebSocket connector for Ypy
Project description
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""
Release history Release notifications | RSS feed
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.6.0.tar.gz
(7.6 kB
view details)
Built Distribution
File details
Details for the file ypy_websocket-0.6.0.tar.gz.
File metadata
- Download URL: ypy_websocket-0.6.0.tar.gz
- Upload date:
- Size: 7.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.11.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8aaa0a583363b74b7fcbab48f305d32b47e32040b9180be9198149fcc4feadd6 |
|
| MD5 | ff3ec0cd53d0cfca00b06313def1c9ff |
|
| BLAKE2b-256 | 0156920352387a4349f480b7724bc92e4602513325e98e170f285bc93e1a0bbf |
Provenance
File details
Details for the file ypy_websocket-0.6.0-py3-none-any.whl.
File metadata
- Download URL: ypy_websocket-0.6.0-py3-none-any.whl
- Upload date:
- Size: 9.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.11.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | da6bf0062acbd0f9a557a7a44f577fc6a1cc361caf99dc72f8b5639fbcb50276 |
|
| MD5 | f9d024f48fab861fb94667a79f918f39 |
|
| BLAKE2b-256 | 81ad514298a1d3c8584ca02aaba7148691759177b166f1cc2009cefd7b231792 |
