jsonrpcclient Guide¶
Installation¶
Install the package with the Requests library (alternatively, see other options):
$ pip install 'jsonrpcclient[requests]'
Sending a request¶
If using HTTP, the easiest way to send a request is using the convenience methods:
>>> import jsonrpcclient
>>> jsonrpcclient.request('http://cats.com', 'speak')
'meow'
The first argument is the endpoint, and the second argument is the method to call. Subsequent arguments are arguments to the method.
Use notify
instead of request
to signify that no response is required:
>>> jsonrpcclient.notify('http://cats.com', 'speak')
>>>
Alternatively, instantiate HTTPClient
, passing the server endpoint:
>>> from jsonrpcclient.http_client import HTTPClient
>>> client = HTTPClient('http://pets.com')
Then we can send multiple requests with the client
object.
Send¶
Send a request, passing the whole JSON-RPC request object:
>>> client.send('{"jsonrpc": "2.0", "method": "ping", "id": 1}')
--> {"jsonrpc": "2.0", "method": "ping", "id": 1}
<-- {"jsonrpc": "2.0", "result": "pong", "id": 1}
'pong'
Request¶
Send a request by passing the method and arguments. This is the main public method.
>>> client.request('cat', name='Mittens')
--> {"jsonrpc": "2.0", "method": "cat", "params": {"name": "Mittens"}, "id": 1}
<-- {"jsonrpc": "2.0", "result": "meow", "id": 1}
'meow'
If you’re not interested in a response, use notify()
instead of
request()
.
The Request class¶
This class makes it easy to create a JSON-RPC request object:
>>> from jsonrpcclient.request import Request
>>> Request('cat', name='Mittens')
{'jsonrpc': '2.0', 'method': 'cat', 'params': {'name': 'Mittens'}, 'id': 1}
Send a Request
object:
>>> client.send(Request('ping'))
--> {"jsonrpc": "2.0", "method": "ping", "id": 1}
<-- {"jsonrpc": "2.0", "result": "pong", "id": 1}
'pong'
The request()
method above, is a wrapper
around send(Request())
.
If you’re not interested in a response, use the Notification
class instead
of Request
.
Batch requests¶
JSON-RPC allows you to send multiple requests in a single message:
req = '''[
{"jsonrpc": "2.0", "method": "cat", "id": 1},
{"jsonrpc": "2.0", "method": "dog", "id": 2}
]'''
client.send(req)
Send multiple Request
objects:
client.send([Request('cat'), Request('dog')])
Using list comprehension to get the cube of ten numbers:
client.send([Request('cube', i) for i in range(10)])
Unlike single requests, batch requests return the whole JSON-RPC batch
response - a list of responses
for each request that had an id
member.
The server may not support batch requests.
Configuration¶
Configure the jsonrpcclient package.
Import this module to to configure, for example:
from jsonrpcclient import config
config.validate = False
-
ids
= 'decimal'¶ Configure the
id
part of requests. Can be “decimal”, “hex”, “random” or “uuid”.
-
validate
= True¶ Validate responses against the JSON-RPC schema. Disable to speed up processing.
Configuring the Requests library¶
HTTPClient makes use of Kenneth Reitz’s Requests library. The Session is available so you can configure it before sending any requests.
For example, Basic Auth:
client.session.auth = ('user', 'pass')
SSL authentication:
client.session.verify = '/path/to/certificate'
Custom HTTP headers:
client.session.headers.update({'Content-Type': 'application/json-rpc'})
You can also configure some Requests options when calling
send()
:
client.send(req, verify=True, cert='/path/to/certificate',
headers={'Content-Type': 'application/json-rpc'})
As in the Requests library, any dictionaries passed to send
in named
arguments will be merged with the session-level values that are set. The
method-level parameters override session parameters.