Skip to main content

fast JSON-RPC protocol implementation for asyncio, without transport

Project description

aio-jsonrpc-2.0

Build Status Coverage Status

Description

json rpc 2.0 protocol implementation for asyncio, without transport.

specification: http://www.jsonrpc.org/

Usage:

Example to resolve request:

import asyncio
import json

from aio_jsonrpc_20 import RequestResolver


async def foo(msg):
    await asyncio.sleep(0.1)
    return 'foobar ' + str(msg)

router = {'foo': foo}
resolver = RequestResolver(router)
json_request = json.dumps(
    {"jsonrpc": "2.0", "method": "foo", "params": ["toto"], "id": 1}
)


async def main():
    json_response = await resolver.handle(json_request)
    print(json_response)

loop = asyncio.get_event_loop()
loop.run_until_complete(main())

Result:

{"jsonrpc": "2.0", "result": "foobar toto", "id": 1}

Example to build request:

from aio_jsonrpc_20 import RequestBuilder

builder = RequestBuilder()
json_request = builder.call(method="foo", params={"name": "bar"})
print(json_request)
json_request = builder.call(method="foo", params={"name": "bar2"})
print(json_request)
json_request = builder.notify(method="log", params=["hello"])
print(json_request)

Result:

{"jsonrpc": "2.0", "method": "foo", "params": {"name": "bar"}, "id": 1}
{"jsonrpc": "2.0", "method": "foo", "params": {"name": "bar2"}, "id": 2}
{"jsonrpc": "2.0", "method": "log", "params": ["hello"]}

Example to build batch request:

from aio_jsonrpc_20 import BatchRequestBuilder

batch_builder = BatchRequestBuilder()
id1 = batch_builder.call(method="foo", params={"name": "bar"})
id2 = batch_builder.call(method="foo2", params={"name": "bar"})
print(id1, id2)
batch_builder.notify(method="foo3", params={"name": "bar"})
json_request = batch_builder.get_request()
print(json_request)

Result:

1 2
[
    {"jsonrpc": "2.0", "method": "foo", "params": {"name": "bar"}, "id": 1},
    {"jsonrpc": "2.0", "method": "foo2", "params": {"name": "bar"}, "id": 2},
    {"jsonrpc": "2.0", "method": "foo3", "params": {"name": "bar"}}
]

TODO:

  • Fix definitely interface for builders
  • More Test
  • Documentation
  • Optimisation
  • ...

Testing:

py.test --cov=aio_jsonrpc_20 --cov-report term-missing tests/

0.1.2

fix(README): Fixed encoding error

0.1.0

Initial release.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aio-jsonrpc-2.0-0.1.2.tar.gz (7.5 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page