icij-worker 0.17.17

Create asynchronous tasks from Python functions

ICIJ's async worker library

Installation

With AMQP:

pip install icij-worker["amqp"]

With neo4j:

pip install icij-worker["neo4j"]

Usage

Create an async app and register tasks

Create asynchronous task tailored for long running Python functions:

Given the following pure Python function inside the app.py module:

def long_running_task(greeted: str) -> str:
    greeting = f"Hello {greeted} !"
    return greeting

decorate your function with ICIJApp class and register a new task:

from icij_worker import AsyncApp

my_app = AsyncApp(name="my_app")

@my_app.task
def long_running_task(greeted: str) -> str:
    greeting = f"Hello {greeted} !"
    return greeting

this will register the long_running_task function under the long_running_task task name.

Optionally add progress handlers for a better task monitoring:

@my_app.task
async def long_running_task(
    greeted: str,
    progress: Optional[Callable[[float], Awaitable]] = None
) -> str:
    if progress is not None:
        await progress(0.0)
    greeting = f"Hello {greeted} !"
    if progress is not None:
        await progress(100.0)
    return greeting

Launch a async worker pool

Start a worker pool using:

icij-worker workers start "app.my_app"

provide worker pool options using:

icij-worker workers start -c worker_config.json -n 2 --backend multiprocessing "app.my_app"

depending on the worker configuration additional setup might be required.

Async worker implementations

• Neo4j
• AMQP (v0.9.1 based on RabbitMQ)

Worker asynchronous backends

Implemented

• multiprocessing for CPU bound tasks

To be implemented

• asyncio for I/O bound tasks