A fast python rpc library based on asyncio and MessagePack

choleraehyq choleraehyq Last update: Nov 30, 2023

aiorpc

https://badge.fury.io/py/aiorpc.png https://travis-ci.org/choleraehyq/aiorpc.png?branch=master

aiorpc is a lightweight asynchronous RPC library. It enables you to easily build a distributed server-side system by writing a small amount of code. It is built on top of asyncio and MessagePack.

Note aiorpc is under development, should not be considered to have a stable API.

Installation

To install aiorpc, simply:

$ pip install aiorpc

Examples

RPC server

from aiorpc import RPCServer

import asyncio
import uvloop


def echo(msg):
    return msg

rpc_server = RPCServer()
loop = uvloop.new_event_loop()
asyncio.set_event_loop(loop)
rpc_server.register("echo", echo)
coro = asyncio.start_server(rpc_server.serve, '127.0.0.1', 6000, loop=loop)
server = loop.run_until_complete(coro)

try:
    loop.run_forever()
except KeyboardInterrupt:
    server.close()
    loop.run_until_complete(server.wait_closed())

RPC client

from aiorpc import RPCClient

import asyncio
import uvloop

async def do(cli):
    ret = await client.call('echo', 'message')
    print("{}\n".format(ret))

loop = uvloop.new_event_loop()
asyncio.set_event_loop(loop)
client = RPCClient('127.0.0.1', 6000)
loop.run_until_complete(do(client))
client.close()

aiorpc client can also be used as an async context manager:

async def do():
    async with RPCClient('127.0.0.1', 6000) as client:
        ret = await client.call('echo', 'message')
        print("{}\n".format(ret))

Performance

aiorpc with uvloop significantly outperforms ZeroRPC (6x faster), which is built using ZeroMQ and MessagePack and slightly underperforms official MessagePack RPC (0.7x slower), which is built using Facebook's Tornado and MessagePack.

  • aiorpc
% pip install uvloop
% python benchmarks/benchmark_aiorpc_inet.py
call: 2236 qps
  • Official MesssagePack RPC
% pip install msgpack-rpc-python
% python benchmarks/benchmark_msgpackrpc.py
call: 3112 qps
  • ZeroRPC
% pip install zerorpc
% python benchmarks/benchmark_zerorpc.py
call: 351 qps

Documentation

Documentation is available at http://aiorpc.readthedocs.org/.

Tags:

Subscribe to our newsletter