ChronaxisUser manual中文
API reference / chronaxis.BatchReport
On this pageMembersBatchReportBatchReport.statusBatchReport.to_dictBatchReport.closeSource locations

chronaxis.BatchReport

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.

Members

BatchReport

Summarize results in original job order. Each job's numerical tables remain in its own directory; this report does not combine values across different analysis definitions.

python
BatchReport(output_dir: pathlib.Path, jobs: tuple[chronaxis.batch.models.BatchJobResult, ...], process_count: int, fail_fast: bool, cancel_requested: bool, device_label: str, worker_process_count: int = 0, infrastructure_error: str | None = None, report_path: pathlib.Path | None = None, _publication: object = None) -> None
Name Type Required Default Purpose, choices, and effect
output_dir Path Yes No default Reusable batch output root; existing files are preserved.
jobs tuple[BatchJobResult, ...] Yes No default Final results in declaration order regardless of worker completion order.
process_count int Yes No default Configured positive maximum analysis-worker count. Scheduling defaults to 1; direct construction here requires a value. Excludes scheduler and CAN reader subprocesses. Fewer/zero jobs need fewer/zero workers.
fail_fast bool Yes No default Whether dispatch stops after observing a failure.
cancel_requested bool Yes No default Whether user cancellation or KeyboardInterrupt was observed.
device_label str Yes No default Nonempty batch-report source-device label. Only run_batch/BatchRunner.run default this to pending. Does not override child metadata.device_label.
worker_process_count int No 0 Actual number of analysis workers started, possibly less than process_count. Zero for an empty or pre-cancelled batch. Excludes CAN reader subprocesses.
infrastructure_error str | None No None Scheduler/report-infrastructure error. None means no such error was recorded, not that all jobs succeeded. Inspect each job's status and diagnostics.
report_path Path | None No None Actual timestamped report path after run_batch publishes it. None when BatchRunner.run has only run jobs and has not written a report.
_publication object No None Internal reservation for batch names and cleanup. Callers should not supply this field.

BatchReport.status

python
BatchReport.status: str

Property: read without parentheses. No parameters. Returns failed, cancelled, or completed, with failure taking precedence. No documented exceptions.

BatchReport.to_dict

python
BatchReport.to_dict() -> dict

No explicit parameters. Returns a JSON-compatible dict containing identities and counts. Does not aggregate calculation values. No documented exceptions.

BatchReport.close

Retry all unfinished cleanup.

python
BatchReport.close() -> None

No explicit parameters. Returns None, not additional calculation values. Raises the first close error after still attempting the other cleanup items.

Source locations

Chronaxis user manual · Offline edition