arrow icon indicating copy to clipboard operation
arrow copied to clipboard

[Python][Docs] Document file path support for IPC reader source

Open krupakargurije opened this issue 2 weeks ago • 1 comments

What changed

Document that IPC reader APIs accept a file path for the source parameter, consistent with existing writer documentation.

Affected APIs

  • pyarrow.ipc.open_file
  • pyarrow.ipc.open_stream
  • pyarrow.ipc.RecordBatchFileReader
  • pyarrow.ipc.RecordBatchStreamReader

Why

These APIs already accept file paths, but this behavior was undocumented. This PR aligns the reader documentation with actual behavior and with the corresponding writer APIs.

Fixes #46927

krupakargurije avatar Dec 14 '25 16:12 krupakargurije

Thanks for opening a pull request!

If this is not a minor PR. Could you open an issue for this pull request on GitHub? https://github.com/apache/arrow/issues/new/choose

Opening GitHub issues ahead of time contributes to the Openness of the Apache Arrow project.

Then could you also rename the pull request title in the following format?

GH-${GITHUB_ISSUE_ID}: [${COMPONENT}] ${SUMMARY}

or

MINOR: [${COMPONENT}] ${SUMMARY}

See also:

github-actions[bot] avatar Dec 14 '25 16:12 github-actions[bot]