status#

class BatchStatus(children: list[~_canary.job.Job], base: ~_canary.status.Status = <factory>)#

Bases: object

Aggregate status for a batch job.

  • base is the batch job’s own terminal status (submission errors, etc.).

  • display/derived semantics are computed from child jobs.

children: list[Job]#
base: Status#
property category: Category#
property outcome: Outcome#
property reason: str | None#
property code: int#
is_success() bool#
is_failure() bool#
is_skipped() bool#
is_cancelled() bool#
set_base(*, category: Category | str | None = None, outcome: Outcome | str | None = None, reason: str | None = None, code: int = -1) None#

Update only the batch job’s own status.

set(*, category: Category | str | None = None, outcome: Outcome | str | None = None, reason: str | None = None, code: int = -1) None#

Set the batch base status and propagate to children that are DONE.

NOTE: We should not mutate non-DONE children results except to mark them cancelled/broken if they were unexpectedly still RUNNING at batch end.

display_name(**kwargs: Any) str#

Return summary string like: FAIL (2 FAILED, 1 TIMEOUT, 3 SUCCESS)