Интерфейс массива

Интерфейс массива (иногда называемый протоколом массива) был создан в 2005 году как способ для подобных массивам объектов Python повторно использовать буферы данных друг друга, когда это возможно. Однородный N-мерный интерфейс массива является стандартным механизмом для объектов, чтобы обмениваться N-мерной памятью массива и информацией. Интерфейс состоит из стороны Python и стороны C, использующих два атрибута. Объекты, желающие рассматриваться как N-мерный массив в прикладном коде, должны поддерживать хотя бы один из этих атрибутов. Объекты, желающие поддерживать N-мерный массив в прикладном коде, должны искать хотя бы один из этих атрибутов и использовать предоставленную информацию соответствующим образом.

Этот интерфейс описывает однородные массивы в том смысле, что каждый элемент массива имеет один и тот же «тип». Этот тип может быть очень простым или достаточно произвольным и сложным структурой, похожей на C.

Существует два способа использования интерфейса: сторона Python и сторона C. Оба являются отдельными атрибутами.

Сторона Python

Этот подход к интерфейсу состоит из того, что у объекта есть атрибут __array_interface__.

__array_interface__

Словарь элементов (3 обязательных и 5 необязательных). Необязательные ключи в словаре имеют подразумеваемые значения по умолчанию, если они не предоставлены.

Ключи:

shape (обязательно)

Кортеж, элементы которого представляют размер массива в каждой размерности. Каждый элемент — целое число (Python int или long). Обратите внимание, что эти целые числа могут быть больше, чем может содержать платформа “int” или “long” (Python int – это C long). Код, использующий этот атрибут, должен правильно обработать эту ситуацию; либо, подняв ошибку, когда переполнение возможно, либо используя Py_LONG_LONG в качестве типа C для размеров.

typestr (обязательно)

Строка, предоставляющая базовый тип однородного массива. Базовый формат строки состоит из 3 частей: символ, описывающий порядок байтов данных (<: little-endian, >: big-endian, |: нерелевантно), символ, задающий базовый тип массива, и целое число, представляющее количество байт, используемых типом.

Основные символы типов:

t	Поле бита (следующее целое число указывает количество битов в поле бита).
b	Булево (целочисленный тип, где все значения только True или False)
i	Целое число
u	Беззнаковое целое число
f	Число с плавающей точкой
c	Комплексное число с плавающей точкой
m	Timedelta
M	Datetime
O	Объект (т.е. память содержит указатель на PyObject)
S	Строка (последовательность символов фиксированной длины)
U	Unicode (последовательность Py_UNICODE фиксированной длины)
V	Другое (void * – каждый элемент — фиксированный блок памяти)

descr (необязательно)

Список кортежей, предоставляющий более подробное описание структуры памяти для каждого элемента в однородном массиве. Каждый кортеж в списке содержит два или три элемента. Обычно этот атрибут используется, когда typestr равен V[0-9]+, но это не обязательно. Единственное требование состоит в том, что количество байтов, представленных в ключе typestr, должно совпадать с общим количеством байтов, представленных здесь. Идея состоит в поддержке описаний структур C-подобных типов, составляющих элементы массива. Элементы каждого кортежа в списке:

1. Строка, содержащая имя, связанное с этой частью типа данных. Это также может быть кортеж из ('full name', 'basic_name') , где основное имя будет допустимым именем переменной Python, представляющим полное имя поля.
2. Базовое описание типа, как в typestr, или другой список (для вложенных структурных типов)
3. Необязательный кортеж shape, указывающий, сколько раз эта часть структуры должна повторяться. Повторения не предполагаются, если это не указано. Очень сложные структуры могут быть описаны с помощью этого обобщенного интерфейса. Однако обратите внимание, что каждый элемент массива по-прежнему имеет один и тот же тип данных.

Значение по умолчанию: [('', typestr)]

data (необязательно)

Двухэлементный кортеж, первый элемент которого — целое число (целое число long, если необходимо), указывающее на область данных, хранящую содержимое массива. Этот указатель должен указывать на первый элемент данных (иными словами, любые смещения в данном случае игнорируются). Второй элемент кортежа — флаг только для чтения (true означает, что область данных только для чтения).

Этот атрибут также может быть объектом, реализующим buffer interface, который будет использоваться для совместного использования данных. Если этот ключ отсутствует (или возвращает None), совместное использование памяти будет выполняться через интерфейс буфера самого объекта. В этом случае ключ offset может использоваться для указания начала буфера. Ссылка на объект, реализующий интерфейс массива, должна храниться новым объектом, если область памяти должна быть защищена.

Значение по умолчанию: None

strides (необязательно)

Либо None для указания массива, непрерывного в стиле C, или кортеж strides, который предоставляет количество байтов, необходимых для перехода к следующему элементу массива в соответствующей размерности. Каждый элемент должен быть целым числом (Python int или long). Как и в случае с shape, значения могут быть больше, чем может быть представлено C “int” или “long”; вызывающий код должен правильно обработать это, либо вызвав ошибку, либо используя Py_LONG_LONG в C. По умолчанию None , что подразумевает буфер памяти, непрерывный в стиле C. В этой модели последняя размерность массива меняется быстрее всего. Например, кортеж strides по умолчанию для объекта, чьи элементы массива имеют длину 8 байт, а shape равен (10,20,30), будет (4800, 240, 8).

Значение по умолчанию: None (непрерывный в стиле C)

mask (необязательно)

None или объект, реализующий интерфейс массива. Все элементы массива маски должны интерпретироваться только как true или не true, указывая, какие элементы этого массива действительны. Форма этого объекта должна быть “broadcastable” форме исходного массива.

Значение по умолчанию: None (все значения массива действительны)

offset (необязательно)

Целочисленное смещение в области данных массива. Это может быть использовано только в том случае, если данные None или возвращают объект buffer.

Значение по умолчанию: 0.

version (обязательно)

Целое число, показывающее версию интерфейса (т.е. 3 для этой версии). Будьте осторожны, не используйте это для отмены действия объектов, реализующих будущие версии интерфейса.

Доступ к структурам C

Этот подход к интерфейсу массива обеспечивает более быстрый доступ к массиву, используя только один вызов атрибута и хорошо определенную структуру C.

__array_struct__

Тип :c:type: PyCObject , чьё поле voidptr содержит указатель на заполненную структуру PyArrayInterface. Память для структуры создается динамически, и PyCObject также создается со соответствующим деструктором, поэтому получатель этого атрибута просто должен применить 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_intptr_t *shape;   /* A length-nd array of shape information */
  Py_intptr_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 битов, показывающих, как следует интерпретировать данные, и одного бита, показывающего, как следует интерпретировать интерфейс. Битами данных являются CONTIGUOUS (0x1), FORTRAN (0x2), ALIGNED (0x100), NOTSWAPPED (0x200) и WRITEABLE (0x400). Конечный флаг ARR_HAS_DESCR (0x800) указывает, содержит ли эта структура поле arrdescr.

Примеры описания типа

Для ясности полезно привести несколько примеров описания типа и соответствующих записей ‘descr’ для __array_interface__. Спасибо Скотту Гильберту за эти примеры:

В каждом случае ключ ‘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. Член desc объекта PyCObject, возвращаемого из __array_struct__, не был указан. Обычно это был объект, экспонирующий массив (чтобы можно было сохранить ссылку на него и уничтожить её при уничтожении объекта C). Теперь это должен быть кортеж, первым элементом которого является строка “PyArrayInterface Версия #”, а вторым — объект, экспонирующий массив.
3. Кортеж, возвращаемый из __array_interface__[‘data’], раньше был шестнадцатеричной строкой (теперь это целое или длинное целое число).
4. Атрибута __array_interface__ не было; вместо этого все ключи (кроме версии) в словаре __array_interface__ были собственными атрибутами: таким образом, чтобы получить информацию со стороны Python, вам нужно было отдельно получить доступ к атрибутам:
   • __array_data__
   • __array_shape__
   • __array_strides__
   • __array_typestr__
   • __array_descr__
   • __array_offset__
   • __array_mask__