jsonrpcclient 1.0.9

JSON-RPC 2.0 client library for Python 3

JSON-RPC 2.0 client library for Python 3.

To make a remote procedure call:

1. Set the server address

2. Use request() to call the remote method

>>> import jsonrpcclient
>>> server = jsonrpcclient.Server('http://example/')
>>> server.request('add', 2, 3)
--> {"jsonrpc": "2.0", "method": "add", "params": [2, 3], "id": 1}
<-- 200 {"jsonrpc": "2.0", "result": 5, "id": 1}
5

The first argument to request() is the method name; everything else is passed as parameters. You can pass any number of positional or keyword arguments, and they will be translated into JSON-RPC.

>>> server.request('find', 42, name='Foo')
--> {"jsonrpc": "2.0", "method": "find", "params": [42, {"name": "Foo"}], "id": 1}
<-- 200 {"jsonrpc": "2.0", "result": "Bar", "id": 1}
Bar

If you don’t need any data returned, use notify() instead:

>>> server.notify('go')
--> {"jsonrpc": "2.0", "method": "go"}
<-- 200 OK

Shorthand

There’s another way to send messages:

>>> server.add(2, 3, response=True)
--> {"jsonrpc": "2.0", "method": "add", "params": [2, 3], "id": 1}
<-- 200 {"jsonrpc": "2.0", "result": 5, "id": 1}
5

The library catches the undefined add() call, and sends it as a JSON-RPC message.

response=True tells the server you’re expecting a response; without that it’s a notification.

Authentication

Make authenticated requests by passing a second argument to Server().

>>> server = jsonrpcclient.Server('http://example/', auth=('user', 'pass'))

For more options, see the requests which handles the authentication.

Exceptions

You should catch RPCClientException. This will be raised in the event of connection problems, or if the server responded with a JSON-RPC error response.

try:
    server.go()
except jsonrpcclient.exceptions.RPCClientException as e:
    print(str(e))

Logging

To see the underlying JSON messages, set the logging level to INFO or lower:

import logging
logging.getLogger('jsonrpcclient').setLevel(logging.INFO)

Issue tracker is here.

If you need a server, try my jsonrpcserver library.

Changelog

1.0.9 - 2014-12-02

• Added authentication.

• Messages are now output on the INFO log level.

1.0.8 - 2014-12-02

• Show the response status code in the log.

1.0.7 - 2014-11-21

• When using the “alternate” (server.add()) method to make a request, only send “id” if response=True is explicitly passed (fixed)

• The underlying JSON messages are now hidden by default. To see them you should increase the logging level (see above).

• Tests moved into separate “tests” dir.

1.0.6 - 2014-11-11

• Fixed installer.

1.0.5 - 2014-11-10

• Better logging.

1.0.4 - 2014-11-10

• “Proxy” class renamed to “Server”.

• Logging improved.