Open
Description
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:
- https://arrow.apache.org/docs/dev/python/generated/pyarrow.ipc.open_file.html
- https://arrow.apache.org/docs/dev/python/generated/pyarrow.ipc.open_stream.html
- https://arrow.apache.org/docs/dev/python/generated/pyarrow.ipc.RecordBatchFileReader.html
- https://arrow.apache.org/docs/dev/python/generated/pyarrow.ipc.RecordBatchStreamReader.html
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:
- https://arrow.apache.org/docs/dev/python/generated/pyarrow.ipc.new_file.html
- https://arrow.apache.org/docs/dev/python/generated/pyarrow.ipc.new_stream.html
- https://arrow.apache.org/docs/dev/python/generated/pyarrow.ipc.RecordBatchFileWriter.html
- https://arrow.apache.org/docs/dev/python/generated/pyarrow.ipc.RecordBatchStreamWriter.html
Adding this should be a simple addition in python/pyarrow/ipc.py
.
Component(s)
Documentation, Python