Skip to content

Exceptions

Async Python SDK for submitting and observing Zeroshot runs.

ZeroshotError

Bases: Exception

Base class for every SDK-originated failure.

ClientClosedError

Bases: ZeroshotError

Raised when an operation uses a client after it has closed.

InvalidRequestError(message: str, *, code: str = 'request.invalid', path: tuple[str | int, ...] | None = None, node: str | None = None, details: Mapping[str, JsonValue] | None = None)

Bases: ZeroshotError

Raised when Zeroshot rejects graph, input, runtime, or run options.

Parameters:

  • message (str) –

    Complete secret-safe native diagnostic.

  • code (str, default: 'request.invalid' ) –

    Stable machine-readable error category.

  • path (tuple[str | int, ...] | None, default: None ) –

    Offending JSON path when native diagnostics provide one.

  • node (str | None, default: None ) –

    Executable graph node when native diagnostics provide one.

  • details (Mapping[str, JsonValue] | None, default: None ) –

    Additional bounded, non-secret native context.

ProtocolError

Bases: ZeroshotError

Raised when native output is malformed or incompatible.

TargetError(message: str, *, exit_code: int | None = None)

Bases: ZeroshotError

Raised when the local sidecar or selected target is unavailable.

Parameters:

  • message (str) –

    Secret-safe target diagnostic.

  • exit_code (int | None, default: None ) –

    Native process exit code when a sidecar command started.

RunFailedError(result: _FailedResult)

Bases: ZeroshotError

Raised only by RunResult.raise_for_failure().

Parameters:

  • result (_FailedResult) –

    Failed terminal result being projected as an exception.

RunNotFoundError(message: str, *, exit_code: int | None = None)

Bases: TargetError

Raised when a target retains no run with the requested public identity.

RunWaitTimeout(run: _RunHandle, wait_timeout: float)

Bases: ZeroshotError

Raised when observation times out while the durable run remains active.

Parameters:

  • run (_RunHandle) –

    Durable run handle that can resume observation while its client remains open.

  • wait_timeout (float) –

    Caller-supplied non-negative deadline in seconds.

MergePlanWaitTimeout(plan: _MergePlanHandle, wait_timeout: float)

Bases: ZeroshotError

Raised when observation times out while a durable merge plan remains active.

Parameters:

  • plan (_MergePlanHandle) –

    Durable plan handle that can resume observation while its client remains open.

  • wait_timeout (float) –

    Caller-supplied non-negative deadline in seconds.

SubmissionConflictError(message: str, *, existing_run_id: str, exit_code: int | None = None)

Bases: TargetError

Raised when an idempotency key conflicts with a different submission.

Parameters:

  • message (str) –

    Secret-safe native conflict diagnostic.

  • existing_run_id (str) –

    Public identity already bound to the submission key.