API

class pytask_parallel.ParallelBackend(*values)[source]

Choices for parallel backends.

NONE

No parallel backend.

CUSTOM

A custom parallel backend.

DASK

A dask parallel backend.

LOKY

A loky parallel backend.

PROCESSES

A process pool parallel backend.

THREADS

A thread pool parallel backend.

class pytask_parallel.ParallelBackendRegistry[source]

Registry for parallel backends.

get_parallel_backend(kind: ParallelBackend, n_workers: int) → Executor[source]

Get a parallel backend.

register_parallel_backend(kind: ParallelBackend, builder: Callable[..., Executor], *, worker_type: WorkerType | str = WorkerType.PROCESSES, remote: bool = False) → None[source]

Register a parallel backend.

reset() → None[source]

Register the default backends.

class pytask_parallel.WorkerType(*values)[source]

A type for workers that either spawned as threads or processes.

THREADS

Workers are threads.

PROCESSES

Workers are processes.

pytask_parallel.registry = ParallelBackendRegistry()

Registry for parallel backends.

An instantiated ParallelBackendRegistry to register or overwrite parallel backends.