ProvenanceQuantumScanData

class lsst.pipe.base.quantum_graph.ProvenanceQuantumScanData(quantum_id: ~uuid.UUID, status: ~lsst.pipe.base.quantum_graph._provenance.ProvenanceQuantumScanStatus, existing_outputs: set[uuid.UUID] = <factory>, quantum: bytes = b'', metadata: bytes = b'', logs: bytes = b'', is_compressed: bool = False)

Bases: object

A struct that represents ready-for-serialization provenance information for a single quantum.

Attributes Summary

is_compressed	Whether the quantum, metadata, and log attributes are compressed.
logs	Serialized logs.
metadata	Serialized task metadata.
quantum	Serialized quantum provenance model.

Methods Summary

compress(compressor)	Compress the data in this struct if it has not been compressed already.
make_blocked(quantum_id)	Construct provenance information for a quantum blocked by an upstream failure.

Attributes Documentation

is_compressed: bool = False

Whether the quantum, metadata, and log attributes are compressed.

logs: bytes = b''

Serialized logs.

metadata: bytes = b''

Serialized task metadata.

quantum: bytes = b''

Serialized quantum provenance model.

This may be empty for quanta that had no attempts.

Methods Documentation

compress(compressor: Compressor) → None

Compress the data in this struct if it has not been compressed already.

Parameters:

compressorCompressor

Object with a compress method that takes and returns bytes.

classmethod make_blocked(quantum_id: UUID) → ProvenanceQuantumScanData

Construct provenance information for a quantum blocked by an upstream failure.

Parameters:

quantum_iduuid.UUID

Unique ID of the quantum

Returns:

scan_dataProvenanceQuantumScanData

Struct with ready-to-write provenance data.