'structured concurrent `trio`-"actors"' https://github.com/goodboy/tractor

Go to file

Tyler Goodlet 90c987d0ae Further tweaks, add non-scary snippet		2021-02-25 09:10:18 -05:00
.github/workflows	Include Python 3.9 in CI	2020-12-27 13:28:54 -05:00
docs	Further tweaks, add non-scary snippet	2021-02-25 09:10:18 -05:00
examples	Remove tractor run from some debug examples	2021-02-24 13:14:40 -05:00
tests	Use root as default name from `tractor.run()`	2021-02-25 08:51:28 -05:00
tractor	Use root as default name from `tractor.run()`	2021-02-25 08:51:28 -05:00
.gitignore	Initial commit	2018-07-05 16:01:15 -04:00
LICENSE	Initial commit	2018-07-05 16:01:15 -04:00
mypy.ini	Add mypy.ini lel	2020-01-21 15:28:12 -05:00
requirements-docs.txt	Added logo, fixed github links and grammar issues	2020-08-31 11:49:14 -03:00
requirements-test.txt	Add `pexpect` dep for debugger tests	2020-10-13 11:04:16 -04:00
setup.py	Test putting readme in docs dir	2021-02-21 17:52:04 -05:00

docs/README.rst

tractor

The Python async-native multi-core system you always wanted.

tractor is a structured concurrent "actor model" built on trio and multi-processing.

It is an attempt to pair trionic structured concurrency with distributed Python. You can think of it as a trio -across-processes or simply as an opinionated replacement for the stdlib's multiprocessing but built on async programming primitives from the ground up.

Don't be scared off by this description. tractor is just ``trio`` but with nurseries for process management and cancel-able IPC. If you understand how to work with trio, tractor will give you the parallelism you've been missing.

tractor's nurseries let you spawn trio "actors": new Python processes which each run a trio scheduled task tree (also known as an async sandwich - a call to trio.run()). That is, each "Actor" is a new process plus a trio runtime.

"Actors" communicate by exchanging asynchronous messages and avoid sharing state. The intention of this model is to allow for highly distributed software that, through the adherence to structured concurrency, results in systems which fail in predictable and recoverable ways.

The first step to grok tractor is to get the basics of trio down. A great place to start is the trio docs and this blog post.

Install

No PyPi release yet!

pip install git+git://github.com/goodboy/tractor.git

Alluring Features

It's just trio, but with SC applied to processes (aka "actors")
Infinitely nesteable process trees
Built-in API for inter-process streaming
A (first ever?) "native" multi-core debugger for Python using pdb++
(Soon to land) asyncio support allowing for "infected" actors where trio drives the asyncio scheduler via the astounding "guest mode"

The example you're probably after...

It seems the initial query from most new users is "how do I make a worker pool thing?".

tractor is built to handle any SC process tree you can imagine; the "worker pool" pattern is a trivial special case:

# TODO: workerpool example

Feel like saying hi?

This project is very much coupled to the ongoing development of trio (i.e. tractor gets most of its ideas from that brilliant community). If you want to help, have suggestions or just want to say hi, please feel free to reach us in our matrix channel. If matrix seems too hip, we're also mostly all in the the trio gitter channel!