wove.integrations

wove.integrations registers built-in backend adapters and provides the adapter base interface. Backend libraries remain optional; Wove includes adapter code but imports third-party packages only when an adapter is selected.

When selected Wove tasks should run through an existing task system, wove.integrations provides the adapter registry, the base adapter contract, and the worker entrypoints those systems call to return results to Wove.

All built-in backend adapters are dispatch features. Install wove[dispatch] plus the selected backend library in the process that submits work and in any worker environment that executes Wove payloads.

Adapter Registry

Built-in adapter names:

• celery

• temporal

• ray

• rq

• taskiq

• arq

• dask

• kubernetes_jobs

• aws_batch

• slurm

Adapter Contract

A BackendAdapter receives a JSON-safe payload and submits it to a backend. The adapter does not run the task itself. The backend worker must call Wove’s worker entrypoint so the result can be posted back to the callback URL.

Required method:

• submit(payload, frame): submit one task payload and return a backend submission handle.

Optional methods:

• start(): create clients, queues, pools, or connections.

• cancel(run_id, submission, frame): ask the backend to cancel work.

• close(): release adapter-owned clients or pools.

Worker Entrypoints

• wove.integrations.worker.run(payload): synchronous worker entrypoint.

• wove.integrations.worker.arun(payload): async worker entrypoint.

Related Pages

• Backend Adapters: setup pages for the built-in adapters.

• Custom Backend Adapters: implementing an adapter for a project-owned task system.

• wove.backend: callback payload and worker callback helpers.

API Details

class wove.integrations.ARQAdapter(**kwargs)

Bases: BackendAdapter

Parameters:

kwargs (Any)

async close()

Return type:

None

install_hint: str | None = 'arq'

required_modules: Tuple[str, ...] = ('arq',)

async start()

Return type:

None

async submit(payload, frame)

Parameters:

• payload (Dict[str, Any])

• frame (Dict[str, Any])

Return type:

Any

class wove.integrations.AWSBatchAdapter(**kwargs)

Bases: BackendAdapter

Parameters:

kwargs (Any)

async cancel(run_id, submission, frame)

Parameters:

• run_id (str)

• submission (Any)

• frame (Dict[str, Any])

Return type:

None

install_hint: str | None = 'boto3'

required_modules: Tuple[str, ...] = ('boto3',)

async start()

Return type:

None

async submit(payload, frame)

Parameters:

• payload (Dict[str, Any])

• frame (Dict[str, Any])

Return type:

Any

class wove.integrations.BackendAdapter(*, name, config, callback_url, run_config)

Bases: object

Backend-specific submit/cancel bridge used by BackendAdapterEnvironmentExecutor.

Parameters:

• name (str)

• config (Dict[str, Any])

• callback_url (str)

• run_config (Dict[str, Any])

async cancel(run_id, submission, frame)

Parameters:

• run_id (str)

• submission (Any)

• frame (Dict[str, Any])

Return type:

None

async close()

Return type:

None

install_hint: str | None = None

classmethod missing_dependencies()

Return type:

Tuple[str, …]

required_modules: Tuple[str, ...] = ()

async start()

Return type:

None

async submit(payload, frame)

Parameters:

• payload (Dict[str, Any])

• frame (Dict[str, Any])

Return type:

Any

class wove.integrations.CeleryAdapter(**kwargs)

Bases: BackendAdapter

Parameters:

kwargs (Any)

async cancel(run_id, submission, frame)

Parameters:

• run_id (str)

• submission (Any)

• frame (Dict[str, Any])

Return type:

None

install_hint: str | None = 'celery'

required_modules: Tuple[str, ...] = ('celery',)

async start()

Return type:

None

async submit(payload, frame)

Parameters:

• payload (Dict[str, Any])

• frame (Dict[str, Any])

Return type:

Any

class wove.integrations.DaskAdapter(**kwargs)

Bases: BackendAdapter

Parameters:

kwargs (Any)

async cancel(run_id, submission, frame)

Parameters:

• run_id (str)

• submission (Any)

• frame (Dict[str, Any])

Return type:

None

async close()

Return type:

None

install_hint: str | None = 'dask[distributed]'

required_modules: Tuple[str, ...] = ('distributed',)

async start()

Return type:

None

async submit(payload, frame)

Parameters:

• payload (Dict[str, Any])

• frame (Dict[str, Any])

Return type:

Any

class wove.integrations.KubernetesJobsAdapter(*, name, config, callback_url, run_config)

Bases: BackendAdapter

Parameters:

• name (str)

• config (Dict[str, Any])

• callback_url (str)

• run_config (Dict[str, Any])

async cancel(run_id, submission, frame)

Parameters:

• run_id (str)

• submission (Any)

• frame (Dict[str, Any])

Return type:

None

install_hint: str | None = 'kubernetes'

required_modules: Tuple[str, ...] = ('kubernetes',)

async start()

Return type:

None

async submit(payload, frame)

Parameters:

• payload (Dict[str, Any])

• frame (Dict[str, Any])

Return type:

Any

class wove.integrations.RQAdapter(**kwargs)

Bases: BackendAdapter

Parameters:

kwargs (Any)

async cancel(run_id, submission, frame)

Parameters:

• run_id (str)

• submission (Any)

• frame (Dict[str, Any])

Return type:

None

install_hint: str | None = 'rq'

required_modules: Tuple[str, ...] = ('rq',)

async start()

Return type:

None

async submit(payload, frame)

Parameters:

• payload (Dict[str, Any])

• frame (Dict[str, Any])

Return type:

Any

class wove.integrations.RayAdapter(*, name, config, callback_url, run_config)

Bases: BackendAdapter

Parameters:

• name (str)

• config (Dict[str, Any])

• callback_url (str)

• run_config (Dict[str, Any])

async cancel(run_id, submission, frame)

Parameters:

• run_id (str)

• submission (Any)

• frame (Dict[str, Any])

Return type:

None

install_hint: str | None = 'ray'

required_modules: Tuple[str, ...] = ('ray',)

async start()

Return type:

None

async submit(payload, frame)

Parameters:

• payload (Dict[str, Any])

• frame (Dict[str, Any])

Return type:

Any

class wove.integrations.SlurmAdapter(*, name, config, callback_url, run_config)

Bases: BackendAdapter

Parameters:

• name (str)

• config (Dict[str, Any])

• callback_url (str)

• run_config (Dict[str, Any])

async cancel(run_id, submission, frame)

Parameters:

• run_id (str)

• submission (Any)

• frame (Dict[str, Any])

Return type:

None

install_hint: str | None = ''

required_modules: Tuple[str, ...] = ()

async submit(payload, frame)

Parameters:

• payload (Dict[str, Any])

• frame (Dict[str, Any])

Return type:

Any

class wove.integrations.TaskiqAdapter(**kwargs)

Bases: BackendAdapter

Parameters:

kwargs (Any)

install_hint: str | None = 'taskiq'

required_modules: Tuple[str, ...] = ('taskiq',)

async start()

Return type:

None

async submit(payload, frame)

Parameters:

• payload (Dict[str, Any])

• frame (Dict[str, Any])

Return type:

Any

class wove.integrations.TemporalAdapter(**kwargs)

Bases: BackendAdapter

Parameters:

kwargs (Any)

async cancel(run_id, submission, frame)

Parameters:

• run_id (str)

• submission (Any)

• frame (Dict[str, Any])

Return type:

None

install_hint: str | None = 'temporalio'

required_modules: Tuple[str, ...] = ('temporalio',)

async start()

Return type:

None

async submit(payload, frame)

Parameters:

• payload (Dict[str, Any])

• frame (Dict[str, Any])

Return type:

Any

wove.integrations.get_backend_adapter_class(name)

Parameters:

name (str)

Return type:

Type[BackendAdapter]

wove.integrations.get_backend_adapter_dependencies()

Return type:

Dict[str, tuple]

wove.integrations.get_backend_adapter_install_hints()

Return type:

Dict[str, str]

class wove.integrations.base.BackendAdapter(*, name, config, callback_url, run_config)

Bases: object

Backend-specific submit/cancel bridge used by BackendAdapterEnvironmentExecutor.

Parameters:

• name (str)

• config (Dict[str, Any])

• callback_url (str)

• run_config (Dict[str, Any])

async cancel(run_id, submission, frame)

Parameters:

• run_id (str)

• submission (Any)

• frame (Dict[str, Any])

Return type:

None

async close()

Return type:

None

install_hint: str | None = None

classmethod missing_dependencies()

Return type:

Tuple[str, …]

required_modules: Tuple[str, ...] = ()

async start()

Return type:

None

async submit(payload, frame)

Parameters:

• payload (Dict[str, Any])

• frame (Dict[str, Any])

Return type:

Any

async wove.integrations.base.maybe_await(value)

Parameters:

value (Any)

Return type:

Any

async wove.integrations.worker.arun(payload)

Parameters:

payload (Dict[str, Any])

Return type:

Any

wove.integrations.worker.run(payload)

Parameters:

payload (Dict[str, Any])

Return type:

Any

wove.integrations.worker.run_backend_frame(payload)

Parameters:

payload (Dict[str, Any])

Return type:

Any