内存和IO接口#

本节将向您介绍 PyArrow 内存管理和IO系统中的主要概念

  • 缓冲区

  • 内存池

  • 类文件和类流对象

引用和分配内存#

pyarrow.Buffer#

Buffer 对象封装了 C++ arrow::Buffer 类型，它是 Apache Arrow 在 C++ 中内存管理的主要工具。它允许更高级别的数组类安全地与内存交互，而这些数组类可能拥有也可能不拥有该内存。 arrow::Buffer 可以进行零拷贝切片，以允许 Buffer 以低成本引用其他 Buffer，同时保留内存生命周期并维护清晰的父子关系。

arrow::Buffer 有许多实现，但它们都提供了一个标准接口：数据指针和长度。这类似于 Python 的内置 buffer protocol 和 memoryview 对象。

可以通过调用 py_buffer() 函数，从实现缓冲协议的任何 Python 对象创建 Buffer。让我们考虑一个字节对象

In [1]: import pyarrow as pa

In [2]: data = b'abcdefghijklmnopqrstuvwxyz'

In [3]: buf = pa.py_buffer(data)

In [4]: buf
Out[4]: <pyarrow.Buffer address=0x7f15605eae90 size=26 is_cpu=True is_mutable=False>

In [5]: buf.size
Out[5]: 26

以这种方式创建 Buffer 不会分配任何内存；它是从 data 字节对象导出的内存上的零拷贝视图。

外部内存（以原始指针和大小的形式）也可以使用 foreign_buffer() 函数进行引用。

在需要 Python 缓冲区或内存视图的情况下可以使用 Buffer，并且此类转换是零拷贝的。

In [6]: memoryview(buf)
Out[6]: <memory at 0x7f15635cb880>

Buffer 的 to_pybytes() 方法将 Buffer 的数据转换为 Python 字节字符串（因此会复制数据）。

In [7]: buf.to_pybytes()
Out[7]: b'abcdefghijklmnopqrstuvwxyz'

内存池#

所有内存分配和释放操作（例如 C 语言中的 malloc 和 free）都在 MemoryPool 的实例中进行跟踪。这意味着我们可以精确地跟踪已分配的内存量。

In [8]: pa.total_allocated_bytes()
Out[8]: 56320

让我们从默认池中分配一个可调整大小的 Buffer。

In [9]: buf = pa.allocate_buffer(1024, resizable=True)

In [10]: pa.total_allocated_bytes()
Out[10]: 57344

In [11]: buf.resize(2048)

In [12]: pa.total_allocated_bytes()
Out[12]: 58368

默认分配器以至少 64 字节的增量请求内存。如果缓冲区被垃圾回收，则释放所有内存。

In [13]: buf = None

In [14]: pa.total_allocated_bytes()
Out[14]: 56320

除了默认的内置内存池之外，可能还有其他可供选择的内存池（例如 jemalloc），具体取决于 Arrow 的构建方式。可以获取内存池的后端名称。

>>> pa.default_memory_pool().backend_name
'mimalloc'

另请参阅

内存池的 API 文档。.

另请参阅

使用 Arrow 的可选 CUDA 集成 的 GPU 上的缓冲区。

输入和输出#

Arrow C++ 库为不同类型的 IO 对象提供了一些抽象接口。

  • 只读流

  • 支持随机访问的只读文件

  • 只写流

  • 支持随机访问的只写文件

  • 支持读取、写入和随机访问的文件

为了使这些对象的行为更像 Python 的内置 file 对象，我们定义了一个 NativeFile 基类，它实现了与常规 Python 文件对象相同的 API。

NativeFile 有一些重要的特性，使其在可能的情况下优于将 Python 文件与 PyArrow 一起使用。

  • 其他 Arrow 类可以原生访问内部 C++ IO 对象，并且不需要获取 Python GIL。

  • 本地 C++ IO 可能能够执行零拷贝 IO，例如使用内存映射。

有几种可用的 NativeFile 选项。

还有一些高级 API 可以更轻松地实例化常见类型的流。

高级 API#

输入流#

input_stream() 函数允许从各种来源创建可读的 NativeFile。

  • 如果传递 Buffer 或 memoryview 对象，则将返回 BufferReader。

    In [15]: buf = memoryview(b"some data")

In [16]: stream = pa.input_stream(buf)

In [17]: stream.read(4)
Out[17]: b'some'

  • 如果传递字符串或文件路径，它将打开磁盘上的指定文件以进行读取，并创建一个 OSFile。可选地，可以压缩文件：如果其文件名以识别的扩展名（例如 .gz）结尾，则在读取时会自动对其内容进行解压缩。

    In [18]: import gzip

In [19]: with gzip.open('example.gz', 'wb') as f:
   ....:     f.write(b'some data\n' * 3)
   ....: 

In [20]: stream = pa.input_stream('example.gz')

In [21]: stream.read()
Out[21]: b'some data\nsome data\nsome data\n'

  • 如果传递 Python 文件对象，它将被包装在 PythonFile 中，以便 Arrow C++ 库可以从中读取数据（以牺牲少量开销为代价）。

输出流#

output_stream() 是输出流的等效函数，允许创建可写的 NativeFile。它具有与上面为 input_stream() 解释的相同功能，例如能够写入缓冲区或进行实时压缩。

In [22]: with pa.output_stream('example1.dat') as stream:
   ....:     stream.write(b'some data')
   ....: 

In [23]: f = open('example1.dat', 'rb')

In [24]: f.read()
Out[24]: b'some data'

磁盘文件和内存映射文件#

PyArrow 包含两种与磁盘上的数据交互的方式：标准操作系统级文件 API 和内存映射文件。在常规 Python 中，我们可以编写

In [25]: with open('example2.dat', 'wb') as f:
   ....:     f.write(b'some example data')
   ....:

使用 pyarrow 的 OSFile 类，您可以编写

In [26]: with pa.OSFile('example3.dat', 'wb') as f:
   ....:     f.write(b'some example data')
   ....:

读取文件时，可以使用OSFile 或 MemoryMappedFile。两者之间的区别在于，OSFile 在每次读取时都会分配新的内存，类似于 Python 文件对象。在内存映射读取中，库会构建一个引用映射内存的缓冲区，而无需任何内存分配或复制。

In [27]: file_obj = pa.OSFile('example2.dat')

In [28]: mmap = pa.memory_map('example3.dat')

In [29]: file_obj.read(4)
Out[29]: b'some'

In [30]: mmap.read(4)
Out[30]: b'some'

read 方法实现了标准的 Python 文件 read API。要读取到 Arrow 缓冲区对象中，请使用 read_buffer

In [31]: mmap.seek(0)
Out[31]: 0

In [32]: buf = mmap.read_buffer(4)

In [33]: print(buf)
<pyarrow.Buffer address=0x7f15ffe9b000 size=4 is_cpu=True is_mutable=False>

In [34]: buf.to_pybytes()
Out[34]: b'some'

PyArrow 中的许多工具，特别是 Apache Parquet 接口以及文件和流消息传递工具，在与这些 NativeFile 类型一起使用时，比与普通的 Python 文件对象一起使用效率更高。

内存中读取和写入#

为了协助内存中数据的序列化和反序列化，我们提供了可以读取和写入 Arrow 缓冲区的文件接口。

In [35]: writer = pa.BufferOutputStream()

In [36]: writer.write(b'hello, friends')
Out[36]: 14

In [37]: buf = writer.getvalue()

In [38]: buf
Out[38]: <pyarrow.Buffer address=0x7f15f6613000 size=14 is_cpu=True is_mutable=True>

In [39]: buf.size
Out[39]: 14

In [40]: reader = pa.BufferReader(buf)

In [41]: reader.seek(7)
Out[41]: 7

In [42]: reader.read(7)
Out[42]: b'friends'

这些接口与 Python 内置的 io.BytesIO 具有类似的语义。

本页内容
在 GitHub 上编辑