Streaming, Serialization, and IPC

Writing and Reading Streams

Arrow defines two types of binary formats for serializing record batches:

  • Streaming format: for sending an arbitrary length sequence of record batches. The format must be processed from start to end, and does not support random access
  • File or Random Access format: for serializing a fixed number of record batches. Supports random access, and thus is very useful when used with memory maps

To follow this section, make sure to first read the section on Memory and IO.

Using streams

First, let’s create a small record batch:

In [1]: import pyarrow as pa

In [2]: data = [
   ...:     pa.array([1, 2, 3, 4]),
   ...:     pa.array(['foo', 'bar', 'baz', None]),
   ...:     pa.array([True, None, False, True])
   ...: ]
   ...: 

In [3]: batch = pa.RecordBatch.from_arrays(data, ['f0', 'f1', 'f2'])

In [4]: batch.num_rows
Out[4]: 4

In [5]: batch.num_columns
Out[5]: 3

Now, we can begin writing a stream containing some number of these batches. For this we use RecordBatchStreamWriter, which can write to a writeable NativeFile object or a writeable Python object:

In [6]: sink = pa.BufferOutputStream()

In [7]: writer = pa.RecordBatchStreamWriter(sink, batch.schema)

Here we used an in-memory Arrow buffer stream, but this could have been a socket or some other IO sink.

When creating the StreamWriter, we pass the schema, since the schema (column names and types) must be the same for all of the batches sent in this particular stream. Now we can do:

In [8]: for i in range(5):
   ...:    writer.write_batch(batch)
   ...: 

In [9]: writer.close()

In [10]: buf = sink.getvalue()

In [11]: buf.size
Out[11]: 1972

Now buf contains the complete stream as an in-memory byte buffer. We can read such a stream with RecordBatchStreamReader or the convenience function pyarrow.open_stream:

In [12]: reader = pa.open_stream(buf)

In [13]: reader.schema
Out[13]: 
f0: int64
f1: string
f2: bool

In [14]: batches = [b for b in reader]

In [15]: len(batches)
Out[15]: 5

We can check the returned batches are the same as the original input:

In [16]: batches[0].equals(batch)
Out[16]: True

An important point is that if the input source supports zero-copy reads (e.g. like a memory map, or pyarrow.BufferReader), then the returned batches are also zero-copy and do not allocate any new memory on read.

Writing and Reading Random Access Files

The RecordBatchFileWriter has the same API as RecordBatchStreamWriter:

In [17]: sink = pa.BufferOutputStream()

In [18]: writer = pa.RecordBatchFileWriter(sink, batch.schema)

In [19]: for i in range(10):
   ....:    writer.write_batch(batch)
   ....: 

In [20]: writer.close()

In [21]: buf = sink.getvalue()

In [22]: buf.size
Out[22]: 4210

The difference between RecordBatchFileReader and RecordBatchStreamReader is that the input source must have a seek method for random access. The stream reader only requires read operations. We can also use the pyarrow.open_file method to open a file:

In [23]: reader = pa.open_file(buf)

Because we have access to the entire payload, we know the number of record batches in the file, and can read any at random:

In [24]: reader.num_record_batches
Out[24]: 10

In [25]: b = reader.get_batch(3)

In [26]: b.equals(batch)
Out[26]: True

Reading from Stream and File Format for pandas

The stream and file reader classes have a special read_pandas method to simplify reading multiple record batches and converting them to a single DataFrame output:

In [27]: df = pa.open_file(buf).read_pandas()

In [28]: df[:5]
Out[28]: 
   f0    f1     f2
0   1   foo   True
1   2   bar   None
2   3   baz  False
3   4  None   True
4   1   foo   True

Arbitrary Object Serialization

In pyarrow we are able to serialize and deserialize many kinds of Python objects. While not a complete replacement for the pickle module, these functions can be significantly faster, particular when dealing with collections of NumPy arrays.

As an example, consider a dictionary containing NumPy arrays:

In [29]: import numpy as np

In [30]: data = {
   ....:     i: np.random.randn(500, 500)
   ....:     for i in range(100)
   ....: }
   ....: 

We use the pyarrow.serialize function to convert this data to a byte buffer:

In [31]: buf = pa.serialize(data).to_buffer()

In [32]: type(buf)
Out[32]: pyarrow.lib.Buffer

In [33]: buf.size
Out[33]: 200028864

pyarrow.serialize creates an intermediate object which can be converted to a buffer (the to_buffer method) or written directly to an output stream.

pyarrow.deserialize converts a buffer-like object back to the original Python object:

In [34]: restored_data = pa.deserialize(buf)

In [35]: restored_data[0]
Out[35]: 
array([[-0.11934681, -0.05200634,  1.23742188, ..., -0.20506977,
         1.08926609, -0.86184408],
       [-0.11915956,  1.96879756,  1.1802925 , ..., -0.38705742,
         2.9060489 ,  0.05931682],
       [ 0.89644892,  1.41302155, -1.50753096, ...,  0.85474039,
        -0.20359629, -0.46097135],
       ...,
       [ 1.11018361,  1.90576189,  0.54671721, ..., -0.98689833,
         2.26891513,  1.15842604],
       [-0.49557525,  0.29067071, -1.71037233, ..., -0.5149435 ,
        -0.73024926, -1.33543425],
       [ 0.01577432, -1.63049299,  0.29785447, ...,  0.06147882,
         0.47864413,  1.78573874]])

When dealing with NumPy arrays, pyarrow.deserialize can be significantly faster than pickle because the resulting arrays are zero-copy references into the input buffer. The larger the arrays, the larger the performance savings.

Consider this example, we have for pyarrow.deserialize

In [36]: %timeit restored_data = pa.deserialize(buf)
214 us +- 3.52 us per loop (mean +- std. dev. of 7 runs, 1000 loops each)

And for pickle:

In [37]: import pickle

In [38]: pickled = pickle.dumps(data)

In [39]: %timeit unpickled_data = pickle.loads(pickled)
52.5 ms +- 955 us per loop (mean +- std. dev. of 7 runs, 10 loops each)

We aspire to make these functions a high-speed alternative to pickle for transient serialization in Python big data applications.

Serializing Custom Data Types

If an unrecognized data type is encountered when serializing an object, pyarrow will fall back on using pickle for converting that type to a byte string. There may be a more efficient way, though.

Consider a class with two members, one of which is a NumPy array:

class MyData:
    def __init__(self, name, data):
        self.name = name
        self.data = data

We write functions to convert this to and from a dictionary with simpler types:

def _serialize_MyData(val):
    return {'name': val.name, 'data': val.data}

def _deserialize_MyData(data):
    return MyData(data['name'], data['data']

then, we must register these functions in a SerializationContext so that MyData can be recognized:

context = pa.SerializationContext()
context.register_type(MyData, 'MyData',
                      custom_serializer=_serialize_MyData,
                      custom_deserializer=_deserialize_MyData)

Lastly, we use this context as an additional argument to pyarrow.serialize:

buf = pa.serialize(val, context=context).to_buffer()
restored_val = pa.deserialize(buf, context=context)

The SerializationContext also has convenience methods serialize and deserialize, so these are equivalent statements:

buf = context.serialize(val).to_buffer()
restored_val = context.deserialize(buf)

Component-based Serialization

For serializing Python objects containing some number of NumPy arrays, Arrow buffers, or other data types, it may be desirable to transport their serialized representation without having to produce an intermediate copy using the to_buffer method. To motivate this, suppose we have a list of NumPy arrays:

In [40]: import numpy as np

In [41]: data = [np.random.randn(10, 10) for i in range(5)]

The call pa.serialize(data) does not copy the memory inside each of these NumPy arrays. This serialized representation can be then decomposed into a dictionary containing a sequence of pyarrow.Buffer objects containing metadata for each array and references to the memory inside the arrays. To do this, use the to_components method:

In [42]: serialized = pa.serialize(data)

In [43]: components = serialized.to_components()

The particular details of the output of to_components are not too important. The objects in the 'data' field are pyarrow.Buffer objects, which are zero-copy convertible to Python memoryview objects:

In [44]: memoryview(components['data'][0])
Out[44]: <memory at 0x7fad18ee6ac8>

A memoryview can be converted back to a Arrow Buffer with pyarrow.py_buffer:

In [45]: mv = memoryview(components['data'][0])

In [46]: buf = pa.py_buffer(mv)

An object can be reconstructed from its component-based representation using deserialize_components:

In [47]: restored_data = pa.deserialize_components(components)

In [48]: restored_data[0]
Out[48]: 
array([[ 0.08016736, -1.10365718, -0.28473625,  0.0121872 , -2.18999907,
         0.91349105,  0.40083557,  0.2988373 , -0.26251773,  0.38293258],
       [-0.37436889, -0.20980289, -1.23297012,  0.71050457, -0.80959044,
        -1.65481547,  0.49429402,  0.38988438,  0.4232931 , -1.04580636],
       [-1.26621474,  1.14578731,  0.30126857,  2.28172864,  0.3620479 ,
        -0.6980641 ,  0.04824971,  0.7012691 ,  1.38426582, -2.12765654],
       [-0.49029201,  0.2132297 ,  0.81915336,  1.59427007,  0.0539088 ,
        -0.12641706,  0.49714672,  0.29231024, -0.32353557, -1.31312737],
       [ 0.6232627 , -0.66711828, -1.13563246,  1.67548086, -0.92868105,
        -0.5393561 , -1.91190574, -0.91297378,  0.54973773,  0.27772547],
       [-1.90710225,  2.18607444,  1.61265715, -2.05900687,  0.87978499,
        -0.36293952,  0.1096751 ,  0.70803928,  0.91170672,  2.26372655],
       [-1.29948672, -1.16915008, -0.28819731, -0.32683579, -0.94937313,
         0.97269989,  0.93921195,  1.97256998,  0.47939877,  0.75675476],
       [-1.28937825, -0.55612664,  0.26065597,  0.45298799, -1.15134231,
         0.73277611,  1.86672128,  1.21471539,  1.58583206,  0.41572541],
       [ 0.08257109, -0.8667173 ,  0.96905283,  1.44056205,  0.11142042,
        -0.56164313,  0.05980007, -0.37832024,  0.29238638,  1.79787679],
       [ 2.39047453,  0.68908052, -0.17601861,  0.24710807, -0.4170626 ,
         1.05110014, -0.49750224, -0.7430368 , -0.10769135,  2.46293641]])

deserialize_components is also available as a method on SerializationContext objects.

Serializing pandas Objects

The default serialization context has optimized handling of pandas objects like DataFrame and Series. Combined with component-based serialization above, this enables zero-copy transport of pandas DataFrame objects not containing any Python objects:

In [49]: import pandas as pd

In [50]: df = pd.DataFrame({'a': [1, 2, 3, 4, 5]})

In [51]: context = pa.default_serialization_context()

In [52]: serialized_df = context.serialize(df)

In [53]: df_components = serialized_df.to_components()

In [54]: original_df = context.deserialize_components(df_components)

In [55]: original_df
Out[55]: 
   a
0  1
1  2
2  3
3  4
4  5

Feather Format

Feather is a lightweight file-format for data frames that uses the Arrow memory layout for data representation on disk. It was created early in the Arrow project as a proof of concept for fast, language-agnostic data frame storage for Python (pandas) and R.

Compared with Arrow streams and files, Feather has some limitations:

  • Only non-nested data types and categorical (dictionary-encoded) types are supported
  • Supports only a single batch of rows, where general Arrow streams support an arbitrary number
  • Supports limited scalar value types, adequate only for representing typical data found in R and pandas

We would like to continue to innovate in the Feather format, but we must wait for an R implementation for Arrow to mature.

The pyarrow.feather module contains the read and write functions for the format. The input and output are pandas.DataFrame objects:

import pyarrow.feather as feather

feather.write_feather(df, '/path/to/file')
read_df = feather.read_feather('/path/to/file')

read_feather supports multithreaded reads, and may yield faster performance on some files:

read_df = feather.read_feather('/path/to/file', nthreads=4)

These functions can read and write with file-like objects. For example:

with open('/path/to/file', 'wb') as f:
    feather.write_feather(df, f)

with open('/path/to/file', 'rb') as f:
    read_df = feather.read_feather(f)

A file input to read_feather must support seeking.