You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by ap...@apache.org on 2020/03/30 11:46:05 UTC
[arrow] branch master updated: ARROW-8232: [Python] Deprecate
pyarrow.open_stream and pyarrow.open_file APIs in favor of accessing via
pyarrow.ipc namespace
This is an automated email from the ASF dual-hosted git repository.
apitrou pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/master by this push:
new fc47dd0 ARROW-8232: [Python] Deprecate pyarrow.open_stream and pyarrow.open_file APIs in favor of accessing via pyarrow.ipc namespace
fc47dd0 is described below
commit fc47dd035fe80a54c0990617c19bdda7671ff600
Author: Wes McKinney <we...@apache.org>
AuthorDate: Mon Mar 30 13:45:47 2020 +0200
ARROW-8232: [Python] Deprecate pyarrow.open_stream and pyarrow.open_file APIs in favor of accessing via pyarrow.ipc namespace
In my opinion, these APIs in the top level namespace are unclear and possibly misleading. We should encourage people to use the `pyarrow.ipc` namespace.
Closes #6757 from wesm/ARROW-8232
Authored-by: Wes McKinney <we...@apache.org>
Signed-off-by: Antoine Pitrou <an...@python.org>
---
python/pyarrow/__init__.py | 9 +++++++--
python/pyarrow/tests/test_ipc.py | 17 +++++++++++++++++
python/pyarrow/util.py | 4 ++--
3 files changed, 26 insertions(+), 4 deletions(-)
diff --git a/python/pyarrow/__init__.py b/python/pyarrow/__init__.py
index 9a015b7..616662f 100644
--- a/python/pyarrow/__init__.py
+++ b/python/pyarrow/__init__.py
@@ -167,8 +167,6 @@ from pyarrow.ipc import (Message, MessageReader,
read_message, read_record_batch, read_schema,
read_tensor, write_tensor,
get_record_batch_size, get_tensor_size,
- open_stream,
- open_file,
serialize_pandas, deserialize_pandas)
import pyarrow.ipc as ipc
@@ -201,6 +199,13 @@ def _plasma_store_entry_point():
from pyarrow.util import _deprecate_api # noqa
+
+open_stream = _deprecate_api("open_stream", "ipc.open_stream",
+ ipc.open_stream, "0.17.0")
+
+open_file = _deprecate_api("open_file", "ipc.open_file", ipc.open_file,
+ "0.17.0")
+
# ----------------------------------------------------------------------
# Returning absolute path to the pyarrow include directory (if bundled, e.g. in
# wheels)
diff --git a/python/pyarrow/tests/test_ipc.py b/python/pyarrow/tests/test_ipc.py
index 5f498ee..53d1fe4 100644
--- a/python/pyarrow/tests/test_ipc.py
+++ b/python/pyarrow/tests/test_ipc.py
@@ -715,6 +715,23 @@ def test_schema_serialization_with_metadata():
assert recons_schema[1].metadata == field_metadata
+def test_deprecated_pyarrow_ns_apis():
+ table = pa.table([pa.array([1, 2, 3, 4])], names=['a'])
+ sink = pa.BufferOutputStream()
+ with pa.RecordBatchStreamWriter(sink, table.schema) as writer:
+ writer.write(table)
+
+ with pytest.warns(FutureWarning,
+ match="please use pyarrow.ipc.open_stream"):
+ pa.open_stream(sink.getvalue())
+
+ sink = pa.BufferOutputStream()
+ with pa.RecordBatchFileWriter(sink, table.schema) as writer:
+ writer.write(table)
+ with pytest.warns(FutureWarning, match="please use pyarrow.ipc.open_file"):
+ pa.open_file(sink.getvalue())
+
+
def write_file(batch, sink):
with pa.RecordBatchFileWriter(sink, batch.schema) as writer:
writer.write_batch(batch)
diff --git a/python/pyarrow/util.py b/python/pyarrow/util.py
index a48e764..e29f7f3 100644
--- a/python/pyarrow/util.py
+++ b/python/pyarrow/util.py
@@ -32,12 +32,12 @@ def implements(f):
def _deprecate_api(old_name, new_name, api, next_version):
- msg = ('pyarrow.{} is deprecated as of {}, please use {} instead'
+ msg = ('pyarrow.{} is deprecated as of {}, please use pyarrow.{} instead'
.format(old_name, next_version, new_name))
def wrapper(*args, **kwargs):
warnings.warn(msg, FutureWarning)
- return api(*args)
+ return api(*args, **kwargs)
return wrapper