Skip to content

Output

output

Configuration for the output.

Classes

OutputConfiguration

Bases: BaseModel

Configuration for the output.

Attributes
directory class-attribute instance-attribute 
directory: str = Field(default='.', description='Output directory.')

Output directory.

format class-attribute instance-attribute 
format: Literal['hdf5', 'npz', 'csv'] = Field(default='hdf5', description='Storage format.')

Storage format.

compression class-attribute instance-attribute 
compression: Literal['gzip', 'lzf', 'szip'] | None = Field(default='gzip', description='Compression filter.')

Compression filter.

overwrite class-attribute instance-attribute 
overwrite: bool = Field(default=False, description='Whether or not to overwrite existing files.')

Whether or not to overwrite existing files.

save_metadata class-attribute instance-attribute 
save_metadata: bool = Field(default=True, description='Whether or not to save metadata.')

Whether or not to save the provenance record alongside the catalogue.

When true -- the default -- a written catalogue carries the record of the run that produced it: package version and checkout state, the complete resolved configuration, the seed as actually used, and the column list in output order. HDF5 files carry it in a metadata group, CSV files in a JSON sidecar. Turn it off only for throwaway output: a catalogue without the record cannot be reconstructed, so it cannot be published.