API Reference

Complete reference for all public classes, methods, and attributes exported by osiiso.

---

Public API

from osiiso import (
    # Core queues
    AsyncQueue,
    SharedQueue,
    ThreadQueue,
    ProcessQueue,

    # Handles
    TaskHandle,
    SyncTaskHandle,

    # Groups & completion iteration
    TaskGroup,
    SyncTaskGroup,
    as_completed,
    iter_completed,

    # Options & results
    TaskOptions,
    TaskResult,
    RunSummary,

    # Exceptions
    OsiisoError,
    ClosedError,
    QueueFullError,
    ExecutionError,

    # Runner & one-shot helpers
    run,
    amap,
    tmap,
    pmap,
)

---

Reference Pages

Queues

Class	Description
AsyncQueue	Asyncio-native task queue
SharedQueue	AsyncQueue with thread-safe submission
ThreadQueue	Thread-based queue for blocking work
ProcessQueue	Process-based queue for CPU-heavy work

Configuration

Class	Description
TaskOptions	Immutable task configuration

Handles & Groups

Class	Description
TaskHandle	Async handle (awaitable)
SyncTaskHandle	Blocking handle
TaskGroup	Async group
SyncTaskGroup	Blocking group

Results

Class	Description
TaskResult	Immutable record of a single task
RunSummary	Aggregate summary of a queue run

Exceptions

Class	Description
OsiisoError	Base exception
ClosedError	Queue is closed
QueueFullError	Bounded AsyncQueue is full
ExecutionError	Tasks failed

Utilities

Function	Description
run()	Convenience runner with uvloop support
amap() / tmap() / pmap()	One-shot mapping helpers returning ordered values
as_completed() / iter_completed()	Yield handles in completion order