数组接口协议#

注意

本页面描述了 NumPy 特有的 API，用于从其他 C 扩展访问 NumPy 数组的内容。PEP 3118 – 修订后的缓冲区协议 引入了类似的标准化 API，供任何扩展模块使用。Cython 的缓冲区数组支持使用 PEP 3118 API；请参阅 Cython NumPy 教程。

版本:

3

数组接口（有时称为数组协议）创建于 2005 年，旨在使类似数组的 Python 对象在可能的情况下智能地重用彼此的数据缓冲区。同构 N 维数组接口是对象共享 N 维数组内存和信息的默认机制。该接口由一个 Python 侧和一个 C 侧组成，使用两个属性。在应用程序代码中希望被视为 N 维数组的对象应至少支持这些属性中的一个。在应用程序代码中希望支持 N 维数组的对象应查找这些属性中的至少一个，并适当使用所提供的信息。

此接口描述的是同构数组，即数组的每个项具有相同的“类型”。此类型可以非常简单，也可以是相当任意和复杂的 C 风格结构。

使用该接口有两种方式：Python 侧和 C 侧。两者是独立的属性。

Python 侧#

这种接口方法要求对象具有 __array_interface__ 属性。

object.__array_interface__#

一个包含项的字典（3 个必需，5 个可选）。如果未提供可选键，则它们具有隐含的默认值。

键包括

shape (必需)

一个元组，其元素是数组在每个维度上的大小。每个条目都是一个整数（一个 Python int）。请注意，这些整数可能大于平台 int 或 long 所能容纳的大小（Python int 是 C long）。使用此属性的代码应适当处理这种情况；要么在可能溢出时引发错误，要么使用 long long 作为形状的 C 类型。

typestr (必需)

一个字符串，提供同构数组的基本类型。基本字符串格式由 3 部分组成：一个描述数据字节序的字符（<：小端，>：大端，|：不相关），一个给出数组基本类型的字符代码，以及一个提供该类型所用字节数的整数。

基本类型字符代码如下

t

位域（后面的整数给出位域中的位数）。

b

布尔值（所有值仅为 True 或 False 的整数类型）

i

整数

u

无符号整数

f

浮点数

c

复浮点数

m

时间差

M

日期时间

O

对象（即内存包含指向 PyObject 的指针）

S

字符串（固定长度的 char 序列）

U

Unicode（固定长度的 Py_UCS4 序列）

V

其他（void * – 每个项是固定大小的内存块）
descr (可选)

一个元组列表，提供了同构数组中每个项的内存布局的更详细描述。列表中每个元组包含两个或三个元素。通常，当 typestr 为 V[0-9]+ 时会使用此属性，但这并非必需。唯一的要求是 typestr 键中表示的字节数与此处表示的总字节数相同。其目的是支持构成数组元素的 C 风格结构体的描述。列表中每个元组的元素是

  1. 一个字符串，提供了与此数据类型部分关联的名称。这也可以是 ('完整名称', '基本名称') 的元组，其中基本名称将是表示字段完整名称的有效 Python 变量名。

  2. 一个基本类型描述字符串，如 typestr 中所示，或另一个列表（用于嵌套结构化类型）

  3. 一个可选的形状元组，提供了此结构部分应重复的次数。如果未给出，则假定不重复。使用此通用接口可以描述非常复杂的结构。但请注意，数组的每个元素仍然是相同的数据类型。下面给出了一些使用此接口的示例。

默认值: [('', typestr)]

data (可选)

一个两元素元组，其第一个参数是一个指向存储数组内容的内存区域的 Python 整数。

注意

通过 PyLong_From* 或 Cython 或 pybind11 等高级绑定从 C/C++ 转换时，请确保使用足够大的位宽整数。

此指针必须指向数据的第一个元素（换句话说，在这种情况下任何偏移量都将被忽略）。元组中的第二个条目是只读标志（true 表示数据区域是只读的）。

此属性也可以是公开 缓冲区接口 的对象，该对象将用于共享数据。如果此键不存在（或返回 None），则内存共享将通过对象自身的缓冲区接口完成。在这种情况下，offset 键可用于指示缓冲区的起始位置。如果内存区域要被保护，新对象必须存储对公开数组接口的对象的引用。

默认值: None

strides (可选)

要么是 None 表示 C 风格的连续数组，要么是步长元组，提供在相应维度中跳转到下一个数组元素所需的字节数。每个条目必须是整数（一个 Python int）。与 shape 一样，值可能大于 C int 或 long 所能表示的大小；调用代码应适当处理此情况，要么引发错误，要么在 C 中使用 long long。默认值为 None，这意味着 C 风格的连续内存缓冲区。在此模型中，数组的最后一个维度变化最快。例如，对于数组条目为 8 字节长且形状为 (10, 20, 30) 的对象，默认的步长元组将是 (4800, 240, 8)。

默认值: None (C 风格连续)

mask (可选)

None 或一个公开数组接口的对象。掩码数组的所有元素应仅被解释为真或非真，以指示此数组的哪些元素是有效的。此对象的形状应可 “广播” 到原始数组的形状。

默认值: None (所有数组值均有效)

offset (可选)

数组数据区域内的整数偏移量。这只能在 data 为 None 或返回 memoryview 对象时使用。

默认值: 0。

version (必需)

一个整数，表示接口的版本（例如，此版本为 3）。请注意不要用此来使公开未来版本接口的对象失效。

C 结构体访问#

这种数组接口方法允许仅使用一个属性查找和一个定义良好的 C 结构体来更快地访问数组。

object.__array_struct__#

一个 PyCapsule，其 pointer 成员包含指向已填充的 PyArrayInterface 结构的指针。结构的内存是动态创建的，PyCapsule 也用适当的析构函数创建，因此此属性的检索者只需在完成后对该属性返回的对象应用 Py_DECREF。此外，要么需要复制出数据，要么必须保留对公开此属性的对象的引用，以确保数据不会被释放。公开 __array_struct__ 接口的对象，如果其他对象引用它们，也不得重新分配它们的内存。

PyArrayInterface 结构体定义在 numpy/ndarrayobject.h 中，如下所示：

typedef struct {
  int two;              /* contains the integer 2 -- simple sanity check */
  int nd;               /* number of dimensions */
  char typekind;        /* kind in array --- character code of typestr */
  int itemsize;         /* size of each element */
  int flags;            /* flags indicating how the data should be interpreted */
                        /*   must set ARR_HAS_DESCR bit to validate descr */
  Py_ssize_t *shape;    /* A length-nd array of shape information */
  Py_ssize_t *strides;  /* A length-nd array of stride information */
  void *data;           /* A pointer to the first element of the array */
  PyObject *descr;      /* NULL or data-description (same as descr key
                                of __array_interface__) -- must set ARR_HAS_DESCR
                                flag or this will be ignored. */
} PyArrayInterface;

flags 成员可以包含 5 位，指示数据应如何解释，以及 1 位，指示接口应如何解释。数据位是 NPY_ARRAY_C_CONTIGUOUS (0x1)，NPY_ARRAY_F_CONTIGUOUS (0x2)，NPY_ARRAY_ALIGNED (0x100)，NPY_ARRAY_NOTSWAPPED (0x200) 和 NPY_ARRAY_WRITEABLE (0x400)。最后一个标志 NPY_ARR_HAS_DESCR (0x800) 指示此结构是否包含 arrdescr 字段。除非存在此标志，否则不应访问该字段。

NPY_ARR_HAS_DESCR#

自 2006 年 6 月 16 日以来新增

过去，大多数实现都使用 PyCObject（现在是 PyCapsule）自身的 desc 成员（不要将其与上述 PyArrayInterface 结构体的“descr”成员混淆——它们是两个不同的东西）来保存公开接口的对象的指针。这现在是接口的明确部分。请务必在返回 PyCapsule 之前，获取对象的引用并调用 PyCapsule_SetContext，并配置一个析构函数来减少此引用计数。

注意

__array_struct__ 被认为是遗留产物，不应用于新代码。请改用 缓冲区协议 或 DLPack 协议 numpy.from_dlpack。

类型描述示例#

为了清晰起见，提供一些类型描述和相应的 __array_interface__ 'descr' 条目的示例会很有用。感谢 Scott Gilbert 提供的这些示例。

在每种情况下，'descr' 键都是可选的，但它当然提供了更多信息，这可能对各种应用程序很重要。

* Float data
    typestr == '>f4'
    descr == [('','>f4')]

* Complex double
    typestr == '>c8'
    descr == [('real','>f4'), ('imag','>f4')]

* RGB Pixel data
    typestr == '|V3'
    descr == [('r','|u1'), ('g','|u1'), ('b','|u1')]

* Mixed endian (weird but could happen).
    typestr == '|V8' (or '>u8')
    descr == [('big','>i4'), ('little','<i4')]

* Nested structure
    struct {
        int ival;
        struct {
            unsigned short sval;
            unsigned char bval;
            unsigned char cval;
        } sub;
    }
    typestr == '|V8' (or '<u8' if you want)
    descr == [('ival','<i4'), ('sub', [('sval','<u2'), ('bval','|u1'), ('cval','|u1') ]) ]

* Nested array
    struct {
        int ival;
        double data[16*4];
    }
    typestr == '|V516'
    descr == [('ival','>i4'), ('data','>f8',(16,4))]

* Padded structure
    struct {
        int ival;
        double dval;
    }
    typestr == '|V16'
    descr == [('ival','>i4'),('','|V4'),('dval','>f8')]

显然，任何结构化类型都可以使用此接口进行描述。

与数组接口（版本 2）的区别#

版本 2 接口非常相似。差异主要在于美学。特别是

  1. PyArrayInterface 结构末尾没有 descr 成员（因此也没有标志 ARR_HAS_DESCR）

  2. 从 __array_struct__ 返回的 PyCapsule（以前是 PyCObject 的 desc 成员）的 context 成员未指定。通常，它是公开数组的对象（以便可以保留对它的引用，并在 C 对象销毁时销毁）。现在，明确要求以某种方式使用此字段来持有对拥有对象的引用。

    注意

    直到 2020 年 8 月，这里写道

    现在它必须是一个元组，其第一个元素是字符串“PyArrayInterface Version #”，第二个元素是公开数组的对象。

    此设计在提出后几乎立即被撤回，见 https://mail.python.org/pipermail/numpy-discussion/2006-June/020995.html。尽管有 14 年的文档声称相反，但在任何时候都不能假定 __array_interface__ 封装包含此元组内容。

  3. 从 __array_interface__['data'] 返回的元组以前是一个十六进制字符串（现在是一个整数或长整数）。

  4. 以前没有 __array_interface__ 属性，而是 __array_interface__ 字典中的所有键（版本除外）都是它们自己的属性：因此，要获取 Python 侧的信息，您必须单独访问这些属性：

    • __array_data__

    • __array_shape__

    • __array_strides__

    • __array_typestr__

    • __array_descr__

    • __array_offset__

    • __array_mask__