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

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

destructor tp_dealloc;

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

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

Если ваш тип поддерживает сборку мусора, деструктор должен вызвать PyObject_GC_UnTrack() перед очисткой любых членов поля:

static void
newdatatype_dealloc(newdatatypeobject *obj)
{
    PyObject_GC_UnTrack(obj);
    Py_CLEAR(obj->other_obj);
    ...
    Py_TYPE(obj)->tp_free((PyObject *)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_CallNoArgs(self->my_callback);
        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_GE, 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;
}