read_sidecar

astro_metadata_translator.indexing.read_sidecar(path: str) → ObservationInfo | MutableMapping[str, Any]

Read a metadata sidecar file.

Parameters:

pathstr

Path to the sidecar file.

Returns:

infoObservationInfo or dict of [str, dict]

If the sidecar file referred to ObservationInfo this will return an ObservationInfo, otherwise a dict will be returned.