Skip to content

GH-43075: [Docs][Python] Document that source parameter to IPC reader… #49152

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
aayush-1o wants to merge 1 commit into
base: main
Choose a base branch
from
Open

GH-43075: [Docs][Python] Document that source parameter to IPC reader… #49152

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 @@ -96,8 +96,8 @@ 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.
source : str, os.PathLike, bytes/buffer-like, pyarrow.NativeFile, or file-like Python object
Either a file path, an in-memory buffer, 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 @@ -210,8 +210,8 @@ 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.
source : str, os.PathLike, bytes/buffer-like, pyarrow.NativeFile, or file-like Python object
Either a file path, an in-memory buffer, 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