WSRPC is the RPC over WebSocket for aiohttp
Project description
WSRPC aiohttp
Easy to use minimal WebSocket Remote Procedure Call library for aiohttp servers.
See online demo and documentation with examples.
Features
- 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);
- Signals for introspection
Installation
Install via pip:
pip install wsrpc-aiohttp
You may want to install optional ujson library to speedup message serialization/deserialization:
pip install ujson
Python module provides client js library out of the box. But for pure javascript applications you can install standalone js client library using npm:
npm install @wsrpc/client
Usage
Backend code:
import logging
from time import time
import aiohttp.web
from wsrpc_aiohttp import Route, STATIC_DIR, WebSocketRoute, decorators
log = logging.getLogger(__name__)
# This class can be called by client.
# Connection object will have this class instance after calling route-alias.
class TestRoute(Route):
# 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.
@decorators.proxy
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
@decorators.proxy
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)
Frontend code:
<script type="text/javascript" src="/js/wsrpc.min.js"></script>
<script>
var url = (window.location.protocol==="https):"?"wss://":"ws://") + window.location.host + '/ws/';
RPC = new WSRPC(url, 8000);
// Configure client API, that can be called from server
RPC.addRoute('notify', function (data) {
console.log('Server called client route "notify":', data);
return data.result;
});
RPC.connect();
// Call stateful route
// After you call that route, server would execute 'notify' route on the
// client, that is registered above.
RPC.call('test1.getEpoch').then(function (data) {
console.log('Result for calling server route "test1.getEpoch": ', data);
}, function (error) {
alert(error);
});
// Call stateless method
RPC.call('test2').then(function (data) {
console.log('Result for calling server route "test2"', data);
});
</script>
Build
Just run
```bash
poetry run nox
```
Versioning
This software follows Semantic Versioning
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
wsrpc_aiohttp-4.0.3.tar.gz
(34.2 kB
view details)
Built Distribution
File details
Details for the file wsrpc_aiohttp-4.0.3.tar.gz.
File metadata
- Download URL: wsrpc_aiohttp-4.0.3.tar.gz
- Upload date:
- Size: 34.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.9.6 readme-renderer/32.0 requests/2.28.1 requests-toolbelt/0.9.1 urllib3/1.26.12 tqdm/4.62.3 importlib-metadata/5.2.0 keyring/23.13.1 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e1040fcea22d73274cbbe188535b9a4611e450c4d7fa2ef5b11b15b650f51ff4 |
|
| MD5 | 6722b4076813be47aff407cf2e8e7a72 |
|
| BLAKE2b-256 | 706f3d1b66a2b09da201e44edf2c689a22222029007f062091caa14264d89366 |
File details
Details for the file wsrpc_aiohttp-4.0.3-py3-none-any.whl.
File metadata
- Download URL: wsrpc_aiohttp-4.0.3-py3-none-any.whl
- Upload date:
- Size: 40.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.9.6 readme-renderer/32.0 requests/2.28.1 requests-toolbelt/0.9.1 urllib3/1.26.12 tqdm/4.62.3 importlib-metadata/5.2.0 keyring/23.13.1 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8389cb6f40bdceda5b912a58aeb18aed859c7898fd20fdd8509fc5821ff03a49 |
|
| MD5 | 58879f18342ac16f73dbe7ba72114fd0 |
|
| BLAKE2b-256 | 2d7ef50cde0b31d018a73ed40d4e8311660d5ec1053adb5f9838042232115a2f |
