aplay

python actor model implement using asyncio

Install

---

pip install aplay

from 1.0.0 there is breaking change in api

Usage

Get Started

import sys
import os
import asyncio
import random
from aplay.kernel.actor import Actor
from aplay.kernel.system import KernelActor
from aplay.mailstation.simple import HashMailStation

from collections import defaultdict
from copy import deepcopy


class Monitor(Actor):
    def __init__(self, *args, **kwargs):
        super(Monitor, self).__init__(*args, **kwargs)
        self.count_num = defaultdict(int)
        self.displayer = self.create_actor(name="display", actor_cls=Displayer)

    async def msg_handler(self, msg=None):
        if msg is not None:
            msg_type = msg.get("msg_type")
            self.count_num[msg_type] += 1
        await self.displayer.tell(deepcopy(self.count_num))


class Displayer(Actor):
    async def msg_handler(self, msg=None):
        if msg is not None:
            print("-----monitor num----", msg)
        await self.send_to_address("/test", msg)


class Worker(Actor):
    def __init__(self, *args, **kwargs):
        super(Worker, self).__init__(*args, **kwargs)
        self.worker_monitor = self.create_actor(name="count", actor_cls=Monitor)

    async def msg_handler(self, msg=None):
        print("worker--", msg)
        if msg is None:
            return
        else:
            msg_type = msg.get("msg_type")
            if msg_type == "text":
                print("--text--", msg)
            else:
                # cc = 1 / 0
                print("--voice--", msg)
            await self.worker_monitor.tell(msg)


class MyKernel(KernelActor):
    def __init__(self, name=None, mail_station=None, **kwargs):
        print(mail_station, kwargs)
        super(MyKernel, self).__init__(name=name, mail_station=mail_station, **kwargs)
        self.actor = self.create_actor(name="test", actor_cls=Worker)

    async def msg_handler(self, msg=None):
        print("mykernel", msg)

        for i in range(100):
            tt = random.choice(["voice", "text"])
            msg = {"msg_type": tt, "content": f"hello {tt} {i}"}
            await self.send_to_address("/test", msg)


bb = MyKernel("kernel", mail_station=HashMailStation())
bb.tell_nowait("start")
bb.start()

and more you can refer to the example dirs

you can use it as a task queue and something else.if you dont want too heavy of celery or rq ,etc

just enjoy it

instructions

KernelActor means the kernel to start or daemon the whole program. 
it is only one process,you will have to use multiprocess if you want to utilize multi cores.

Actor is the basic class for worker actor and the kernel.

for worker actor ,you only need to inherit this class and define your funcion that needed. 

Actor Details in Table

property

name	description	useage
_name	actor's name	for identitify the actor
_mail_station	actor's mail_station	the place to send or receive msg and delivery msg
_child	actor's children (instances of actor)	the actors start by itself
_runing_state	actor's running state	state the running state of the actor
_human_runing_state	stopped by human	for manually stop the actor and by default ,it cant be started by its parent
_parent	actor's parent actor	actor's parent
_address	the actor's address that register in the mail station	mail address
_loop	actor's loop	actor's loop

functions need to inderited

function name	usage	must	description	default
decide_to_start	decide to start itself	not	to decide itself start or not. actor can be in any state. you can implement this function to make your own decision	only human stopped state can prevent the actor starting.
user_task_callback	task done callback	not	the callback of a task. can be with success and exception msg.	do nothing
prepare_children	prepare to create or get the child actor	not	if you need child actor,you must inplement this, and add your child actor creator in here	do nothing
prepare_mailbox	prepare the mailbox	not	if you want to define your own async mailbox or use redisMailbox	do nothing
msg_handler	the working function	yes	the only funcion that really do the jobs	not Implement

tips

actors are defined in class. you can create lots of actors in one actor.
but do not Circular create actors. 
such as you have a A_actor and B_actor,A_actor creates lots of B_actor, and B_actor creates lots of A_actor.

you can define lots of B_actor from A_actor with different names. and these actors can do lots of work based on different msg types

why this lib

this lib intends to Decoupling the work flow using actor-like system,which utilize the asyncio to make work efficiently.

we dont define the msg format just for you have the freedom to adjust to your program. it is you to guarantee your msg format's complete.

the commong workflow is single-forward, just as follows:

say you have A-actor,B-actor,C-actor:

A-actor work done then transfer msg to B-actor then to C-actor. no backwards.

Requirements

• Python_ 3.5+ https://www.python.org

License

The aplay is offered under AGPLV3 license.