numpy.lib.format#

二进制序列化

NPY 格式#

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

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

.npz 格式是将多个 NumPy 数组持久化到磁盘的标准格式。 .npz 文件是一个 zip 文件，包含多个 .npy 文件，每个文件对应一个数组。

功能#

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

  • 以其本机二进制形式表示数据。

  • 直接支持 Fortran 连续数组。

  • 存储重建数组所需的所有信息，包括在不同架构的机器上形状和 dtype。支持小端和大端数组，并且具有小端数字的文件将在读取文件的任何机器上产生小端数组。这些类型根据其实际大小进行描述。例如，如果具有 64 位 C“长整型”的机器写出包含“长整型”的数组，则具有 32 位 C“长整型”的读取机器将产生包含 64 位整数的数组。

  • 易于反向工程。数据集通常比创建它们的程序存活时间更长。熟练的开发人员应该能够在其首选编程语言中创建解决方案来读取他们获得的大多数 .npy 文件，而无需太多文档。

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

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

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

限制#

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

警告

由于结构化 dtype 解释中的限制，字段名称为空的 dtype 的名称将被替换为“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。否则，数据是数组的连续字节（取决于 fortran_order，为 C 连续或 Fortran 连续）。使用者可以通过将形状给出的元素数量（注意 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 格式写入数组的头文件。