Repository navigation
GH-49305: [Python] Expose RecordBatchFileReader.count_rows - #50646
Conversation
RecordBatchFileReader::CountRows was already available in Arrow C++ but not bound in Python, so the only way to get the total number of rows of an IPC file was to read every record batch and sum num_rows. Add a count_rows() method that reads only the metadata of each record batch without deserializing the batches themselves. The method is named after the C++ API and matches the existing count_rows() methods on Dataset, Scanner and Fragment.
|
|
|
|
1 similar comment
|
|
pitrou
left a comment
There was a problem hiding this comment.
Thank you @GujaLomsadze ! This looks good to me, just one question.
…rows The file reader has no close() and its __exit__ is a no-op, so self.reader is always set once _open has run and the guard can never fire. Matches num_record_batches, get_batch, read_all and metadata.
pitrou
left a comment
There was a problem hiding this comment.
Thanks for the update @GujaLomsadze !
|
CI failures look unrelated, I'll merge. |
|
Thanks for the review @pitrou! |
|
After merging your PR, Conbench analyzed the 3 benchmarking runs that have been run so far on merge-commit 8402729. There were no benchmark performance regressions. 🎉 The full Conbench report has more details. It also includes information about 4 possible false positives for unstable benchmarks that are known to sometimes produce them. |
Rationale for this change
Resolves 49305
RecordBatchFileReader::CountRowshas existed in Arrow C++ (cpp/src/arrow/ipc/reader.h) butwas never bound in Python, so the only way to get the total number of rows of an IPC file was:
This findings are done in original opened Issue #49305
That deserializes every record batch just to read its length, which is wasteful and becomes
expensive on remote filesystems.
What changes are included in this PR?
Adds
RecordBatchFileReader.count_rows():Three changes:
python/pyarrow/includes/libarrow.pxd: declareCResult[int64_t] CountRows()onCRecordBatchFileReader, which was the missing piece.python/pyarrow/ipc.pxi: addcount_rows()to_RecordBatchFileReader, released GIL aroundthe call, with the same closed reader guard used by the existing
statspropertypython/pyarrow/tests/test_ipc.py: tests.On the naming:
count_rows()follows the C++ method and is consistent with the existingcount_rows()onDataset,ScannerandFragment.To be precise about the benefit, since the issue describes it as reading the count from the
metadata: the C++ implementation still walks every block, but reads only each record batch's
flatbuffer message header to pick up its length, and never touches the data buffers. So this is
a reduction in bytes read rather than in the number of reads, and the gain shows up on remote
filesystems and on files with large batches rather than in a local in memory benchmark.
This is only added to the file reader. The stream reader has no footer and cannot count rows
without consuming the stream.
Are these changes tested?
Yes, two tests in
python/pyarrow/tests/test_ipc.py:test_file_count_rows: count matches the sum of the written batch lengths, and counting doesnot consume the reader (count,
read_all(), count again).test_file_count_rows_no_batches: a file with a schema but no batches counts 0.Locally
test_ipc.pypasses (72 tests) andtest_feather.pypasses (83 passed, 8 skipped,1 xfailed), the latter because the feather reader sits on the same file reader. The docstring
example was run and produces the output shown.
Are there any user-facing changes?
Yes, a new public method
RecordBatchFileReader.count_rows(). No existing behaviour changes.AI usage disclosure
I used Claude Code to locate the unbound C++ method and the place where the declaration was
missing, and to draft the binding, the docstring and the tests. I reviewed the result, rebuilt
PyArrow locally, ran the test suites quoted above, and checked the C++ implementation of
CountRowsmyself to confirm what it actually does before describing the benefit here.