polars.read_parquet_metadata#

polars.read_parquet_metadata( source: str | Path | IO[bytes] | bytes, ) → dict[str, str][source]#

Get file-level custom metadata of a Parquet file without reading data.

Warning

This functionality is considered experimental. It may be removed or changed at any point without it being considered a breaking change.

Parameters:

source: Path to a file or a file-like object (by “file-like object” we refer to objects that have a read() method, such as a file handler like the builtin open function, or a BytesIO instance). For file-like objects, the stream position may not be updated accordingly after reading.

Returns:

dict: Dictionary with the metadata. Empty if no custom metadata is available.