Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(python): Add include_file_paths parameter to read_parquet #19008

Merged
merged 1 commit into from
Sep 29, 2024
Merged

feat(python): Add include_file_paths parameter to read_parquet #19008

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion py-polars/polars/io/parquet/functions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ def read_parquet(
use_pyarrow: bool = False,
pyarrow_options: dict[str, Any] | None = None,
memory_map: bool = True,
include_file_paths: str | None = None,
allow_missing_columns: bool = False,
) -> DataFrame:
"""
Expand Down Expand Up @@ -140,6 +141,9 @@ def read_parquet(
memory_map
Memory map underlying file. This will likely increase performance.
Only used when `use_pyarrow=True`.
include_file_paths
Include the path of the source file(s) as a column with this name.
Only valid when `use_pyarrow=False`.
allow_missing_columns
When reading a list of parquet files, if a column existing in the first
file cannot be found in subsequent files, the default behavior is to
Expand All @@ -165,6 +169,9 @@ def read_parquet(
if n_rows is not None:
msg = "`n_rows` cannot be used with `use_pyarrow=True`"
raise ValueError(msg)
if include_file_paths is not None:
msg = "`include_file_paths` cannot be used with `use_pyarrow=True`"
raise ValueError(msg)
if hive_schema is not None:
msg = (
"cannot use `hive_partitions` with `use_pyarrow=True`"
Expand Down Expand Up @@ -204,7 +211,7 @@ def read_parquet(
storage_options=storage_options,
retries=retries,
glob=glob,
include_file_paths=None,
include_file_paths=include_file_paths,
allow_missing_columns=allow_missing_columns,
)

Expand Down