WSRPC is the RPC over WebSocket for aiohttp
Easy to use minimal WebSocket Remote Procedure Call library for aiohttp servers.
See online demo and documentation with examples.
Call server functions from the client side;
Call client functions from the server (for example to notify clients about events);
Async connection protocol: both server or client are able to call several functions and get responses as soon as each response would be ready in any order.
Fully async server-side functions;
Transfer any exceptions from a client side to the server side and vise versa;
Ready-to-use frontend-library without dependencies;
Thread-based websocket handler for writing fully-synchronous backend code (for synchronous database drivers etc.)
Protected server-side methods (cliens are not able to call methods, starting with underline directly);
Install via pip:
pip install wsrpc-aiohttp
You may want to install optional ujson library to speedup message serialization/deserialization:
pip install ujson
npm install @wsrpc/client
import logging from time import time import aiohttp.web from wsrpc_aiohttp import WebSocketAsync, STATIC_DIR, WebSocketRoute log = logging.getLogger(__name__) # This class can be called by client. # Connection object will have this class instance after calling route-alias. class TestRoute(WebSocketRoute): # This method will be executed when client calls route-alias # for the first time. def init(self, **kwargs): # Python __init__ must be return "self". # This method might return anything. return kwargs # This method named by camelCase because the client can call it. async def getEpoch(self): # You can execute functions on the client side await self.do_notify() return time() # This method calls function on the client side async def do_notify(self): awesome = 'Somebody executed test1.getEpoch method!' await self.socket.call('notify', result=awesome) app = aiohttp.web.Application() app.router.add_route("*", "/ws/", WebSocketAsync) # Websocket route app.router.add_static('/js', STATIC_DIR) # WSRPC js library app.router.add_static('/', ".") # Your static files # Stateful request # This is the route alias TestRoute as "test1" WebSocketAsync.add_route('test1', TestRoute) # Stateless request WebSocketAsync.add_route('test2', lambda *a, **kw: True) if __name__ == '__main__': logging.basicConfig(level=logging.DEBUG) aiohttp.web.run_app(app, port=8000)
This software follows Semantic Versioning
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.