Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wsrpc/wsrpc-aiohttp
WebSocket RPC for aiohttp
https://github.com/wsrpc/wsrpc-aiohttp
aiohttp async python-3-5 python3 websocket websocket-client websocket-server ws
Last synced: 15 days ago
JSON representation
WebSocket RPC for aiohttp
- Host: GitHub
- URL: https://github.com/wsrpc/wsrpc-aiohttp
- Owner: wsrpc
- License: apache-2.0
- Created: 2017-08-07T17:05:12.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-11-28T00:38:51.000Z (about 1 year ago)
- Last Synced: 2025-01-18T09:45:59.770Z (21 days ago)
- Topics: aiohttp, async, python-3-5, python3, websocket, websocket-client, websocket-server, ws
- Language: Python
- Size: 21.9 MB
- Stars: 30
- Watchers: 6
- Forks: 7
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WSRPC aiohttp
[](https://github.com/wsrpc/wsrpc-aiohttp/actions?query=branch%3Amaster)
[](https://coveralls.io/github/wsrpc/wsrpc-aiohttp?branch=master)
[](https://pypi.python.org/pypi/wsrpc-aiohttp/)
[](https://pypi.python.org/pypi/wsrpc-aiohttp/)
[](https://pypi.python.org/pypi/wsrpc-aiohttp/)
[](https://pypi.python.org/pypi/wsrpc-aiohttp/)
Easy to use minimal WebSocket Remote Procedure Call library for aiohttp
servers.
See [online demo](https://demo.wsrpc.info/) and
[documentation](https://docs.wsrpc.info/) 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](https://pypi.python.org/pypi/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](https://www.npmjs.com/package/@wsrpc/client) using npm:
npm install @wsrpc/client
## Usage
Backend code:
``` python
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:
``` HTML
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);
});
```
## Build
Just run
```bash
poetry run nox
```
## Versioning
This software follows [Semantic Versioning](http://semver.org/)