3. 定义扩展类型：杂项主题¶
本节旨在快速概述您可以实现的各种类型方法及其功能。
以下是 PyTypeObject 的定义，其中省略了一些仅在 调试版本 中使用的字段
typedef struct _typeobject {
PyObject_VAR_HEAD
const char *tp_name; /* For printing, in format "<module>.<name>" */
Py_ssize_t tp_basicsize, tp_itemsize; /* For allocation */
/* Methods to implement standard operations */
destructor tp_dealloc;
Py_ssize_t tp_vectorcall_offset;
getattrfunc tp_getattr;
setattrfunc tp_setattr;
PyAsyncMethods *tp_as_async; /* formerly known as tp_compare (Python 2)
or tp_reserved (Python 3) */
reprfunc tp_repr;
/* Method suites for standard classes */
PyNumberMethods *tp_as_number;
PySequenceMethods *tp_as_sequence;
PyMappingMethods *tp_as_mapping;
/* More standard operations (here for binary compatibility) */
hashfunc tp_hash;
ternaryfunc tp_call;
reprfunc tp_str;
getattrofunc tp_getattro;
setattrofunc tp_setattro;
/* Functions to access object as input/output buffer */
PyBufferProcs *tp_as_buffer;
/* Flags to define presence of optional/expanded features */
unsigned long tp_flags;
const char *tp_doc; /* Documentation string */
/* Assigned meaning in release 2.0 */
/* call function for all accessible objects */
traverseproc tp_traverse;
/* delete references to contained objects */
inquiry tp_clear;
/* Assigned meaning in release 2.1 */
/* rich comparisons */
richcmpfunc tp_richcompare;
/* weak reference enabler */
Py_ssize_t tp_weaklistoffset;
/* Iterators */
getiterfunc tp_iter;
iternextfunc tp_iternext;
/* Attribute descriptor and subclassing stuff */
struct PyMethodDef *tp_methods;
struct PyMemberDef *tp_members;
struct PyGetSetDef *tp_getset;
// Strong reference on a heap type, borrowed reference on a static type
struct _typeobject *tp_base;
PyObject *tp_dict;
descrgetfunc tp_descr_get;
descrsetfunc tp_descr_set;
Py_ssize_t tp_dictoffset;
initproc tp_init;
allocfunc tp_alloc;
newfunc tp_new;
freefunc tp_free; /* Low-level free-memory routine */
inquiry tp_is_gc; /* For PyObject_IS_GC */
PyObject *tp_bases;
PyObject *tp_mro; /* method resolution order */
PyObject *tp_cache;
PyObject *tp_subclasses;
PyObject *tp_weaklist;
destructor tp_del;
/* Type attribute cache version tag. Added in version 2.6 */
unsigned int tp_version_tag;
destructor tp_finalize;
vectorcallfunc tp_vectorcall;
/* bitset of which type-watchers care about this type */
unsigned char tp_watched;
} PyTypeObject;
现在有很多方法。不过不用太担心——如果您要定义一个类型，您很可能只需要实现其中的一小部分。
正如您可能已经预料到的，我们将对此进行详细介绍，并提供有关各种处理程序的更多信息。我们不会按照它们在结构中定义的顺序进行介绍，因为有很多历史遗留问题影响了字段的排序。通常，找到包含您需要的字段的示例，然后更改值以适合您的新类型是最容易的。
const char *tp_name; /* For printing */
类型的名称——正如上一章中提到的，这将出现在各种地方，几乎完全用于诊断目的。尝试选择在这种情况中有帮助的名称！
Py_ssize_t tp_basicsize, tp_itemsize; /* For allocation */
这些字段告诉运行时在创建此类型的新对象时分配多少内存。Python 对可变长度结构（例如：字符串、元组）有一些内置支持，这就是 tp_itemsize 字段的作用。这将在后面讨论。
const char *tp_doc;
您可以在此处放置一个字符串（或其地址），当 Python 脚本引用 obj.__doc__ 来检索文档字符串时，它将返回该字符串。
现在我们来谈谈基本类型方法——大多数扩展类型将实现这些方法。
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);
}
注意
在析构函数中，您能安全执行的操作存在限制。首先，如果您的类型支持垃圾回收（使用 tp_traverse 和/或 tp_clear），当调用 tp_dealloc 时，对象的一些成员可能已经被清除或最终化。其次，在 tp_dealloc 中，您的对象处于不稳定状态：它的引用计数为零。任何对非平凡对象或 API 的调用（如上面的示例）都可能最终再次调用 tp_dealloc，导致双重释放并崩溃。
从 Python 3.4 开始，建议不要在 tp_dealloc 中放置任何复杂的最终化代码，而是使用新的 tp_finalize 类型方法。
另请参阅
PEP 442 解释了新的最终化方案。
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 开始，对类型特定属性处理程序的实际需求几乎完全消失了，尽管还有许多示例尚未更新为使用一些可用的新通用机制。
3.3.1. 通用属性管理¶
大多数扩展类型只使用简单属性。那么，是什么让属性变得简单呢？只有几个条件必须满足
当调用
PyType_Ready()时，必须知道属性的名称。不需要进行任何特殊处理来记录已查找或设置的属性，也不需要根据值采取任何操作。
请注意，此列表未对属性的值、计算值的时间或相关数据的存储方式施加任何限制。
当调用 PyType_Ready() 时，它会使用类型对象引用的三个表来创建 描述符，这些描述符会被放置在类型对象的字典中。每个描述符控制对实例对象的一个属性的访问。每个表都是可选的；如果所有三个表都是 NULL，则该类型的实例将只具有从其基类型继承的属性，并且应该将 tp_getattro 和 tp_setattro 字段也设置为 NULL，允许基类型处理属性。
这些表被声明为类型对象的三个字段
struct PyMethodDef *tp_methods;
struct PyMemberDef *tp_members;
struct PyGetSetDef *tp_getset;
如果 tp_methods 不为 NULL，则它必须引用一个 PyMethodDef 结构数组。表中的每个条目都是此结构的一个实例
typedef struct PyMethodDef {
const char *ml_name; /* method name */
PyCFunction ml_meth; /* implementation function */
int ml_flags; /* flags */
const char *ml_doc; /* docstring */
} PyMethodDef;
应该为类型提供的每个方法定义一个条目；对于从基类型继承的方法，不需要条目。在最后需要一个额外的条目；它是一个哨兵，标记数组的结束。哨兵的 ml_name 字段必须为 NULL。
第二个表用于定义直接映射到实例中存储的数据的属性。支持各种原始 C 类型，并且访问可以是只读或读写。表中的结构定义为
typedef struct PyMemberDef {
const char *name;
int type;
int offset;
int flags;
const char *doc;
} PyMemberDef;
对于表中的每个条目，将构建一个 描述符 并添加到类型中，该类型将能够从实例结构中提取值。 type 字段应该包含一个类型代码，例如 Py_T_INT 或 Py_T_DOUBLE；该值将用于确定如何将 Python 值转换为 C 值和从 C 值转换为 Python 值。 flags 字段用于存储控制如何访问属性的标志：可以将其设置为 Py_READONLY 以阻止 Python 代码设置它。
使用 tp_members 表构建在运行时使用的描述符的一个有趣的优势是，以这种方式定义的任何属性都可以通过在表中提供文本来拥有一个关联的文档字符串。应用程序可以使用内省 API 从类对象中检索描述符，并使用其 __doc__ 属性获取文档字符串。
与 tp_methods 表类似，需要一个带有 ml_name 值为 NULL 的哨兵条目。
3.3.2. 类型特定的属性管理¶
为了简单起见，这里只演示 char* 版本；名称参数的类型是 char* 和 PyObject* 接口版本之间的唯一区别。这个例子实际上与上面的通用例子做同样的事情，但没有使用 Python 2.2 中添加的通用支持。它解释了处理函数是如何被调用的，所以如果你需要扩展它们的功能，你就会明白需要做什么。
当对象需要属性查找时，会调用 tp_getattr 处理程序。它在与调用类的 __getattr__() 方法相同的场景中被调用。
这里有一个例子
static PyObject *
newdatatype_getattr(newdatatypeobject *obj, char *name)
{
if (strcmp(name, "data") == 0)
{
return PyLong_FromLong(obj->data);
}
PyErr_Format(PyExc_AttributeError,
"'%.100s' object has no attribute '%.400s'",
Py_TYPE(obj)->tp_name, name);
return NULL;
}
当类的实例的 __setattr__() 或 __delattr__() 方法被调用时，会调用 tp_setattr 处理程序。当属性应该被删除时，第三个参数将是 NULL。这里有一个例子，它只是抛出一个异常；如果这真的是你想要的，tp_setattr 处理程序应该被设置为 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(newdatatypeobject *obj1, newdatatypeobject *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 的结构的地址分别放入其中。填充此结构的适当值由您决定。您可以在 Python 源代码分发的 Objects 目录中找到每个结构的使用示例。
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 是一种带符号整数类型，具有平台相关的宽度。从 tp_hash 返回 -1 表示错误，这就是为什么您应该注意在哈希计算成功时避免返回它，如上所示。
ternaryfunc tp_call;
当您数据类型的实例被“调用”时，会调用此函数，例如，如果 obj1 是您数据类型的实例，并且 Python 脚本包含 obj1('hello')，则会调用 tp_call 处理程序。
此函数接受三个参数
self 是调用主题的数据类型实例。如果调用是
obj1('hello')，则 self 是obj1。args 是一个元组，包含调用参数。您可以使用
PyArg_ParseTuple()来提取参数。kwds 是传递的关键字参数字典。如果它是非
NULL并且您支持关键字参数，请使用PyArg_ParseTupleAndKeywords()来提取参数。如果您不想支持关键字参数并且它是非NULL，请使用一条消息引发TypeError，说明不支持关键字参数。
以下是一个玩具 tp_call 实现
static PyObject *
newdatatype_call(newdatatypeobject *obj, 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 的弱引用实现的目标之一是允许任何类型参与弱引用机制，而不会对性能关键对象（如数字）造成开销。
另请参阅
有关 weakref 模块的文档。
为了使对象可弱引用，扩展类型必须设置 Py_TPFLAGS_MANAGED_WEAKREF 位 tp_flags 字段。应将旧的 tp_weaklistoffset 字段保留为零。
具体来说，以下是静态声明的类型对象的样子
static PyTypeObject TrivialType = {
PyVarObject_HEAD_INIT(NULL, 0)
/* ... other members omitted for brevity ... */
.tp_flags = Py_TPFLAGS_MANAGED_WEAKREF | ...,
};
唯一需要添加的是 tp_dealloc 需要清除所有弱引用（通过调用 PyObject_ClearWeakRefs()）
static void
Trivial_dealloc(TrivialObject *self)
{
/* Clear weakrefs first before calling any destructors */
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;
}
另请参阅
- 下载 CPython 源代码发布版。
- GitHub 上的 CPython 项目，CPython 源代码在此开发。