YamlRepoExportBackend¶
- class lsst.daf.butler.YamlRepoExportBackend(stream: IO, universe: DimensionUniverse)¶
Bases:
RepoExportBackend
A repository export implementation that saves to a YAML file.
- Parameters:
- stream
A writeable file-like object.
Methods Summary
finish
()Complete the export process.
saveCollection
(record, doc)Export a collection.
saveDatasetAssociations
(collection, ...)Export the dataset-collection associations for a single collection.
saveDatasets
(datasetType, run, *datasets)Export one or more datasets, including their associated DatasetType and run information (but not including associated dimension information).
saveDimensionData
(element, *data)Export one or more dimension element records.
Methods Documentation
- saveCollection(record: CollectionRecord, doc: str | None) None ¶
Export a collection.
This only exports the collection’s own state, not its associations with datasets.
- saveDatasetAssociations(collection: str, collectionType: CollectionType, associations: Iterable[DatasetAssociation]) None ¶
Export the dataset-collection associations for a single collection.
- Parameters:
- collection
str
The name of the collection.
- collectionType
CollectionType
The type of the collection; either
CollectionType.TAGGED
orCollectionType.CALIBRATION
(as other collection types are exported in other ways).- associations
Iterable
[DatasetAssociation
] Structs representing an association between this collection and this dataset.
- collection
- saveDatasets(datasetType: DatasetType, run: str, *datasets: FileDataset) None ¶
Export one or more datasets, including their associated DatasetType and run information (but not including associated dimension information).
- Parameters:
- datasetType
DatasetType
Type of all datasets being exported with this call.
- run
str
Run associated with all datasets being exported with this call.
- datasets
FileDataset
, variadic Per-dataset information to be exported.
FileDataset.formatter
attributes should be strings, notFormatter
instances or classes.
- datasetType
- saveDimensionData(element: DimensionElement, *data: DimensionRecord) None ¶
Export one or more dimension element records.
- Parameters:
- element
DimensionElement
The
DimensionElement
whose elements are being exported.- data
DimensionRecord
(variadic) One or more records to export.
- element