pycampers/zproc

P.S.A.: Not suitable for use in production. In a beta stage right now.

Behold, the power of ZProc:

import zproc


ctx = zproc.Context(wait=True)  # wait for processes in this context
ctx.state["cookies"] = 0

@zproc.atomic
def eat_cookie(state):
    """Eat a cookie atomically."""
    
    state["cookies"] -= 1
    print("nom nom nom")


@zproc.atomic
def bake_cookie(state):
    """Bake a cookie atomically."""

    state["cookies"] += 1
    print("Here's a cookie!")


@ctx.call_when_change("cookies")
def cookie_eater(state):
    """Eat cookies as they're baked."""

    eat_cookie(state)


@ctx.process
def cookie_baker(state):
    """Bake some cookies."""

    for i in range(5):
        bake_cookie(state)

output

Here's a cookie!
Here's a cookie!
nom nom nom
Here's a cookie!
nom nom nom
Here's a cookie!
nom nom nom
Here's a cookie!
nom nom nom
nom nom nom

(baker and eater run in different processes)

Install

pip install zproc

License: MIT License (MIT)
Requires: Python >=3.5

Documentation ( )

Read the docs

Examples

Why use ZProc?

At the surface, it's just a better API for Message passing parallelism (using ZMQ).

Message passing can be tedious because of all the manual wiring involved.

ZProc lets you do message passing parallelism with a more pythonic, safe, easy-to-use interface.

It does that by providing a global dict called state.
The state is not a shared object.
It works purely on message passing.

It also supports a fair bit of reactive programming, using state watchers.

Behind the covers, it uses the Actor Model.

It also borrows the autoretry feature of Celery, but unlike Celery it doesn't need a broker.

Bottom line, you'll have a lot more fun doing parallel/concurrent programming using ZProc, than anything else.

Features

• 🌠   Asynchronous paradigms without async def

  • Build a combination of synchronous and asynchronous systems, with ease.
  • By watching for changes in state, without Busy Waiting.
  • 🔖

• 🌠   Process management

  • Process Factory
  • Remembers to kill processes when exiting, for general peace. (even when they're nested)
  • Keeps a record of processes created using ZProc.
  • 🔖

• 🌠   Atomic Operations

  • Perform an arbitrary number of operations on state as a single, atomic operation.
  • 🔖

Caveats

• The state only gets updated if you do it directly.
  This means that if you mutate objects inside the state, they wont get reflected in the global state.

• The state should be pickle-able.

• It runs an extra Process for managing the state.
  Its fairly lightweight though, and shouldn't add too much weight to your application.

FAQ

• Fast?

  • Above all, ZProc is written for safety and the ease of use.
  • However, since its written using ZMQ, it's plenty fast for most stuff.
  • Run -> 🔖 for a taste.

• Stable?

  • Mostly. However, since it's still in the 0.x.x stage, you can expect some API changes.

• Production ready?

  • Please don't use it in production right now.

• Windows compatible?

  • Probably?

Inner Workings

• ZProc uses a Server, which is responsible for storing and communicating the state.

  • This isolates our resource (state), and makes it safer to do atomic operations.

• The process(s) communicate through ZMQ sockets, over ipc://.

  • The clients (Proceses) use a ZMQ_DEALER socket.
  • The Server uses a ZMQ_ROUTER socket.

• If a Process wishes to watch the state, it subscribes to a global publish message.

  • The zproc server publishes the state at every state update. (using ZMQ_PUB socket)
  • A Process may subscribe to this message and filter out the event it needs (using ZMQ_SUB socket).
  • zmq sockets block your application efficiently till an update occurs, eliminating the need for Busy Waiting.

(Busy waiting refers to the while True: <check condition> approach).

Local development

git clone https://github.com/pycampers/zproc.git
cd zproc
pipenv install

Build documentation

Assuming you have sphinx installed (Linux)

cd docs
pipenv run ./build.sh

ZProc in the wild

• Oscilloscope

• Muro

Thanks

• Thanks to open logos for providing the wonderful ZProc logo.
• Thanks to pieter hintjens, for his work on the ZeroMQ library and for his amazing book.
• Thanks to tblib, ZProc can raise First-class Exceptions from the zproc server!
• Thanks to psutil, ZProc can handle nested procesess!
• Thanks to Kennith Rietz. His setup.py was used to host this project on pypi. Plus lot of documentation is blatantly copied from his documentation on requests

ZProc is short for Zero Process.

🐍🏕️