This is an automated email from the ASF dual-hosted git repository.
thisisnic pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/main by this push:
new bb83012743 MINOR: [Docs][Python] Mention explicit None partitioning
options for pyarrow.parquet.read_table (#45163)
bb83012743 is described below
commit bb830127433128061f7086ff37f935e919dfa9a1
Author: Marius van Niekerk <[email protected]>
AuthorDate: Mon Sep 28 07:38:01 2026 -0700
MINOR: [Docs][Python] Mention explicit None partitioning options for
pyarrow.parquet.read_table (#45163)
pyarrow.parquet.read_parquet does support using `None` as the partioning
argument (and is required when not using partitioning).
This adjusts the documentation accordingly.
Authored-by: Marius van Niekerk <[email protected]>
Signed-off-by: Nic Crane <[email protected]>
---
python/pyarrow/dataset.py | 4 ++--
python/pyarrow/parquet/core.py | 7 ++++---
2 files changed, 6 insertions(+), 5 deletions(-)
diff --git a/python/pyarrow/dataset.py b/python/pyarrow/dataset.py
index 039da8c0d5..f696d5f03b 100644
--- a/python/pyarrow/dataset.py
+++ b/python/pyarrow/dataset.py
@@ -538,7 +538,7 @@ def parquet_dataset(metadata_path, schema=None,
filesystem=None, format=None,
format : ParquetFileFormat
An instance of a ParquetFileFormat if special options needs to be
passed.
- partitioning : Partitioning, PartitioningFactory, str, list of str
+ partitioning : Partitioning, PartitioningFactory, str, list of str,
optional
The partitioning scheme specified with the ``partitioning()``
function. A flavor string can be used as shortcut, and with a list of
field names a DirectoryPartitioning will be inferred.
@@ -634,7 +634,7 @@ RecordBatch or Table, iterable of RecordBatch,
RecordBatchReader, or URI
examples below.
Note that the URIs on Windows must follow 'file:///C:...' or
'file:/C:...' patterns.
- partitioning : Partitioning, PartitioningFactory, str, list of str
+ partitioning : Partitioning, PartitioningFactory, str, list of str,
optional
The partitioning scheme specified with the ``partitioning()``
function. A flavor string can be used as shortcut, and with a list of
field names a DirectoryPartitioning will be inferred.
diff --git a/python/pyarrow/parquet/core.py b/python/pyarrow/parquet/core.py
index 152c2694e2..6f837d2186 100644
--- a/python/pyarrow/parquet/core.py
+++ b/python/pyarrow/parquet/core.py
@@ -1279,13 +1279,14 @@ memory_map : bool, default False
buffer_size : int, default 0
If positive, perform read buffering when deserializing individual
column chunks. Otherwise IO calls are unbuffered.
-partitioning : pyarrow.dataset.Partitioning or str or list of str, \
+partitioning : pyarrow.dataset.Partitioning or str or list of str or None, \
default "hive"
The partitioning scheme for a partitioned dataset. The default of "hive"
assumes directory names with key=value pairs like "/year=2009/month=11".
In addition, a scheme like "/2009/11" is also supported, in which case
- you need to specify the field names or a full schema. See the
- ``pyarrow.dataset.partitioning()`` function for more details."""
+ you need to specify the field names or a full schema. If no partitioning
+ is used, pass ``None``.
+ See the ``pyarrow.dataset.partitioning()`` function for more details."""
_parquet_dataset_example = """\
