Amend usages of get_result, add FutureWarning

Change-Id: I5fb2d27ed2d32319294e2403af4db83aee0b9a91

python/doc/source/ipc.rst

@@ -79,7 +79,7 @@ particular stream. Now we can do:
       writer.write_batch(batch)
    writer.close()
 
-   buf = sink.get_result()
+   buf = sink.getvalue()
    buf.size
 
 Now ``buf`` contains the complete stream as an in-memory byte buffer. We can
@@ -119,7 +119,7 @@ The :class:`~pyarrow.RecordBatchFileWriter` has the same API as
       writer.write_batch(batch)
    writer.close()
 
-   buf = sink.get_result()
+   buf = sink.getvalue()
    buf.size
 
 The difference between :class:`~pyarrow.RecordBatchFileReader` and

python/doc/source/memory.rst

@@ -206,7 +206,7 @@ file interfaces that can read and write to Arrow Buffers.
    writer = pa.BufferOutputStream()
    writer.write(b'hello, friends')
 
-   buf = writer.get_result()
+   buf = writer.getvalue()
    buf
    buf.size
    reader = pa.BufferReader(buf)

python/pyarrow/io.pxi

@@ -930,19 +930,27 @@ cdef class BufferOutputStream(NativeFile):
         self.closed = False
 
     def get_result(self):
+        """
+        Deprecated as of 0.10.0. Alias for getvalue()
+        """
+        warnings.warn("BufferOutputStream.get_result() has been renamed "
+                      "to getvalue(), will be removed in 0.11.0",
+                      FutureWarning)
+        return self.getvalue()
+
+    def getvalue(self):
+        """
+        Finalize output stream and return result as pyarrow.Buffer.
+
+        Returns
+        -------
+        value : Buffer
+        """
         with nogil:
             check_status(self.wr_file.get().Close())
         self.closed = True
         return pyarrow_wrap_buffer(<shared_ptr[CBuffer]> self.buffer)
 
-    def getvalue(self):
-        """
-        Alias for get_result.
-
-        TODO(wesm): Should get_result be deprecated?
-        """
-        return self.get_result()
-
 
 cdef class MockOutputStream(NativeFile):
 

python/pyarrow/tests/test_io.py

@@ -545,7 +545,7 @@ def test_memory_output_stream():
     for i in range(K):
         f.write(val)
 
-    buf = f.get_result()
+    buf = f.getvalue()
 
     assert len(buf) == len(val) * K
     assert buf.to_pybytes() == val * K
@@ -554,7 +554,7 @@ def test_memory_output_stream():
 def test_inmemory_write_after_closed():
     f = pa.BufferOutputStream()
     f.write(b'ok')
-    f.get_result()
+    f.getvalue()
 
     with pytest.raises(ValueError):
         f.write(b'not ok')
@@ -586,7 +586,7 @@ def test_nativefile_write_memoryview():
     f.write(arr)
     f.write(bytearray(data))
 
-    buf = f.get_result()
+    buf = f.getvalue()
 
     assert buf.to_pybytes() == data * 2
 
@@ -610,7 +610,7 @@ def test_mock_output_stream():
         f1.write(val)
         f2.write(val)
 
-    assert f1.size() == len(f2.get_result())
+    assert f1.size() == len(f2.getvalue())
 
     # Do the same test with a pandas DataFrame
     val = pd.DataFrame({'a': [1, 2, 3]})
@@ -627,7 +627,7 @@ def test_mock_output_stream():
     stream_writer1.close()
     stream_writer2.close()
 
-    assert f1.size() == len(f2.get_result())
+    assert f1.size() == len(f2.getvalue())
 
 
 # ----------------------------------------------------------------------

python/pyarrow/tests/test_ipc.py

@@ -468,7 +468,7 @@ def test_ipc_zero_copy_numpy():
     batch = pa.RecordBatch.from_pandas(df)
     sink = pa.BufferOutputStream()
     write_file(batch, sink)
-    buffer = sink.get_result()
+    buffer = sink.getvalue()
     reader = pa.BufferReader(buffer)
 
     batches = read_file(reader)
@@ -488,7 +488,7 @@ def test_ipc_stream_no_batches():
     writer = pa.RecordBatchStreamWriter(sink, table.schema)
     writer.close()
 
-    source = sink.get_result()
+    source = sink.getvalue()
     reader = pa.open_stream(source)
     result = reader.read_all()
 

python/pyarrow/tests/test_parquet.py

@@ -396,7 +396,7 @@ def test_pandas_parquet_native_file_roundtrip(tmpdir):
     arrow_table = pa.Table.from_pandas(df)
     imos = pa.BufferOutputStream()
     _write_table(arrow_table, imos, version="2.0")
-    buf = imos.get_result()
+    buf = imos.getvalue()
     reader = pa.BufferReader(buf)
     df_read = _read_table(reader).to_pandas()
     tm.assert_frame_equal(df, df_read)
@@ -424,7 +424,7 @@ def test_parquet_incremental_file_build(tmpdir):
 
     writer.close()
 
-    buf = out.get_result()
+    buf = out.getvalue()
     result = _read_table(pa.BufferReader(buf))
 
     expected = pd.concat(frames, ignore_index=True)
@@ -439,7 +439,7 @@ def test_read_pandas_column_subset(tmpdir):
     arrow_table = pa.Table.from_pandas(df)
     imos = pa.BufferOutputStream()
     _write_table(arrow_table, imos, version="2.0")
-    buf = imos.get_result()
+    buf = imos.getvalue()
     reader = pa.BufferReader(buf)
     df_read = pq.read_pandas(reader, columns=['strings', 'uint8']).to_pandas()
     tm.assert_frame_equal(df[['strings', 'uint8']], df_read)
@@ -451,7 +451,7 @@ def test_pandas_parquet_empty_roundtrip(tmpdir):
     arrow_table = pa.Table.from_pandas(df)
     imos = pa.BufferOutputStream()
     _write_table(arrow_table, imos, version="2.0")
-    buf = imos.get_result()
+    buf = imos.getvalue()
     reader = pa.BufferReader(buf)
     df_read = _read_table(reader).to_pandas()
     tm.assert_frame_equal(df, df_read)
@@ -2108,7 +2108,7 @@ def test_parquet_writer_context_obj(tmpdir):
 
             frames.append(df.copy())
 
-    buf = out.get_result()
+    buf = out.getvalue()
     result = _read_table(pa.BufferReader(buf))
 
     expected = pd.concat(frames, ignore_index=True)
@@ -2143,7 +2143,7 @@ def test_parquet_writer_context_obj_with_exception(tmpdir):
     except Exception as e:
         assert str(e) == error_text
 
-    buf = out.get_result()
+    buf = out.getvalue()
     result = _read_table(pa.BufferReader(buf))
 
     expected = pd.concat(frames, ignore_index=True)