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

Jump to bottom

fix: Expose to_pandas_kwargs in read_parquet for pyarrow engine #57044

Closed
wants to merge 1 commit into from
Closed

fix: Expose to_pandas_kwargs in read_parquet for pyarrow engine #57044

Show file tree
Hide file tree
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
7 changes: 7 additions & 0 deletions doc/source/user_guide/io.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5420,6 +5420,13 @@ Read only certain columns of a parquet file.
)
result.dtypes

Pass additional keyword arguments to the underlying engine's ``to_pandas`` function.

.. ipython:: python

result = pd.read_parquet("example_pa.parquet", engine="pyarrow", to_pandas_kwargs={ "timestamp_as_object": True })

result.dtypes

.. ipython:: python
:suppress:
Expand Down
18 changes: 13 additions & 5 deletions pandas/io/parquet.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,24 +245,25 @@ def read(
dtype_backend: DtypeBackend | lib.NoDefault = lib.no_default,
storage_options: StorageOptions | None = None,
filesystem=None,
to_pandas_kwargs: dict[str, Any] | None = None,
**kwargs,
) -> DataFrame:
kwargs["use_pandas_metadata"] = True

to_pandas_kwargs = {}
to_pandas_kwargs = to_pandas_kwargs or {}
if dtype_backend == "numpy_nullable":
from pandas.io._util import _arrow_dtype_mapping

mapping = _arrow_dtype_mapping()
to_pandas_kwargs["types_mapper"] = mapping.get
elif dtype_backend == "pyarrow":
to_pandas_kwargs["types_mapper"] = pd.ArrowDtype # type: ignore[assignment]
to_pandas_kwargs["types_mapper"] = pd.ArrowDtype
elif using_pyarrow_string_dtype():
to_pandas_kwargs["types_mapper"] = arrow_string_types_mapper()

manager = _get_option("mode.data_manager", silent=True)
if manager == "array":
to_pandas_kwargs["split_blocks"] = True # type: ignore[assignment]
to_pandas_kwargs["split_blocks"] = True

path_or_handle, handles, filesystem = _get_path_or_handle(
path,
Expand Down Expand Up @@ -362,9 +363,11 @@ def read(
filters=None,
storage_options: StorageOptions | None = None,
filesystem=None,
to_pandas_kwargs: dict[str, Any] | None = None,
**kwargs,
) -> DataFrame:
parquet_kwargs: dict[str, Any] = {}
to_pandas_kwargs = to_pandas_kwargs or {}
use_nullable_dtypes = kwargs.pop("use_nullable_dtypes", False)
dtype_backend = kwargs.pop("dtype_backend", lib.no_default)
# We are disabling nullable dtypes for fastparquet pending discussion
Expand Down Expand Up @@ -400,7 +403,7 @@ def read(

try:
parquet_file = self.api.ParquetFile(path, **parquet_kwargs)
return parquet_file.to_pandas(columns=columns, filters=filters, **kwargs)
return parquet_file.to_pandas(columns=columns, filters=filters, **to_pandas_kwargs, **kwargs)
finally:
if handles is not None:
handles.close()
Expand Down Expand Up @@ -465,7 +468,7 @@ def to_parquet(
.. versionadded:: 2.1.0

kwargs
Additional keyword arguments passed to the engine
Additional keyword arguments passed to the engine.

Returns
-------
Expand Down Expand Up @@ -505,6 +508,7 @@ def read_parquet(
dtype_backend: DtypeBackend | lib.NoDefault = lib.no_default,
filesystem: Any = None,
filters: list[tuple] | list[list[tuple]] | None = None,
to_pandas_kwargs: dict[str, Any] | None = None,
**kwargs,
) -> DataFrame:
"""
Expand Down Expand Up @@ -588,6 +592,9 @@ def read_parquet(

.. versionadded:: 2.1.0

to_pandas_kwargs : dict[str, Any], default None
Dictionary of arguments passed to the underlying engine's ``to_pandas`` function.

**kwargs
Any additional kwargs are passed to the engine.

Expand Down Expand Up @@ -676,5 +683,6 @@ def read_parquet(
use_nullable_dtypes=use_nullable_dtypes,
dtype_backend=dtype_backend,
filesystem=filesystem,
to_pandas_kwargs=to_pandas_kwargs,
**kwargs,
)
Loading