YamlRepoExportBackend

class lsst.daf.butler.YamlRepoExportBackend(stream: IO)

Bases: lsst.daf.butler.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.

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()

Complete the export process.

saveDatasets(datasetType: lsst.daf.butler.core.datasets.DatasetType, run: lsst.daf.butler.core.run.Run, *datasets: lsst.daf.butler.core.repoTransfers.FileDataset)

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.

runRun

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.

collectionsiterable of str

Extra collections (in addition to Run.collection) the dataset should be associated with.

saveDimensionData(element: DimensionElement, *data: DimensionRecord)

Export one or more dimension element records.

Parameters
elementDimensionElement

The DimensionElement whose elements are being exported.

dataDimensionRecord (variadic)

One or more records to export.