numpy.lib.format#

二进制序列化

NPY 格式#

一种简单的格式，用于将 NumPy 数组及其完整信息保存到磁盘。

.npy 格式是 NumPy 中用于在磁盘上持久化单个任意 NumPy 数组的标准二进制文件格式。该格式存储了所有必要的形状和 dtype 信息，即使在不同架构的机器上也能正确重建数组。该格式的设计尽可能简单，同时实现了其有限的目标。

.npz 格式是用于在磁盘上持久化多个 NumPy 数组的标准格式。.npz 文件是一个 zip 文件，其中包含多个 .npy 文件，每个文件对应一个数组。

功能#

  • 可以表示所有 NumPy 数组，包括嵌套记录数组和对象数组。

  • 以其原生二进制形式表示数据。

  • 直接支持 Fortran 连续数组。

  • 存储所有必要的信息以重建数组，包括在不同架构机器上的形状和 dtype。支持小端和大端数组，包含小端数字的文件在任何读取该文件的机器上都将生成小端数组。类型根据其实际大小进行描述。例如，如果一台具有 64 位 C“long int”的机器写入一个包含“long int”的数组，那么一台具有 32 位 C“long int”的读取机器将生成一个包含 64 位整数的数组。

  • 易于逆向工程。数据集通常比创建它们的程序寿命更长。一个有能力的开发人员应该能够用他们喜欢的编程语言创建一个解决方案，在不需要太多文档的情况下读取他们获得的绝大多数 .npy 文件。

  • 允许数据内存映射。参见 open_memmap。

  • 可以从类似文件流的对象而不是实际文件读取。

  • 存储对象数组，即包含任意 Python 对象的元素数组。包含对象数组的文件不能进行内存映射，但可以读取和写入磁盘。

限制#

  • numpy.ndarray 的任意子类不会完全保留。子类将被接受用于写入，但只会写入数组数据。读取文件时将创建一个常规的 numpy.ndarray 对象。

警告

由于结构化 dtypes 解释的限制，具有空名称字段的 dtypes 的名称将被替换为“f0”、“f1”等。此类数组将无法完全准确地通过格式往返。数据是完整的；只有字段名称会有所不同。我们正在努力修复此问题。此修复不需要更改文件格式。具有此类结构的数组仍然可以保存和恢复，并且可以通过使用 loadedarray.view(correct_dtype) 方法恢复正确的 dtype。

文件扩展名#

我们建议对此格式保存的文件使用 .npy 和 .npz 扩展名。这绝不是一个要求；应用程序可能希望使用这些文件格式，但使用特定于应用程序的扩展名。然而，在没有明显替代方案的情况下，我们建议使用 .npy 和 .npz。

版本编号#

这些格式的版本编号独立于 NumPy 版本编号。如果格式升级，numpy.io 中的代码仍将能够读写 1.0 版本文件。

格式版本 1.0#

前 6 字节是一个魔术字符串：精确的 \x93NUMPY。

接下来的 1 字节是一个无符号字节：文件格式的主版本号，例如 \x01。

接下来的 1 字节是一个无符号字节：文件格式的次版本号，例如 \x00。注意：文件格式的版本与 numpy 包的版本无关。

接下来的 2 字节构成一个小端无符号短整型：头部数据 HEADER_LEN 的长度。

接下来的 HEADER_LEN 字节构成描述数组格式的头部数据。它是一个 ASCII 字符串，其中包含字典的 Python 字面量表达式。它以换行符 (\n) 终止，并用空格 (\x20) 填充，以使 len(magic string) + 2 + len(length) + HEADER_LEN 的总长度能够被 64 整除，以实现对齐目的。

字典包含三个键

“descr”dtype.descr

一个可以作为参数传递给 numpy.dtype 构造函数以创建数组 dtype 的对象。

“fortran_order”bool

数组数据是否为 Fortran 连续。由于 Fortran 连续数组是常见的非 C 连续形式，我们允许它们直接写入磁盘以提高效率。

“shape”int 元组

数组的形状。

为了可重复性和可读性，字典键按字母顺序排序。这仅为方便。写入者 SHOULD 尽可能实现此功能。读取者 MUST NOT 依赖此功能。

头部后面是数组数据。如果 dtype 包含 Python 对象（即 dtype.hasobject is True），则数据是数组的 Python pickle。否则，数据是数组的连续（C 或 Fortran，取决于 fortran_order）字节。消费者可以通过将形状给出的元素数量（注意 shape=() 表示有 1 个元素）乘以 dtype.itemsize 来计算字节数。

格式版本 2.0#

版本 1.0 格式只允许数组头部总大小为 65535 字节。对于具有大量列的结构化数组，这可能会超出。版本 2.0 格式将头部大小扩展到 4 GiB。numpy.save 如果数据需要，将自动以 2.0 格式保存，否则它将始终使用更兼容的 1.0 格式。

因此，头部第四个元素的描述变为：“接下来的 4 字节构成一个小端无符号整型：头部数据 HEADER_LEN 的长度。”

格式版本 3.0#

此版本用 utf8 编码的字符串替换了 ASCII 字符串（实际中是 latin1），因此支持带有任何 unicode 字段名称的结构化类型。

备注#

.npy 格式，包括创建它的动机以及替代方案的比较，在 “npy-format” NEP 中有所描述，但细节随时间有所演变，本文档更为新近。

函数

descr_to_dtype(descr)

根据给定描述返回 dtype。

drop_metadata(dtype, /)

如果 dtype 不包含元数据，则返回未更改的 dtype；如果它（或其任何结构 dtype）包含元数据，则返回 dtype 的副本。

dtype_to_descr(dtype)

从 dtype 获取可序列化的描述符。

header_data_from_array_1_0(array)

从 numpy.ndarray 获取头部元数据的字典。

isfileobj(f)

magic(major, minor)

返回给定文件格式版本的魔术字符串。

open_memmap(filename[, mode, dtype, shape, ...])

将 .npy 文件作为内存映射数组打开。

read_array(fp[, allow_pickle, ...])

从 NPY 文件读取数组。

read_array_header_1_0(fp[, max_header_size])

使用 1.0 文件格式版本从类似文件对象读取数组头部。

read_array_header_2_0(fp[, max_header_size])

使用 2.0 文件格式版本从类似文件对象读取数组头部。

read_magic(fp)

读取魔术字符串以获取文件格式的版本。

write_array(fp, array[, version, ...])

将数组写入 NPY 文件，包括头部。

write_array_header_1_0(fp, d)

使用 1.0 格式写入数组头部。

write_array_header_2_0(fp, d)

使用 2.0 格式写入数组头部。