Skip to content

[Docs][Python] Document that source parameter to IPC readers can be a file path #46927

Open
@ianmcook

Description

@ianmcook

Describe the enhancement requested

The functions pyarrow.ipc.open_file and pyarrow.ipc.open_stream and the constructors pyarrow.ipc.RecordBatchFileReader and pyarrow.ipc.RecordBatchStreamReader can all take a file path for the source parameter, but this is not documented:

For comparison, notice that it is documented that the functions pyarrow.ipc.new_file and pyarrow.ipc.new_stream and the constructors pyarrow.ipc.RecordBatchFileWriter and pyarrow.ipc.RecordBatchStreamWriter can take a file path for the sink parameter:

Adding this should be a simple addition in python/pyarrow/ipc.py.

Component(s)

Documentation, Python

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions