DatasetTypeExecutionReport

class lsst.pipe.base.execution_reports.DatasetTypeExecutionReport(missing_failed: set[lsst.daf.butler._dataset_ref.DatasetRef] = <factory>, missing_not_produced: dict[lsst.daf.butler._dataset_ref.DatasetRef, bool] = <factory>, missing_upstream_failed: set[lsst.daf.butler._dataset_ref.DatasetRef] = <factory>, n_produced: int = 0)

Bases: object

A report on the number of produced datasets as well as the status of missing datasets based on metadata.

A DatasetTypeExecutionReport is created for each DatasetType in a TaskExecutionReport.

Attributes Summary

n_produced

Count of datasets produced (int).

Methods Summary

handle_missing_dataset(output_ref, failed, ...)	Sort missing datasets into outcomes.
handle_produced_dataset(output_ref, status_graph)	Account for produced datasets.
to_summary_dict()	Summarize the DatasetTypeExecutionReport in a dictionary.

Attributes Documentation

n_produced: int = 0

Count of datasets produced (int).

Methods Documentation

handle_missing_dataset(output_ref: DatasetRef, failed: bool, status_graph: DiGraph) → None

Sort missing datasets into outcomes.

Parameters:

output_refDatasetRef

Dataset reference of the missing dataset.

failedbool

Whether the task associated with the missing dataset failed.

status_graphnetworkx.DiGraph

The quantum graph produced by TaskExecutionReport.inspect_quantum which steps through the run quantum graph and logs the status of each quanta.

handle_produced_dataset(output_ref: DatasetRef, status_graph: DiGraph) → None

Account for produced datasets.

Parameters:

output_refDatasetRef

Dataset reference of the dataset.

status_graphnetworkx.DiGraph

The quantum graph produced by QuantumGraphExecutionReport.make_reports which steps through the quantum graph of a run and logs the status of each quantum.

See also

TaskExecutionReport.inspect_quantum

to_summary_dict() → dict[str, Any]

Summarize the DatasetTypeExecutionReport in a dictionary.

Returns:

summary_dictdict

A count of the datasets with each outcome; the number of produced, missing_failed, missing_not_produced, and missing_upstream_failed DatasetTypes. See above for attribute descriptions.