The API Reference

This document will list all available APIs and their documentation (generated from the source code).

---

Inter-process progress reports made easy

class interprog.TaskManager(tasks: List[interprog.TaskType] = <factory>, _totals: Dict[str, int] = <factory>, task_counter: int = 0)

add_task(name: str, total: int | None = None) → None

Enqueue a task

error(message: str) → None

Mark a task as errored with a reason

finish() → None

Mark a task as finished

increment(by: int = 1, silent: bool = True) → None

Increment a bar task

set_total(new_total: int) → None

Set total of the current bar task

start() → None

Start the next task

class interprog.TaskType

For progress: General types

False = hasn’t started str = error True = finished

Spinners

None = in progress

Progress bars

(x, y) = in progress (x out of y tasks finished)