Create asynchronous tasks from Python functions
Project description
ICIJ's async worker library
Installation
pip install icij-worker
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:
my_app = ICIJApp(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
def long_running_task(greeted: str, progress_handler: Callable[[float], None]) -> str:
progress_handler(0.0)
greeting = f"Hello {greeted} !"
progress_handler(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
Worker asynchronous backends
Implemented
- multiprocessing for CPU bound tasks
To be implemented
- asyncio for I/O bound tasks
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
icij_worker-0.2.3.tar.gz
(33.6 kB
view hashes)
Built Distribution
Close
Hashes for icij_worker-0.2.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f0a0b4c381525e06ecd414a1ba09378934523af84c7ecef1566c72b013c8efdb |
|
MD5 | 8bebafb9966393a7d4de244933666cb6 |
|
BLAKE2b-256 | 59ddc025732404b1d1de377abe91d53d28251c7eaccd94b6ba21caa9582d375e |