chronaxis.BatchJobResult

Import this object from chronaxis. This page covers directly public members and necessary construction/context protocols. See the Chinese implementation reference for internals. Return to the public API index. Check required parameters, defaults, returns, and exceptions before calling.

`BatchJobResult`

Store a job's final state. If cleanup fails after publication, status remains failed and the published path is retained.

python

BatchJobResult(job_id: str, status: str, plan_path: str | None = None, plan_identity: str | None = None, dataset_id: str | None = None, entity_id: str | None = None, session_id: str | None = None, input_identity: str | None = None, run_id: str | None = None, output_dir: pathlib.Path | None = None, manifest_path: pathlib.Path | None = None, error_type: str | None = None, error_message: str | None = None, error_chain: tuple[str, ...] = (), elapsed_seconds: float = 0.0, memory_budget_bytes: int | None = None, worker_pid: int | None = None, recovery: chronaxis.batch.models.CleanupHandle | None = None) -> None

Name	Type	Required	Default	Purpose, choices, and effect
`job_id`	str	Yes	No default	Original job identity.
`status`	str	Yes	No default	`completed`: analysis, publication, and cleanup all succeeded. `failed`: any stage failed; inspect diagnostics. `cancelled`: cancellation or fail_fast prevented further execution. Failure and cancellation are distinct.
`plan_path`	str \| None	No	None	Absolute original plan-file path. Normally None when an AnalysisPlan was supplied directly.
`plan_identity`	str \| None	No	None	Obtained plan's declaration identity, not an input-content hash. None when the file plan is not yet loaded or failed to load.
`dataset_id`	str \| None	No	None	Obtained plan's `dataset.name`; None if not loaded or loading failed. The result property remains named `dataset_id`.
`entity_id`	str \| None	No	None	Optional `dataset.entity`, falling back to `dataset.name`; None if no plan was obtained.
`session_id`	str \| None	No	None	Optional `dataset.session`, falling back to `dataset.name`; None if no plan was obtained.
`input_identity`	str \| None	No	None	Input-summary identity returned by AnalysisRunner. None if no result was returned or no summary was requested; successful runs may also have None.
`run_id`	str \| None	No	None	Run ID when AnalysisRunner returned a result. None if failure/cancellation occurred before that.
`output_dir`	Path \| None	No	None	Formal directory after successful publication. Retained if subsequent cleanup fails, while status is failed.
`manifest_path`	Path \| None	No	None	Actual timestamped completion manifest for this job. None if no output was published. Read its `outputs` entries to locate this run's tables.
`error_type`	str \| None	No	None	Exception class or `not_started` cancellation marker. None on completion; read with status and error_chain.
`error_message`	str \| None	No	None	Specific failure/cancellation explanation; None on completion. Causes and cleanup notes are in error_chain.
`error_chain`	tuple[str, ...]	No	()	Cause chain and cleanup notes, retaining error origin.
`elapsed_seconds`	float	No	0.0	Job wall-clock seconds, including publication and cleanup, not CPU time.
`memory_budget_bytes`	int \| None	No	None	Obtained plan's new-analysis-layer budget in bytes. None when no plan was loaded, not zero bytes.
`worker_pid`	int \| None	No	None	PID of the analysis worker that actually executed the job. None for unstarted jobs. Jobs reusing a process may share a PID.
`recovery`	CleanupHandle \| None	No	None	Handle retained after failed cleanup; call close() to retry. None after normal cleanup. Excluded from JSON. Type link is a Chinese implementation reference.

`BatchJobResult.to_dict`

Convert job status, output directory, and errors to a report dictionary.

python

BatchJobResult.to_dict() -> dict

No explicit parameters. Returns a JSON-compatible dict. No documented exceptions; resource objects are not serialized.

Source locations

src/chronaxis/batch/models.py:136 — line at 8904c2f744951857659abd40aaa3535d57faf53c.
src/chronaxis/batch/models.py:165 — line at 8904c2f744951857659abd40aaa3535d57faf53c.