colstore.info¶

colstore.info(path)[source]¶

Return a summary of the file at path without reading any record bodies.

The summary is built from the validated file header (magic, counters block CRC, format version, manifest CRC). If any of those checks fail, the underlying FormatError propagates – info is therefore also useful as a cheap “is this a valid colstore file?” probe.

See ColStoreInfo for the returned fields.

Parameters:: path (str | PathLike[str])
Return type:: ColStoreInfo