splut 25

Actor model for Python

splut

Actor model for Python.

This README is auto-generated, see project wiki for details.

API

splut.actor

ActorHandle Objects

class ActorHandle(Parabject)

__getattr__

def __getattr__(name)

Return a function to add a message to the mailbox, for execution by a capable worker when one becomes free.

__getitem__

def __getitem__(key)

Index or slice workers by the given key and return an actor handle backed by the resulting workers.

__iter__

def __iter__()

For each worker, yield an actor handle backed by that worker specifically.

Spawn Objects

class Spawn()

__init__

def __init__(executor)

Spawned actors will use threads from the given executor.

__call__

def __call__(*objs)

Create an actor backed by the given worker object(s), each of which is used in a single-threaded way. Calling a method on the returned actor returns a Future immediately, which eventually becomes done with the result of a worker method of the same name (or never if the worker method hangs). A worker method may be async, in which case it can await futures returned by other actors, releasing the worker in the meantime.

Join Objects

class Join()

Make multiple futures awaitable as a unit. In the zero futures case this resolves (to an empty list) without suspending execution. Otherwise if any future hangs, so does this. Otherwise if any future failed, all such exceptions are raised as a chain. Otherwise all results are returned as a list.

ManualExecutor Objects

class ManualExecutor()

Utilise the main (or any other) thread directly.

run

def run()

Execute tasks until interrupted. Typical usage is for the main thread to call this after setting up the system.

putinterrupt

def putinterrupt()

Cause exactly one thread to exit the run method soon.

splut.actor.future

Future Objects

class Future()

wait

def wait()

Block until there is an outcome, then return/raise it. For use outside actors, or within one if you know the future is done and don't want to suspend execution with await in that case.

andforget

def andforget(log)

Send any exception to the given log.

splut.bg

Sleeper Objects

class Sleeper()

interrupt

def interrupt()

If a sleep is in progress that sleep returns now, otherwise the next sleep will return immediately. This is similar behaviour to interrupting a maybe-sleeping thread in Java.

splut.bg.delay