YamlRepoExportBackend

class lsst.daf.butler.YamlRepoExportBackend(stream: IO, universe: DimensionUniverse)

Bases: RepoExportBackend

A repository export implementation that saves to a YAML file.

Parameters:

streamio.IO

A writeable file-like object.

universeDimensionUniverse

The dimension universe to use for the export.

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

finish() → None

Complete the export process.

saveCollection(record: CollectionRecord, doc: str | None) → None

Export a collection.

This only exports the collection’s own state, not its associations with datasets.

Parameters:

recordCollectionRecord

Object representing the collection to export.

docstr or None

Documentation string for the collection.

saveDatasetAssociations(collection: str, collectionType: CollectionType, associations: Iterable[DatasetAssociation]) → None

Export the dataset-collection associations for a single collection.

Parameters:

collectionstr

The name of the collection.

collectionTypeCollectionType

The type of the collection; either CollectionType.TAGGED or CollectionType.CALIBRATION (as other collection types are exported in other ways).

associationsIterable [ DatasetAssociation ]

Structs representing an association between this collection and this dataset.

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:

datasetTypeDatasetType

Type of all datasets being exported with this call.

runstr

Run associated with all datasets being exported with this call.

*datasetsFileDataset, variadic

Per-dataset information to be exported. FileDataset.formatter attributes should be strings, not Formatter instances or classes.

saveDimensionData(element: DimensionElement, *data: DimensionRecord) → None

Export one or more dimension element records.

Parameters:

elementDimensionElement

The DimensionElement whose elements are being exported.

*dataDimensionRecord (variadic)

One or more records to export.