Skip to content

GH-46927: [Docs] [Python] document file path as option for source param #55322

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

Open
willhopkins wants to merge 2 commits into
base: main
Choose a base branch
from
Open

GH-46927: [Docs] [Python] document file path as option for source param #55322

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fbf19cc
docs(46927): document source param
willhopkins Oct 30, 2026
f685385
docs: switch to any of
willhopkins Oct 30, 2026
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
8 changes: 4 additions & 4 deletions python/pyarrow/ipc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ class RecordBatchStreamReader(lib._RecordBatchStreamReader):
Parameters
----------
source : bytes/buffer-like, pyarrow.NativeFile, or file-like Python object
Either an in-memory buffer, or a readable file object.
Any of an in-memory buffer, file path, or a readable file object.
If you want to use memory map use MemoryMappedFile as source.
options : pyarrow.ipc.IpcReadOptions
Options for IPC deserialization.
Expand Down Expand Up @@ -97,7 +97,7 @@ class RecordBatchFileReader(lib._RecordBatchFileReader):
Parameters
----------
source : bytes/buffer-like, pyarrow.NativeFile, or file-like Python object
Either an in-memory buffer, or a readable file object.
Any of an in-memory buffer, file path, or a readable file object.
If you want to use memory map use MemoryMappedFile as source.
footer_offset : int, default None
If the file is embedded in some larger file, this is the byte offset to
Expand Down Expand Up @@ -172,7 +172,7 @@ def open_stream(source, *, options=None, memory_pool=None):
Parameters
----------
source : bytes/buffer-like, pyarrow.NativeFile, or file-like Python object
Either an in-memory buffer, or a readable file object.
Any of an in-memory buffer, file path, or a readable file object.
options : pyarrow.ipc.IpcReadOptions
Options for IPC serialization.
If None, default values will be used.
Expand Down Expand Up @@ -211,7 +211,7 @@ def open_file(source, footer_offset=None, *, options=None, memory_pool=None):
Parameters
----------
source : bytes/buffer-like, pyarrow.NativeFile, or file-like Python object
Either an in-memory buffer, or a readable file object.
Any of an in-memory buffer, file path, or a readable file object.
footer_offset : int, default None
If the file is embedded in some larger file, this is the byte offset to
the very end of the file data.
Expand Down
Loading