Versions

Build a version

Description

aiomas is an easy-to-use library for remote procedure calls (RPC) and multi-agent systems (MAS). It’s written in pure Python on top of asyncio.

Here is an example how you can write a simple multi-agent system:

>>> import asyncio
>>> import aiomas
>>>
>>> class TestAgent(aiomas.Agent):
...     def __init__(self, container, addr):
...         super().__init__(container, addr)
...         print('Ohai, I am %s' % self)
...
...     @asyncio.coroutine
...     def run(self, addr):
...         remote_agent = yield from self.container.connect(addr)
...         ret = yield from remote_agent.service(42)
...         print('%s got %s from %s' % (self, ret, remote_agent))
...
...     @aiomas.expose
...     def service(self, value):
...         return value
>>>
>>> c = aiomas.Container(('localhost', 5555))
>>> agents = [c.spawn(TestAgent) for i in range(2)]
Ohai, I am TestAgent('tcp://localhost:5555/0')
Ohai, I am TestAgent('tcp://localhost:5555/1')
>>> aiomas.run(until=agents[0].run(agents[1].addr))
TestAgent('tcp://localhost:5555/0') got 42 from TestAgentProxy('tcp://localhost:5555/1')
>>> c.shutdown()

aiomas is released under the MIT license. It requires Python 3.4 and above and runs on Linux, OS X, and Windows.

Installation

aiomas requires Python >= 3.4. It uses the JSON codec by default and only has pure Python dependencies.

Install aiomas via pip by running:

$ pip install aiomas

You can enable the optional MsgPack codec or its Blosc compressed version by installing the corresponding features (note, that you need a C compiler to install them):

$ pip install aiomas[mp]   # Enables the MsgPack codec
$ pip install aiomas[mpb]  # Enables the MsgPack and MsgPackBlosc codecs

Features

aiomas just puts three layers of abstraction around raw TCP / unix domain sockets provided by asyncio:

Agents and agent containers:

The top-layer provides a simple base class for your own agents. All agents live in a container.

Containers take care of creating agent instances and performing the communication between them.

The container provides a clock for the agents. This clock can either be synchronized with the real (wall-clock) time or be set by an external process (e.g., other simulators).

RPC:

The rpc layer implements remote procedure calls which let you call methods on remote objects nearly as if they were normal objects:

Instead of ret = obj.meth(arg) you write ret = yield from obj.meth(arg).

Request-reply channel:
The channel layer is the basis for the rpc layer. It sends JSON or MsgPack encoded byte strings over TCP or unix domain sockets. It also maps replies (of success or failure) to their corresponding request.

Although you usually want to use the agent layer, it is perfectly okay to only use the rpc or channel layer.

Planned features

Some ideas for future releases:

  • SSL/TLS support for TCP sockets
  • Optional automatic re-connect after connection loss
  • Helper for binding a socket to a random free port

Contribute

Set-up a development environment with:

$ virtualenv -p `which python3` aiomas
$ pip install -r requirements.txt

Run the tests with:

$ py.test
$ # or
$ tox

License

The project is licensed under the MIT license.

Repository

https://bitbucket.org/sscherfke/aiomas

Last Built

11 months, 3 weeks ago passed

Owners

Home Page

https://bitbucket.org/sscherfke/aiomas

Badge

Project Privacy Level

Public

Short URLs

aiomas.readthedocs.io
aiomas.rtfd.io

Default Version

latest

'latest' Version

default