类型对象

type PyTypeObject
属于 受限 API (作为不透明的结构体).

对象的 C 结构用于描述 built-in 类型。

PyTypeObject PyType_Type
属于 稳定 ABI.

这是属于 type 对象的 type object,它在 Python 层面和 type 是相同的对象。

int PyType_Check(PyObject *o)

如果对象 o 是一个类型对象,包括派生自标准类型对象的类型实例则返回非零值。 在所有其它情况下都返回 0。 此函数将总是成功执行。

int PyType_CheckExact(PyObject *o)

如果对象 o 是一个类型对象,但不是标准类型对象的子类型则返回非零值。 在所有其它情况下都返回 0。 此函数将总是成功执行。

unsigned int PyType_ClearCache()
属于 稳定 ABI.

清空内部查找缓存。 返回当前版本标签。

unsigned long PyType_GetFlags(PyTypeObject *type)
属于 稳定 ABI.

返回 typetp_flags 成员。 此函数主要是配合 Py_LIMITED_API 使用;单独的旗标位会确保在各个 Python 发布版之间保持稳定,但对 tp_flags 本身的访问并不是 受限 API 的一部分。

在 3.2 版新加入.

在 3.4 版的變更: 返回类型现在是 unsigned long 而不是 long

void PyType_Modified(PyTypeObject *type)
属于 稳定 ABI.

使该类型及其所有子类型的内部查找缓存失效。 此函数必须在对该类型的属性或基类进行任何手动修改之后调用。

int PyType_HasFeature(PyTypeObject *o, int feature)

如果类型对象 o 设置了特性 feature 则返回非零值。 类型特性是用单个比特位旗标来表示的。

int PyType_IS_GC(PyTypeObject *o)

如果类型对象包括了对循环检测器的支持则返回真值;这将测试类型旗标 Py_TPFLAGS_HAVE_GC

int PyType_IsSubtype(PyTypeObject *a, PyTypeObject *b)
属于 稳定 ABI.

如果 ab 的子类型则返回真值。

此函数只检查实际的子类型,这意味着 __subclasscheck__() 不会在 b 上被调用。 请调用 PyObject_IsSubclass() 来执行与 issubclass() 所做的相同检查。

PyObject *PyType_GenericAlloc(PyTypeObject *type, Py_ssize_t nitems)
回傳值:新的參照。 属于 稳定 ABI.

类型对象的 tp_alloc 槽位的通用处理句柄。 请使用 Python 的默认内存分配机制来分配一个新的实例并将其所有内容初始化为 NULL

PyObject *PyType_GenericNew(PyTypeObject *type, PyObject *args, PyObject *kwds)
回傳值:新的參照。 属于 稳定 ABI.

类型对象的 tp_new 槽位的通用处理句柄。 请使用类型的 tp_alloc 槽位来创建一个新的实例。

int PyType_Ready(PyTypeObject *type)
属于 稳定 ABI.

最终化一个类型对象。 这应当在所有类型对象上调用以完成它们的初始化。 此函数会负责从一个类型的基类添加被继承的槽位。 成功时返回 0,或是在出错时返回 -1 并设置一个异常。

備註

如果某些基类实现了 GC 协议并且所提供的类型的旗标中未包括 Py_TPFLAGS_HAVE_GC,则将自动从其父类实现 GC 协议。 相反地,如果被创建的类型的旗标中确实包含 Py_TPFLAGS_HAVE_GC 则它 必须 自己实现 GC 协议,至少要实现 tp_traverse 句柄。

PyObject *PyType_GetName(PyTypeObject *type)
回傳值:新的參照。 属于 稳定 ABI 自 3.11 版开始.

返回类型名称。 等同于获取类型的 __name__ 属性。

在 3.11 版新加入.

PyObject *PyType_GetQualName(PyTypeObject *type)
回傳值:新的參照。 属于 稳定 ABI 自 3.11 版开始.

返回类型的限定名称。 等同于获取类型的 __qualname__ 属性。

在 3.11 版新加入.

void *PyType_GetSlot(PyTypeObject *type, int slot)
属于 稳定 ABI 自 3.4 版开始.

返回存储在给定槽位中的函数指针。 如果结果为 NULL,则表示或者该槽位为 NULL,或者该函数调用传入了无效的形参。 调用方通常要将结果指针转换到适当的函数类型。

请参阅 PyType_Slot.slot 查看可用的 slot 参数值。

在 3.4 版新加入.

在 3.10 版的變更: PyType_GetSlot() 现在可以接受所有类型。 在此之前,它被限制为 堆类型

PyObject *PyType_GetModule(PyTypeObject *type)
属于 稳定 ABI 自 3.10 版开始.

返回当使用 PyType_FromModuleAndSpec() 创建类型时关联到给定类型的模块对象。

如果没有关联到给定类型的模块,则设置 TypeError 并返回 NULL

此函数通常被用于获取方法定义所在的模块。 请注意在这样的方法中,PyType_GetModule(Py_TYPE(self)) 可能不会返回预期的结果。 Py_TYPE(self) 可以是目标类的一个 子类,而子类并不一定是在与其超类相同的模块中定义的。 请参阅 PyCMethod 了解如何获取方法定义所在的类。 请参阅 PyType_GetModuleByDef() 了解有关无法使用 PyCMethod 的情况。

在 3.9 版新加入.

void *PyType_GetModuleState(PyTypeObject *type)
属于 稳定 ABI 自 3.10 版开始.

返回关联到给定类型的模块对象的状态。 这是一个在 PyType_GetModule() 的结果上调用 PyModule_GetState() 的快捷方式。

如果没有关联到给定类型的模块,则设置 TypeError 并返回 NULL

如果 type 有关联的模块但其状态为 NULL,则返回 NULL 且不设置异常。

在 3.9 版新加入.

PyObject *PyType_GetModuleByDef(PyTypeObject *type, struct PyModuleDef *def)

找到所属模块基于给定的 PyModuleDef def 创建的第一个上级类,并返回该模块。

如果未找到模块,则会引发 TypeError 并返回 NULL

此函数预期会与 PyModule_GetState() 一起使用以便从槽位方法 (如 tp_initnb_add) 及其他定义方法的类无法使用 PyCMethod 调用惯例来传递的场合获取模块状态。

在 3.11 版新加入.

创建堆分配类型

下列函数和结构体可被用来创建 堆类型

PyObject *PyType_FromModuleAndSpec(PyObject *module, PyType_Spec *spec, PyObject *bases)
回傳值:新的參照。 属于 稳定 ABI 自 3.10 版开始.

Creates and returns a heap type from the spec (Py_TPFLAGS_HEAPTYPE).

bases 参数可被用来指定基类;它可以是单个类或由多个类组成的元组。 如果 basesNULL,则会改用 Py_tp_bases 槽位。 如果该槽位也为 NULL,则会改用 Py_tp_base 槽位。 如果该槽位同样为 NULL,则新类型将派生自 object

module 参数可被用来记录新类定义所在的模块。 它必须是一个模块对象或为 NULL。 如果不为 NULL,则该模块会被关联到新类型并且可在之后通过 PyType_GetModule() 来获取。 这个关联模块不可被子类继承;它必须为每个类单独指定。

此函数会在新类型上调用 PyType_Ready()

在 3.9 版新加入.

在 3.10 版的變更: 此函数现在接受一个单独类作为 bases 参数并接受 NULL 作为 tp_doc 槽位。

PyObject *PyType_FromSpecWithBases(PyType_Spec *spec, PyObject *bases)
回傳值:新的參照。 属于 稳定 ABI 自 3.3 版开始.

等價於 PyType_FromModuleAndSpec(NULL, spec, bases)

在 3.3 版新加入.

PyObject *PyType_FromSpec(PyType_Spec *spec)
回傳值:新的參照。 属于 稳定 ABI.

等價於 PyType_FromSpecWithBases(spec, NULL)

type PyType_Spec
属于 稳定 ABI (包括所有成员).

定义一个类型的行为的结构体。

const char *PyType_Spec.name

类型的名称,用来设置 PyTypeObject.tp_name

int PyType_Spec.basicsize
int PyType_Spec.itemsize

以字节数表示的实例大小,用来设置 PyTypeObject.tp_basicsizePyTypeObject.tp_itemsize

int PyType_Spec.flags

类型旗标,用来设置 PyTypeObject.tp_flags

如果未设置 Py_TPFLAGS_HEAPTYPE 旗标,则 PyType_FromSpecWithBases() 会自动设置它。

PyType_Slot *PyType_Spec.slots

PyType_Slot 结构体的数组。 以特殊槽位值 {0, NULL} 来结束。

type PyType_Slot
属于 稳定 ABI (包括所有成员).

定义一个类型的可选功能的结构体,包含一个槽位 ID 和一个值指针。

int PyType_Slot.slot

槽位 ID。

槽位 ID 的类名像是结构体 PyTypeObject, PyNumberMethods, PySequenceMethods, PyMappingMethodsPyAsyncMethods 的字段名附加一个 Py_ 前缀。 举例来说,使用:

下列字段完全无法使得 PyType_SpecPyType_Slot 来设置:

在某些平台上设置 Py_tp_basesPy_tp_base 可能会有问题。 为了避免问题,请改用 PyType_FromSpecWithBases()bases 参数。

在 3.9 版的變更: PyBufferProcs 中的槽位可能会在不受限 API 中被设置。

在 3.11 版的變更: 现在 bf_getbufferbf_releasebuffer 将在 受限 API 中可用。

void *PyType_Slot.pfunc

该槽位的预期值。 在大多数情况下,这将是一个指向函数的指针。

Py_tp_doc 以外的槽位均不可为 NULL