Слоты определения¶Definition slots

Чтобы определить объекты модулей и классы с помощью C API, можно использовать массив слотов – по сути, пары «ключ-значение», описывающие характеристики создаваемого объекта. Это разделяет данные и структуры, используемые во время выполнения, что позволяет CPython – и другим реализациям C API Python – обновлять структуры без нарушения обратной совместимости.

В этом разделе описаны слоты в общем. Сведения о поведении конкретных объектов и значениях слотов см. в документации функций, которые применяют слоты:

• PyType_FromSlots() для типов;

• PyModule_FromSlotsAndSpec() и хук экспорта расширения для модулей.

Когда слоты передаются функции, которая их применяет, функция не изменяет массив слотов и любые данные, на которые он указывает (рекурсивно). После завершения функции вызывающий код может изменять или освобождать массив и любые данные, на которые он указывает (рекурсивно), за исключением данных, явно помеченных PySlot_STATIC.

Если не указано иное, в одном массиве слотов не должно быть нескольких слотов с одинаковым ID (sl_id).

Записи массива слотов используют следующую структуру:

type PySlot¶

Часть Stable ABI (включая все члены) начиная с версии 3.15.

Запись в массиве слотов. Определяется как:

typedef struct {
    uint16_t sl_id;
    uint16_t sl_flags;
    uint32_t _reserved;  // должно быть 0
    union {
        void *sl_ptr;
        void (*sl_func)(void);
        Py_ssize_t sl_size;
        int64_t sl_int64;
        uint64_t sl_uint64;
    };
} PySlot;

uint16_t sl_id¶

Идентификатор слота, выбираемый из:

• Py_slot_* значения, описанные в Общих идентификаторах слотов ниже;

• Py_mod_* значения для модулей, как описано в Определении модулей;

• Значения для типов, как описано в Идентификаторах слотов типов.

sl_id, равный нулю (Py_slot_end), отмечает конец массива слотов.

void *sl_ptr¶

void (*sl_func)(void)¶

Py_ssize_t sl_size¶

int64_t sl_int64¶

uint64_t sl_uint64¶

Данные для слота. Эти поля являются частью анонимного объединения; используемое поле зависит от типа данных, требуемого идентификатором слота: указатель на данные, указатель на функцию, размер, знаковое или беззнаковое целое число соответственно.

Если для конкретного идентификатора слота не указано иное, указатели (т.е. sl_ptr и sl_func) не могут быть NULL.

uint16_t sl_flags¶

Ноль или более следующих флагов, объединённых операцией ИЛИ:

PySlot_STATIC¶

Часть Stable ABI начиная с версии 3.15.

Все данные, на которые указывает слот, статически размещены и константны. Таким образом, интерпретатору не нужно копировать эту информацию.

Этот флаг подразумевается для указателей на функции.

Флаг применяется даже к данным, на которые слот указывает «косвенно», за исключением слотов, вложенных через Py_slot_subslots, которые могут иметь собственные флаги PySlot_STATIC. Например, если применить его к слоту Py_tp_members, который указывает на массив структур PyMemberDef, то весь массив, а также строки имени и документации в его элементах должны быть статическими и константными.

PySlot_INTPTR¶

Часть Stable ABI начиная с версии 3.15.

Данные хранятся в sl_ptr; CPython приведёт их к соответствующему типу.

Этот флаг может упростить перенос из старых структур PyType_Slot и PyModuleDef_Slot.

PySlot_OPTIONAL¶

Часть Stable ABI начиная с версии 3.15.

Если идентификатор слота неизвестен, интерпретатор должен игнорировать слот, а не завершаться с ошибкой.

Например, если Python 3.16 добавляет новую возможность с новым идентификатором слота,attr соответствующий слот может быть помечен PySlot_OPTIONAL, чтобы Python 3.15 игнорировал его.

Обратите внимание: «опциональность» применяется только к неизвестным идентификаторам слотов. Этот флаг не заставляет Python пропускать недопустимые значения известных слотов.

Добавлено в версии 3.15.