WSGI Framework for JSON RPC 2.0
Project description
jsonrpc2 is WSGI Framework for JSON RPC 2.0.
JSON RPC 2.0 Spec can be seen on http://www.jsonrpc.org/specification .
QuickStart
install via pip:
$ pip install jsonrpc2
write your procedures in hello.py:
def greeting(name): return dict(message="Hello, %s!" % name)
run jsonrpc2 server:
$ runjsonrpc2 hello
Integration with Paste Script
create project with paste script template:
$ paster create -t paster_jsonrpc2 myrpc $ cd myrpc
run server
$ paster serve run.ini
access http://localhost:8080/
Internal
>>> import json >>> from jsonrpc2 import JsonRpcApplication
sample procedure:
>>> def greeting(name="world"): ... return "Hello, %s!" % name
create rpc application:
>>> app = JsonRpcApplication(rpcs=dict(greeting=greeting))
set up for test:
>>> from webtest import TestApp >>> testapp = TestApp(app)
call procedure:
>>> call_values = {'jsonrpc':'2.0', 'method':'greeting', 'id':'greeting'} >>> res = testapp.post('/', params=json.dumps(call_values), content_type="application/json")
got results:
>>> res.json {u'jsonrpc': u'2.0', u'id': u'greeting', u'result': u'Hello, world!'}
lazy loading:
>>> app.rpc.methods['sample.add'] = 'tests.sample:add' >>> call_values = {'jsonrpc':'2.0', 'method':'sample.add', 'id':'sample.add', 'params':[1, 2]} >>> res = testapp.post('/', params=json.dumps(call_values), content_type="application/json") >>> res.json {u'jsonrpc': u'2.0', u'id': u'sample.add', u'result': 3}
extra vars
>>> from jsonrpc2 import JsonRpc >>> rpc = JsonRpc() >>> rpc['add'] = lambda a, b: a + b >>> rpc({'jsonrpc': '2.0', 'method': 'add', 'id': 'rpc-1', 'params': {'a': 2}}, b=3) {'jsonrpc': '2.0', 'id': 'rpc-1', 'result': 5}
handle errors
>>> from jsonrpc2 import JsonRpc >>> class MyException(Exception): ... pass >>> def my_rpc(): ... raise MyException() >>> rpc = JsonRpc({'call': my_rpc}, {MyException: -32001}) >>> rpc({'jsonrpc': '2.0', 'method': 'call', 'id': 'rpc-1', 'params': []}) {'jsonrpc': '2.0', 'id': 'rpc-1', 'error': {'message': '', 'code': -32001, 'data': '[]'}}
JSON-RPC2 Example
use raw rpc processor:
>>> from jsonrpc2 import JsonRpc >>> rpc = JsonRpc()
sample procedures:
>>> def subtract(minuend, subtrahend): ... return minuend - subtrahend >>> def update(*args): ... pass >>> def foobar(): ... pass
register procedures with dict interface:
>>> rpc['subtract'] = subtract >>> rpc['update'] = update >>> rpc['foobar'] = foobar
Procedure Call with positional parameters:
>>> rpc({"jsonrpc": "2.0", "method": "subtract", "params": [42, 23], "id": 1}) {'jsonrpc': '2.0', 'id': 1, 'result': 19} >>> rpc({"jsonrpc": "2.0", "method": "subtract", "params": [23, 42], "id": 2}) {'jsonrpc': '2.0', 'id': 2, 'result': -19}
Procedure Call with named parameters:
>>> rpc({"jsonrpc": "2.0", "method": "subtract", "params": {"subtrahend": 23, "minuend": 42}, "id": 3}) {'jsonrpc': '2.0', 'id': 3, 'result': 19} >>> rpc({"jsonrpc": "2.0", "method": "subtract", "params": {"minuend": 42, "subtrahend": 23}, "id": 4}) {'jsonrpc': '2.0', 'id': 4, 'result': 19}
Notification:
>>> rpc({"jsonrpc": "2.0", "method": "update", "params": [1,2,3,4,5]}) >>> rpc({"jsonrpc": "2.0", "method": "foobar"})
Procedure Call of non-existent procedure:
>>> del rpc['foobar'] >>> rpc({"jsonrpc": "2.0", "method": "foobar", "id": "1"}) {'jsonrpc': '2.0', 'id': '1', 'error': {'message': 'Method Not Found', 'code': -32601}}
Procedure Call with invalid JSON-RPC:
>>> rpc([1,2,3]) {'jsonrpc': '2.0', 'id': None, 'error': {'message': 'Invalid Request', 'code': -32600}} >>> rpc({"jsonrpc": "2.0", "method": 1, "params": "bar"}) {'jsonrpc': '2.0', 'id': None, 'error': {'message': 'Invalid Request', 'code': -32600}}
Batched Call:
>>> rpc['sum'] = lambda *args: reduce(lambda a, b: a + b, args) >>> def get_data(): ... return ["hello", 5] >>> rpc['get_data'] = get_data >>> result = rpc ([ {"jsonrpc": "2.0", "method": "sum", "params": [1,2,4], "id": "1"}, ... {"jsonrpc": "2.0", "method": "notify_hello", "params": [7]}, ... {"jsonrpc": "2.0", "method": "subtract", "params": [42,23], "id": "2"}, ... {"foo": "boo"}, ... {"jsonrpc": "2.0", "method": "foo.get", "params": {"name": "myself"}, "id": "5"}, ... {"jsonrpc": "2.0", "method": "get_data", "id": "9"} ]) >>> from pprint import pprint >>> pprint(result) [{'id': '1', 'jsonrpc': '2.0', 'result': 7}, {'error': {'code': -32601, 'message': 'Method Not Found'}, 'id': None, 'jsonrpc': '2.0'}, {'id': '2', 'jsonrpc': '2.0', 'result': 19}, {'error': {'code': -32600, 'message': 'Invalid Request'}, 'id': None, 'jsonrpc': '2.0'}, {'error': {'code': -32601, 'message': 'Method Not Found'}, 'id': '5', 'jsonrpc': '2.0'}, {'id': '9', 'jsonrpc': '2.0', 'result': ['hello', 5]}]
ChangeLog
0.4.1
0.4 is brown bag release.
0.4
feature
added supporting py3
added registering application errors
fixed bugs
0.3
fix bugs
Paste Scripte templates
runjsonrpc2 command
0.3.1
fix bugs (content-type with charset)
0.3.2
enable to pass the extra vars to procedures
0.2
remove dependency to WebOb
split procedure call class from web application class
0.2.1
lazy loading from method name.
0.2.2
add dict interface.
0.2.3
fix: read body with CONTENT_LENGTH.
Project details
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
Built Distribution
File details
Details for the file jsonrpc2-0.4.1.tar.gz
.
File metadata
- Download URL: jsonrpc2-0.4.1.tar.gz
- Upload date:
- Size: 15.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ca1be95bcda87578c2851a478e7092a150a41bcc99942addd1ffe0f033e5228e |
|
MD5 | 1fce3d89554325e0a3a80f69b7e806c8 |
|
BLAKE2b-256 | cb9562a7675260b3156fc79bf5692d8173d9cee134b421f347eae3e7c54ac60f |
File details
Details for the file jsonrpc2-0.4.1-py2.py3-none-any.whl
.
File metadata
- Download URL: jsonrpc2-0.4.1-py2.py3-none-any.whl
- Upload date:
- Size: 20.2 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | de66e608c14f6a2dd532c2233b85784d201e8754dc59fc998d81b1ce8973660b |
|
MD5 | 6f3d2f3f0eba852ab81071334e193ca3 |
|
BLAKE2b-256 | 7769e41800d6ce7bca4f2409842e93325e12604493d6d9b226c0dcf733a195aa |