QuantumBackedButler¶
- class lsst.daf.butler.QuantumBackedButler(predicted_inputs: Iterable[UUID], predicted_outputs: Iterable[UUID], dimensions: DimensionUniverse, datastore: Datastore, storageClasses: StorageClassFactory, dataset_types: Mapping[str, DatasetType] | None = None)¶
Bases:
LimitedButler
An implementation of
LimitedButler
intended to back execution of a singleQuantum
.- Parameters:
- predicted_inputs
Iterable
[DatasetId
] Dataset IDs for datasets that can can be read from this butler.
- predicted_outputs
Iterable
[DatasetId
] Dataset IDs for datasets that can be stored in this butler.
- dimensions
DimensionUniverse
Object managing all dimension definitions.
- datastore
Datastore
Datastore to use for all dataset I/O and existence checks.
- storageClasses
StorageClassFactory
Object managing all storage class definitions.
- predicted_inputs
Notes
Most callers should use the
initialize
classmethod
to construct new instances instead of calling the constructor directly.QuantumBackedButler
uses a SQLite database internally, in order to reuse existingDatastoreRegistryBridge
andOpaqueTableStorage
implementations that rely SQLAlchemy. If implementations are added in the future that don’t rely on SQLAlchemy, it should be possible to swap them in by overriding the type arguments toinitialize
(though at present,QuantumBackedButler
would still create at least an in-memory SQLite database that would then go unused).`We imagine
QuantumBackedButler
being used during (at least) batch execution to captureDatastore
records and save them to per-quantum files, which are also a convenient place to store provenance for eventual upload to a SQL-backedRegistry
(onceRegistry
has tables to store provenance, that is). These per-quantum files can be written in two ways:The SQLite file used internally by
QuantumBackedButler
can be used directly but customizing thefilename
argument toinitialize
, and then transferring that file to the object store after execution completes (or fails; atry/finally
pattern probably makes sense here).A JSON or YAML file can be written by calling
extract_provenance_data
, and usingpydantic
methods to write the returnedQuantumProvenanceData
to a file.
Note that at present, the SQLite file only contains datastore records, not provenance, but that should be easy to address (if desired) after we actually design a
Registry
schema for provenance. I also suspect that we’ll want to explicitly close the SQLite file somehow before trying to transfer it. But I’m guessing we’d prefer to write the per-quantum files as JSON anyway.Attributes Summary
This is a Generation 3 Butler.
The object that manages actual dataset storage.
Structure managing all dimensions recognized by this data repository (
DimensionUniverse
).Methods Summary
datasetExistsDirect
(ref)Return
True
if a dataset is actually present in the Datastore.Extract provenance information and datastore records from this butler.
from_predicted
(config, predicted_inputs, ...)Construct a new
QuantumBackedButler
from sets of input and output dataset IDs.get
(ref, /, *[, parameters, storageClass])Retrieve a stored dataset.
getDeferred
(ref, /, *[, parameters, ...])Create a
DeferredDatasetHandle
which can later retrieve a dataset, after an immediate registry lookup.getDirect
(ref, *[, parameters, storageClass])Deprecated since version v26.0.
getDirectDeferred
(ref, *[, parameters, ...])Deprecated since version v26.0.
getURI
(ref, /, *[, predict])Return the URI to the Dataset.
getURIs
(ref, /, *[, predict])Return the URIs associated with the dataset.
Return the names of the datastores associated with this butler.
Return the defined root URIs for all registered datastores.
get_many_uris
(refs[, predict, allow_missing])Return URIs associated with many datasets.
initialize
(config, quantum, dimensions[, ...])Construct a new
QuantumBackedButler
from repository configuration and helper types.markInputUnused
(ref)Indicate that a predicted input was not actually used when processing a
Quantum
.pruneDatasets
(refs, *[, disassociate, ...])Remove one or more datasets from a collection and/or storage.
put
(obj, ref, /)Store a dataset that already has a UUID and
RUN
collection.putDirect
(obj, ref, /)Store a dataset that already has a UUID and
RUN
collection.stored
(ref)Indicate whether the dataset's artifacts are present in the Datastore.
stored_many
(refs)Check the datastore for artifact existence of multiple datasets at once.
Attributes Documentation
- GENERATION: ClassVar[int] = 3¶
This is a Generation 3 Butler.
This attribute may be removed in the future, once the Generation 2 Butler interface has been fully retired; it should only be used in transitional code.
- datastore¶
The object that manages actual dataset storage. (
Datastore
)Deprecated since version v26.0: The Butler.datastore property is now deprecated. Butler APIs should now exist with the relevant functionality. Will be removed after v26.0.
- dimensions¶
Methods Documentation
- datasetExistsDirect(ref: DatasetRef) bool ¶
Return
True
if a dataset is actually present in the Datastore.- Parameters:
- ref
DatasetRef
Resolved reference to a dataset.
- ref
- Returns:
- exists
bool
Whether the dataset exists in the Datastore.
Deprecated since version v26.0: Butler.datasetExistsDirect() has been replaced by Butler.stored(). Will be removed after v26.0.
- exists
- extract_provenance_data() QuantumProvenanceData ¶
Extract provenance information and datastore records from this butler.
- Returns:
- provenance
QuantumProvenanceData
A serializable struct containing input/output dataset IDs and datastore records. This assumes all dataset IDs are UUIDs (just to make it easier for
pydantic
to reason about the struct’s types); the rest of this class makes no such assumption, but the approach to processing in which it’s useful effectively requires UUIDs anyway.
- provenance
Notes
QuantumBackedButler
records this provenance information when its methods are used, which mostly savesPipelineTask
authors from having to worry about while still recording very detailed information. But it has two small weaknesses:Calling
getDirectDeferred
orgetDirect
is enough to mark a dataset as an “actual input”, which may mark some datasets that aren’t actually used. We rely on task authors to usemarkInputUnused
to address this.We assume that the execution system will call
datasetExistsDirect
on all predicted inputs prior to execution, in order to populate the “available inputs” set. This is what I envision ‘SingleQuantumExecutor
doing after we update it to use this class, but it feels fragile for this class to make such a strong assumption about how it will be used, even if I can’t think of any other executor behavior that would make sense.
- classmethod from_predicted(config: ~lsst.daf.butler.core.config.Config | str | ~urllib.parse.ParseResult | ~lsst.resources._resourcePath.ResourcePath | ~pathlib.Path, predicted_inputs: ~collections.abc.Iterable[~uuid.UUID], predicted_outputs: ~collections.abc.Iterable[~uuid.UUID], dimensions: ~lsst.daf.butler.core.dimensions._universe.DimensionUniverse, datastore_records: ~collections.abc.Mapping[str, ~lsst.daf.butler.core.datastoreRecordData.DatastoreRecordData], filename: str = ':memory:', OpaqueManagerClass: type[lsst.daf.butler.registry.interfaces._opaque.OpaqueTableStorageManager] = <class 'lsst.daf.butler.registry.opaque.ByNameOpaqueTableStorageManager'>, BridgeManagerClass: type[lsst.daf.butler.registry.interfaces._bridge.DatastoreRegistryBridgeManager] = <class 'lsst.daf.butler.registry.bridge.monolithic.MonolithicDatastoreRegistryBridgeManager'>, search_paths: list[str] | None = None, dataset_types: ~collections.abc.Mapping[str, ~lsst.daf.butler.core.datasets.type.DatasetType] | None = None) QuantumBackedButler ¶
Construct a new
QuantumBackedButler
from sets of input and output dataset IDs.- Parameters:
- config
Config
orResourcePathExpression
A butler repository root, configuration filename, or configuration instance.
- predicted_inputs
Iterable
[DatasetId
] Dataset IDs for datasets that can can be read from this butler.
- predicted_outputs
Iterable
[DatasetId
] Dataset IDs for datasets that can be stored in this butler, must be fully resolved.
- dimensions
DimensionUniverse
Object managing all dimension definitions.
- filename
str
, optional Name for the SQLite database that will back this butler; defaults to an in-memory database.
- datastore_records
dict
[str
,DatastoreRecordData
] orNone
Datastore records to import into a datastore.
- OpaqueManagerClass
type
, optional A subclass of
OpaqueTableStorageManager
to use for datastore opaque records. Default is a SQL-backed implementation.- BridgeManagerClass
type
, optional A subclass of
DatastoreRegistryBridgeManager
to use for datastore location records. Default is a SQL-backed implementation.- search_paths
list
ofstr
, optional Additional search paths for butler configuration.
- dataset_types: `~collections.abc.Mapping` [`str`, `DatasetType`], optional
Mapping of the dataset type name to its registry definition.
- config
- get(ref: DatasetRef, /, *, parameters: dict[str, Any] | None = None, storageClass: StorageClass | str | None = None) Any ¶
Retrieve a stored dataset.
- Parameters:
- ref: `DatasetRef`
A resolved
DatasetRef
directly associated with a dataset.- parameters
dict
Additional StorageClass-defined options to control reading, typically used to efficiently read only a subset of the dataset.
- storageClass
StorageClass
orstr
, optional The storage class to be used to override the Python type returned by this method. By default the returned type matches the dataset type definition for this dataset. Specifying a read
StorageClass
can force a different type to be returned. This type must be compatible with the original type.
- Returns:
- obj
object
The dataset.
- obj
- Raises:
- AmbiguousDatasetError
Raised if the supplied
DatasetRef
is unresolved.
Notes
In a
LimitedButler
the only allowable way to specify a dataset is to use a resolvedDatasetRef
. Subclasses can support more options.
- getDeferred(ref: DatasetRef, /, *, parameters: dict[str, Any] | None = None, storageClass: str | StorageClass | None = None) DeferredDatasetHandle ¶
Create a
DeferredDatasetHandle
which can later retrieve a dataset, after an immediate registry lookup.- Parameters:
- ref
DatasetRef
For the default implementation of a
LimitedButler
, the only acceptable parameter is a resolvedDatasetRef
.- parameters
dict
Additional StorageClass-defined options to control reading, typically used to efficiently read only a subset of the dataset.
- storageClass
StorageClass
orstr
, optional The storage class to be used to override the Python type returned by this method. By default the returned type matches the dataset type definition for this dataset. Specifying a read
StorageClass
can force a different type to be returned. This type must be compatible with the original type.
- ref
- Returns:
- obj
DeferredDatasetHandle
A handle which can be used to retrieve a dataset at a later time.
- obj
Notes
In a
LimitedButler
the only allowable way to specify a dataset is to use a resolvedDatasetRef
. Subclasses can support more options.
- getDirect(ref: DatasetRef, *, parameters: dict[str, Any] | None = None, storageClass: str | StorageClass | None = None) Any ¶
Deprecated since version v26.0: Butler.get() now behaves like Butler.getDirect() when given a DatasetRef. Please use Butler.get(). Will be removed after v26.0.
- getDirectDeferred(ref: DatasetRef, *, parameters: dict[str, Any] | None = None, storageClass: str | StorageClass | None = None) DeferredDatasetHandle ¶
Deprecated since version v26.0: Butler.getDeferred() now behaves like getDirectDeferred() when given a DatasetRef. Please use Butler.getDeferred(). Will be removed after v26.0.
- getURI(ref: DatasetRef, /, *, predict: bool = False) ResourcePath ¶
Return the URI to the Dataset.
- Parameters:
- ref
DatasetRef
A
DatasetRef
for which a single URI is requested.- predict
bool
If
True
, allow URIs to be returned of datasets that have not been written.
- ref
- Returns:
- uri
lsst.resources.ResourcePath
URI pointing to the Dataset within the datastore. If the Dataset does not exist in the datastore, and if
predict
isTrue
, the URI will be a prediction and will include a URI fragment “#predicted”. If the datastore does not have entities that relate well to the concept of a URI the returned URI string will be descriptive. The returned URI is not guaranteed to be obtainable.
- uri
- Raises:
- RuntimeError
Raised if a URI is requested for a dataset that consists of multiple artifacts.
- getURIs(ref: DatasetRef, /, *, predict: bool = False) DatasetRefURIs ¶
Return the URIs associated with the dataset.
- Parameters:
- ref
DatasetRef
A
DatasetRef
for which URIs are requested.- predict
bool
If
True
, allow URIs to be returned of datasets that have not been written.
- ref
- Returns:
- uris
DatasetRefURIs
The URI to the primary artifact associated with this dataset (if the dataset was disassembled within the datastore this may be
None
), and the URIs to any components associated with the dataset artifact (can be empty if there are no components).
- uris
- get_datastore_names() tuple[str, ...] ¶
Return the names of the datastores associated with this butler.
- get_datastore_roots() dict[str, lsst.resources._resourcePath.ResourcePath | None] ¶
Return the defined root URIs for all registered datastores.
- Returns:
- roots
dict
[str
,ResourcePath
|None
] A mapping from datastore name to datastore root URI. The root can be
None
if the datastore does not have any concept of a root URI.
- roots
- get_many_uris(refs: Iterable[DatasetRef], predict: bool = False, allow_missing: bool = False) dict[lsst.daf.butler.core.datasets.ref.DatasetRef, lsst.daf.butler.core.datastore.DatasetRefURIs] ¶
Return URIs associated with many datasets.
- Parameters:
- Returns:
- URIs
dict
of [DatasetRef
,DatasetRefURIs
] A dict of primary and component URIs, indexed by the passed-in refs.
- URIs
- Raises:
- FileNotFoundError
A URI has been requested for a dataset that does not exist and guessing is not allowed.
Notes
In file-based datastores, get_many_uris does not check that the file is present. It assumes that if datastore is aware of the file then it actually exists.
- classmethod initialize(config: ~lsst.daf.butler.core.config.Config | str | ~urllib.parse.ParseResult | ~lsst.resources._resourcePath.ResourcePath | ~pathlib.Path, quantum: ~lsst.daf.butler.core.quantum.Quantum, dimensions: ~lsst.daf.butler.core.dimensions._universe.DimensionUniverse, filename: str = ':memory:', OpaqueManagerClass: type[lsst.daf.butler.registry.interfaces._opaque.OpaqueTableStorageManager] = <class 'lsst.daf.butler.registry.opaque.ByNameOpaqueTableStorageManager'>, BridgeManagerClass: type[lsst.daf.butler.registry.interfaces._bridge.DatastoreRegistryBridgeManager] = <class 'lsst.daf.butler.registry.bridge.monolithic.MonolithicDatastoreRegistryBridgeManager'>, search_paths: list[str] | None = None, dataset_types: ~collections.abc.Mapping[str, ~lsst.daf.butler.core.datasets.type.DatasetType] | None = None) QuantumBackedButler ¶
Construct a new
QuantumBackedButler
from repository configuration and helper types.- Parameters:
- config
Config
orResourcePathExpression
A butler repository root, configuration filename, or configuration instance.
- quantum
Quantum
Object describing the predicted input and output dataset relevant to this butler. This must have resolved
DatasetRef
instances for all inputs and outputs.- dimensions
DimensionUniverse
Object managing all dimension definitions.
- filename
str
, optional Name for the SQLite database that will back this butler; defaults to an in-memory database.
- OpaqueManagerClass
type
, optional A subclass of
OpaqueTableStorageManager
to use for datastore opaque records. Default is a SQL-backed implementation.- BridgeManagerClass
type
, optional A subclass of
DatastoreRegistryBridgeManager
to use for datastore location records. Default is a SQL-backed implementation.- search_paths
list
ofstr
, optional Additional search paths for butler configuration.
- dataset_types: `~collections.abc.Mapping` [`str`, `DatasetType`], optional
Mapping of the dataset type name to its registry definition.
- config
- markInputUnused(ref: DatasetRef) None ¶
Indicate that a predicted input was not actually used when processing a
Quantum
.- Parameters:
- ref
DatasetRef
Reference to the unused dataset.
- ref
Notes
By default, a dataset is considered “actually used” if it is accessed via
getDirect
or a handle to it is obtained viagetDirectDeferred
(even if the handle is not used). This method must be called after one of those in order to remove the dataset from the actual input list.This method does nothing for butlers that do not store provenance information (which is the default implementation provided by the base class).
- pruneDatasets(refs: Iterable[DatasetRef], *, disassociate: bool = True, unstore: bool = False, tags: Iterable[str] = (), purge: bool = False) None ¶
Remove one or more datasets from a collection and/or storage.
- Parameters:
- refs
Iterable
ofDatasetRef
Datasets to prune. These must be “resolved” references (not just a
DatasetType
and data ID).- disassociate
bool
, optional Disassociate pruned datasets from
tags
, or from all collections ifpurge=True
.- unstore
bool
, optional If
True
(False
is default) remove these datasets from all datastores known to this butler. Note that this will make it impossible to retrieve these datasets even via other collections. Datasets that are already not stored are ignored by this option.- tags
Iterable
[str
], optional TAGGED
collections to disassociate the datasets from. Ignored ifdisassociate
isFalse
orpurge
isTrue
.- purge
bool
, optional If
True
(False
is default), completely remove the dataset from theRegistry
. To prevent accidental deletions,purge
may only beTrue
if all of the following conditions are met:This mode may remove provenance information from datasets other than those provided, and should be used with extreme care.
- refs
- Raises:
- TypeError
Raised if the butler is read-only, if no collection was provided, or the conditions for
purge=True
were not met.
- put(obj: Any, ref: DatasetRef, /) DatasetRef ¶
Store a dataset that already has a UUID and
RUN
collection.- Parameters:
- obj
object
The dataset.
- ref
DatasetRef
Resolved reference for a not-yet-stored dataset.
- obj
- Returns:
- ref
DatasetRef
The same as the given, for convenience and symmetry with
Butler.put
.
- ref
- Raises:
- TypeError
Raised if the butler is read-only.
Notes
Whether this method inserts the given dataset into a
Registry
is implementation defined (someLimitedButler
subclasses do not have aRegistry
), but it always adds the dataset to aDatastore
, and the givenref.id
andref.run
are always preserved.
- putDirect(obj: Any, ref: DatasetRef, /) DatasetRef ¶
Store a dataset that already has a UUID and
RUN
collection.- Parameters:
- obj
object
The dataset.
- ref
DatasetRef
Resolved reference for a not-yet-stored dataset.
- obj
- Returns:
- ref
DatasetRef
The same as the given, for convenience and symmetry with
Butler.put
.
- ref
- Raises:
- TypeError
Raised if the butler is read-only.
Notes
Whether this method inserts the given dataset into a
Registry
is implementation defined (someLimitedButler
subclasses do not have aRegistry
), but it always adds the dataset to aDatastore
, and the givenref.id
andref.run
are always preserved.Deprecated since version v26.0: Butler.put() now behaves like Butler.putDirect() when given a DatasetRef. Please use Butler.put(). Will be removed after v26.0.
- stored(ref: DatasetRef) bool ¶
Indicate whether the dataset’s artifacts are present in the Datastore.
- Parameters:
- ref
DatasetRef
Resolved reference to a dataset.
- ref
- Returns:
- stored
bool
Whether the dataset artifact exists in the datastore and can be retrieved.
- stored
- stored_many(refs: Iterable[DatasetRef]) dict[lsst.daf.butler.core.datasets.ref.DatasetRef, bool] ¶
Check the datastore for artifact existence of multiple datasets at once.
- Parameters:
- refsiterable of
DatasetRef
The datasets to be checked.
- refsiterable of
- Returns:
- existence
dict
of [DatasetRef
,bool
] Mapping from given dataset refs to boolean indicating artifact existence.
- existence