Определение типов расширений: Разнообразные темы

3.1. Закрытие и освобождение памяти

destructor tp_dealloc;

Эта функция вызывается, когда счетчик ссылок экземпляра вашего типа уменьшается до нуля, и интерпретатор Python хочет освободить его. Если ваш тип должен освободить память или выполнить другие действия по очистке, вы можете поместить их сюда. Здесь также необходимо освободить сам объект. Вот пример этой функции:

static void
newdatatype_dealloc(newdatatypeobject *obj)
{
    free(obj->obj_UnderlyingDatatypePtr);
    Py_TYPE(obj)->tp_free(obj);
}

Важное требование к функции освобождения – она должна оставлять любые ожидающие исключения в покое. Это важно, поскольку функции освобождения часто вызываются при разворачивании стека Python; когда стек разворачивается из-за исключения (а не из-за обычных возвратов), ничего не делается для защиты функций освобождения от обнаружения, что исключение уже установлено. Любые действия, которые функция освобождения выполняет и которые могут вызвать выполнение дополнительного кода Python, могут обнаружить, что исключение установлено. Это может привести к вводящим в заблуждение ошибкам интерпретатора. Правильный способ защиты от этого – сохранить ожидающее исключение перед выполнением небезопасного действия и восстановить его после завершения. Это можно сделать с помощью функций PyErr_Fetch() и PyErr_Restore():

static void
my_dealloc(PyObject *obj)
{
    MyObject *self = (MyObject *) obj;
    PyObject *cbresult;

    if (self->my_callback != NULL) {
        PyObject *err_type, *err_value, *err_traceback;

        /* This saves the current exception state */
        PyErr_Fetch(&err_type, &err_value, &err_traceback);

        cbresult = PyObject_CallObject(self->my_callback, NULL);
        if (cbresult == NULL)
            PyErr_WriteUnraisable(self->my_callback);
        else
            Py_DECREF(cbresult);

        /* This restores the saved exception state */
        PyErr_Restore(err_type, err_value, err_traceback);

        Py_DECREF(self->my_callback);
    }
    Py_TYPE(obj)->tp_free((PyObject*)self);
}

3.2. Представление объекта

В Python есть два способа сгенерировать текстовое представление объекта: функция repr() и функция str(). (Функция print() просто вызывает str().) Эти обработчики являются необязательными.

reprfunc tp_repr;
reprfunc tp_str;

Обработчик tp_repr должен вернуть строковый объект, содержащий представление экземпляра, для которого он был вызван. Вот простой пример:

static PyObject *
newdatatype_repr(newdatatypeobject * obj)
{
    return PyUnicode_FromFormat("Repr-ified_newdatatype{{size:%d}}",
                                obj->obj_UnderlyingDatatypePtr->size);
}

Если обработчик tp_repr не указан, интерпретатор предоставит представление, использующее tp_name типа и уникальное идентифицирующее значение для объекта.

Обработчик tp_str относится к str() так же, как обработчик tp_repr, описанный выше, относится к repr(); то есть он вызывается, когда код Python вызывает str() для экземпляра вашего объекта. Его реализация очень похожа на функцию tp_repr, но результирующая строка предназначена для восприятия человеком. Если tp_str не указан, вместо него используется обработчик tp_repr.

Вот простой пример:

static PyObject *
newdatatype_str(newdatatypeobject * obj)
{
    return PyUnicode_FromFormat("Stringified_newdatatype{{size:%d}}",
                                obj->obj_UnderlyingDatatypePtr->size);
}

3.3. Управление атрибутами

Для каждого объекта, который может поддерживать атрибуты, соответствующий тип должен предоставлять функции, контролирующие, как разрешаются атрибуты. Должна быть функция, которая может извлекать атрибуты (если они определены), и другая для установки атрибутов (если установка атрибутов разрешена). Удаление атрибута — это особый случай, для которого новое значение, переданное обработчику, равно NULL.

Python поддерживает две пары обработчиков атрибутов; тип, который поддерживает только атрибуты, должен реализовать функции только для одной пары. Разница в том, что одна пара принимает имя атрибута в качестве char*, а другая принимает PyObject*. Каждый тип может использовать ту пару, которая более удобна для реализации.

getattrfunc  tp_getattr;        /* char * version */
setattrfunc  tp_setattr;
/* ... */
getattrofunc tp_getattro;       /* PyObject * version */
setattrofunc tp_setattro;

Если доступ к атрибутам объекта всегда является простым операцией (это будет объяснено вскоре), существуют общие реализации, которые могут быть использованы для предоставления PyObject* версии функций управления атрибутами. Фактическая необходимость типов-специфических обработчиков атрибутов почти полностью исчезла, начиная с Python 2.2, хотя есть много примеров, которые не были обновлены для использования некоторых новых общих механизмов, которые доступны.

struct PyMethodDef *tp_methods;
struct PyMemberDef *tp_members;
struct PyGetSetDef *tp_getset;

typedef struct PyMethodDef {
    const char  *ml_name;       /* method name */
    PyCFunction  ml_meth;       /* implementation function */
    int          ml_flags;      /* flags */
    const char  *ml_doc;        /* docstring */
} PyMethodDef;

typedef struct PyMemberDef {
    const char *name;
    int         type;
    int         offset;
    int         flags;
    const char *doc;
} PyMemberDef;

static PyObject *
newdatatype_getattr(newdatatypeobject *obj, char *name)
{
    if (strcmp(name, "data") == 0)
    {
        return PyLong_FromLong(obj->data);
    }

    PyErr_Format(PyExc_AttributeError,
                 "'%.50s' object has no attribute '%.400s'",
                 tp->tp_name, name);
    return NULL;
}

static int
newdatatype_setattr(newdatatypeobject *obj, char *name, PyObject *v)
{
    PyErr_Format(PyExc_RuntimeError, "Read-only attribute: %s", name);
    return -1;
}

3.4. Сравнение объектов

richcmpfunc tp_richcompare;

Обработчик tp_richcompare вызывается при необходимости сравнения. Он аналогичен методам богатых сравнений, таким как __lt__(), и также вызывается PyObject_RichCompare() и PyObject_RichCompareBool().

Эта функция вызывается с двумя объектами Python и оператором в качестве аргументов, где оператор является одним из Py_EQ, Py_NE, Py_LE, Py_GT, Py_LT или Py_GT. Он должен сравнить два объекта относительно указанного оператора и вернуть Py_True или Py_False при успешном сравнении, Py_NotImplemented для указания того, что сравнение не реализовано, и следует попробовать метод сравнения другого объекта, или NULL в случае возникновения исключения.

Вот пример реализации для типа данных, который считается равным, если размер внутреннего указателя равен:

static PyObject *
newdatatype_richcmp(PyObject *obj1, PyObject *obj2, int op)
{
    PyObject *result;
    int c, size1, size2;

    /* code to make sure that both arguments are of type
       newdatatype omitted */

    size1 = obj1->obj_UnderlyingDatatypePtr->size;
    size2 = obj2->obj_UnderlyingDatatypePtr->size;

    switch (op) {
    case Py_LT: c = size1 <  size2; break;
    case Py_LE: c = size1 <= size2; break;
    case Py_EQ: c = size1 == size2; break;
    case Py_NE: c = size1 != size2; break;
    case Py_GT: c = size1 >  size2; break;
    case Py_GE: c = size1 >= size2; break;
    }
    result = c ? Py_True : Py_False;
    Py_INCREF(result);
    return result;
 }

3.5. Поддержка абстрактных протоколов

Python поддерживает различные абстрактные протоколы; конкретные интерфейсы для использования этих интерфейсов документированы в Слой абстрактных объектов.

Ряд этих абстрактных интерфейсов был определен на ранних этапах разработки реализации Python. В частности, протоколы чисел, словарей и последовательностей являются частью Python с самого начала. Со временем были добавлены и другие протоколы. Для протоколов, которые зависят от нескольких обработчиков из реализации типа, более старые протоколы были определены как необязательные блоки обработчиков, ссылающихся на объект типа. Для новых протоколов в основном объекте типа присутствуют дополнительные слоты, а бит флага установлен, чтобы указать, что слоты присутствуют и должны проверяться интерпретатором. (Бит флага не указывает, что значения слотов не являются NULL. Флаг может быть установлен для указания наличия слота, но слот может остаться незаполненным.)

PyNumberMethods   *tp_as_number;
PySequenceMethods *tp_as_sequence;
PyMappingMethods  *tp_as_mapping;

Если вы хотите, чтобы ваш объект мог действовать как объект типа число, последовательность или словарь, поместите адрес структуры, которая реализует C-типы PyNumberMethods, PySequenceMethods или PyMappingMethods соответственно. Вам нужно заполнить эту структуру соответствующими значениями. Примеры использования каждого из них можно найти в каталоге Objects дистрибутива исходного кода Python.

hashfunc tp_hash;

Эта функция, если вы её предоставите, должна возвращать число хэша для экземпляра вашего типа данных. Вот простой пример:

static Py_hash_t
newdatatype_hash(newdatatypeobject *obj)
{
    Py_hash_t result;
    result = obj->some_size + 32767 * obj->some_number;
    if (result == -1)
       result = -2;
    return result;
}

Py_hash_t — это целое число со знаком с платформенно зависимой шириной. Возвращение -1 из tp_hash указывает на ошибку, поэтому следует быть внимательным, чтобы не возвращать её при успешном вычислении хэша, как показано выше.

ternaryfunc tp_call;

Эта функция вызывается, когда экземпляр вашего типа данных «вызывается», например, если obj1 является экземпляром вашего типа данных, а скрипт Python содержит obj1('hello'), вызывается обработчик tp_call.

Эта функция принимает три аргумента:

1. self — экземпляр типа данных, который является объектом вызова. Если вызов — obj1('hello'), то self — obj1.
2. args — кортеж, содержащий аргументы вызова. Вы можете использовать PyArg_ParseTuple() для извлечения аргументов.
3. kwds — словарь ключевых аргументов, которые были переданы. Если он не NULL и вы поддерживаете ключевые аргументы, используйте PyArg_ParseTupleAndKeywords() для извлечения аргументов. Если вы не хотите поддерживать ключевые аргументы и он не NULL, генерируйте исключение TypeError с сообщением о том, что ключевые аргументы не поддерживаются.

Вот пример реализации tp_call:

static PyObject *
newdatatype_call(newdatatypeobject *self, PyObject *args, PyObject *kwds)
{
    PyObject *result;
    const char *arg1;
    const char *arg2;
    const char *arg3;

    if (!PyArg_ParseTuple(args, "sss:call", &arg1, &arg2, &arg3)) {
        return NULL;
    }
    result = PyUnicode_FromFormat(
        "Returning -- value: [%d] arg1: [%s] arg2: [%s] arg3: [%s]\n",
        obj->obj_UnderlyingDatatypePtr->size,
        arg1, arg2, arg3);
    return result;
}

/* Iterators */
getiterfunc tp_iter;
iternextfunc tp_iternext;

Эти функции обеспечивают поддержку протокола итератора. Оба обработчика принимают ровно один параметр — экземпляр, для которого они вызываются, и возвращают новую ссылку. В случае ошибки они должны установить исключение и вернуть NULL. tp_iter соответствует методу Python __iter__(), а tp_iternext соответствует методу Python __next__().

Любой итерируемый объект должен реализовывать обработчик tp_iter, который должен вернуть объект итератора. Здесь применяются те же рекомендации, что и для классов Python:

• Для коллекций (таких как списки и кортежи), которые могут поддерживать несколько независимых итераторов, новый итератор должен создаваться и возвращаться при каждом вызове tp_iter.
• Объекты, которые можно итерировать только один раз (обычно из-за побочных эффектов итерации, таких как объекты файлов), могут реализовывать tp_iter, возвращая новую ссылку на себя — и, следовательно, должны также реализовать обработчик tp_iternext.

Любой объект итератора должен реализовывать как tp_iter, так и tp_iternext. Обработчик итератора tp_iter должен вернуть новую ссылку на итератор. Его обработчик tp_iternext должен вернуть новую ссылку на следующий объект в итерации, если он есть. Если итерация достигла конца, tp_iternext может вернуть NULL без установки исключения или может установить StopIteration в дополнение к возвращению NULL; избежание исключения может незначительно улучшить производительность. Если возникает фактическая ошибка, tp_iternext всегда должен установить исключение и вернуть NULL.

3.6. Поддержка слабых ссылок

Одна из целей реализации слабых ссылок в Python — позволить любому типу участвовать в механизме слабых ссылок без наложения накладных расходов на критически важные для производительности объекты (такие как числа).

Для того, чтобы объект был доступен для слабой ссылки, тип расширения должен выполнить два действия:

1. Включить поле PyObject* в структуру C-объекта, предназначенное для механизма слабых ссылок. Конструктор объекта должен оставить его NULL (что происходит автоматически при использовании по умолчанию tp_alloc).
2. Установить член tp_weaklistoffset типа в смещение указанного поля в структуре C-объекта, чтобы интерпретатор знал, как получить доступ к этому полю и изменить его.

Конкретно, вот как тривиальная структура объекта дополняется необходимым полем:

typedef struct {
    PyObject_HEAD
    PyObject *weakreflist;  /* List of weak references */
} TrivialObject;

И соответствующий член в статически объявленном объекте типа:

static PyTypeObject TrivialType = {
    PyVarObject_HEAD_INIT(NULL, 0)
    /* ... other members omitted for brevity ... */
    .tp_weaklistoffset = offsetof(TrivialObject, weakreflist),
};

Единственное дополнительное требование — tp_dealloc должен очистить все слабые ссылки (вызвав PyObject_ClearWeakRefs()), если поле не NULL:

static void
Trivial_dealloc(TrivialObject *self)
{
    /* Clear weakrefs first before calling any destructors */
    if (self->weakreflist != NULL)
        PyObject_ClearWeakRefs((PyObject *) self);
    /* ... remainder of destruction code omitted for brevity ... */
    Py_TYPE(self)->tp_free((PyObject *) self);
}

3.7. Дополнительные рекомендации

Чтобы узнать, как реализовать какой-либо конкретный метод для вашего нового типа данных, просмотрите исходный код CPython. Перейдите в каталог Objects, затем найдите в файлах исходного кода C строку tp_ плюс нужную функцию (например, tp_richcompare). Там вы найдёте примеры реализации нужной функции.

Чтобы проверить, является ли объект конкретным экземпляром реализуемого типа, используйте функцию PyObject_TypeCheck(). Пример её использования:

if (!PyObject_TypeCheck(some_object, &MyType)) {
    PyErr_SetString(PyExc_TypeError, "arg #1 not a mything");
    return NULL;
}