Skip to content

Commit 844e1e1

Browse files
authored
DOC: Add filesystem keyword arg and documentation to DataFrame.to_parquet (#62924)
1 parent ac6db7e commit 844e1e1

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

pandas/core/frame.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2927,6 +2927,7 @@ def to_parquet(
29272927
index: bool | None = ...,
29282928
partition_cols: list[str] | None = ...,
29292929
storage_options: StorageOptions = ...,
2930+
filesystem: Any = ...,
29302931
**kwargs,
29312932
) -> bytes: ...
29322933

@@ -2940,6 +2941,7 @@ def to_parquet(
29402941
index: bool | None = ...,
29412942
partition_cols: list[str] | None = ...,
29422943
storage_options: StorageOptions = ...,
2944+
filesystem: Any = ...,
29432945
**kwargs,
29442946
) -> None: ...
29452947

@@ -2953,6 +2955,7 @@ def to_parquet(
29532955
index: bool | None = None,
29542956
partition_cols: list[str] | None = None,
29552957
storage_options: StorageOptions | None = None,
2958+
filesystem: Any = None,
29562959
**kwargs,
29572960
) -> bytes | None:
29582961
"""
@@ -2992,6 +2995,12 @@ def to_parquet(
29922995
Must be None if path is not a string.
29932996
{storage_options}
29942997
2998+
filesystem : fsspec or pyarrow filesystem, default None
2999+
Filesystem object to use when reading the parquet file. Only implemented
3000+
for ``engine="pyarrow"``.
3001+
3002+
.. versionadded:: 2.1.0
3003+
29953004
**kwargs
29963005
Additional arguments passed to the parquet library. See
29973006
:ref:`pandas io <io.parquet>` for more details.
@@ -3053,6 +3062,7 @@ def to_parquet(
30533062
index=index,
30543063
partition_cols=partition_cols,
30553064
storage_options=storage_options,
3065+
filesystem=filesystem,
30563066
**kwargs,
30573067
)
30583068

0 commit comments

Comments
 (0)