具体对象层
The None 就业培训 下载中心 Wiki 联络 登录 注册 首页 Python 3.12.4 索引 模块 下一 上一 Python/C API 参考手册 具体对象层 类型对象 类型对象 ¶ type PyTypeObject ¶ 属于 Limited API (as an opaque struct). The C structure of the objects used to describe built-in types. PyTypeObject PyType_Type ¶ 属于 稳定 ABI (应用程序二进制接口) . This is the type object for type objects; it is the same object as type 在 Python 层。 int PyType_Check ( PyObject * o ) ¶ Return non-zero if the object o is a type object, including instances of types derived from the standard type object. Return 0 in all other cases. This function always succeeds. int PyType_CheckExact ( PyObject * o ) ¶ Return non-zero if the object o is a type object, but not a subtype of the standard type object. Return 0 in all other cases. This function always succeeds. unsigned int PyType_ClearCache ( ) ¶ 属于 稳定 ABI (应用程序二进制接口) . Clear the internal lookup cache. Return the current version tag. unsigned long PyType_GetFlags ( PyTypeObject * type ) ¶ 属于 稳定 ABI (应用程序二进制接口) . 返回 tp_flags member of type . This function is primarily meant for use with Py_LIMITED_API ; the individual flag bits are guaranteed to be stable across Python releases, but access to tp_flags itself is not part of the limited API . Added in version 3.2. 3.4 版改变： The return type is now unsigned long 而不是 long . PyObject * PyType_GetDict ( PyTypeObject * type ) ¶ Return the type object’s internal namespace, which is otherwise only exposed via a read-only proxy ( cls.__dict__ ). This is a replacement for accessing tp_dict directly. The returned dictionary must be treated as read-only. This function is meant for specific embedding and language-binding cases, where direct access to the dict is necessary and indirect access (e.g. via the proxy or PyObject_GetAttr() ) isn’t adequate. Extension modules should continue to use tp_dict , directly or indirectly, when setting up their own types. 3.12 版添加。 void PyType_Modified ( PyTypeObject * type ) ¶ 属于 稳定 ABI (应用程序二进制接口) . Invalidate the internal lookup cache for the type and all of its subtypes. This function must be called after any manual modification of the attributes or base classes of the type. int PyType_AddWatcher ( PyType_WatchCallback callback ) ¶ 注册 callback as a type watcher. Return a non-negative integer ID which must be passed to future calls to PyType_Watch() . In case of error (e.g. no more watcher IDs available), return -1 and set an exception. 3.12 版添加。 int PyType_ClearWatcher ( int watcher_id ) ¶ Clear watcher identified by watcher_id (previously returned from PyType_AddWatcher() ). Return 0 当成功时， -1 on error (e.g. if watcher_id was never registered.) An extension should never call PyType_ClearWatcher 采用 watcher_id that was not returned to it by a previous call to PyType_AddWatcher() . 3.12 版添加。 int PyType_Watch ( int watcher_id , PyObject * type ) ¶ Mark type as watched. The callback granted watcher_id by PyType_AddWatcher() will be called whenever PyType_Modified() reports a change to type . (The callback may be called only once for a series of consecutive modifications to type ，若 _PyType_Lookup() is not called on type between the modifications; this is an implementation detail and subject to change.) An extension should never call PyType_Watch 采用 watcher_id that was not returned to it by a previous call to PyType_AddWatcher() . 3.12 版添加。 typedef int ( * PyType_WatchCallback ) ( PyObject * type ) ¶ Type of a type-watcher callback function. The callback must not modify type or cause PyType_Modified() to be called on type or any type in its MRO; violating this rule could cause infinite recursion. 3.12 版添加。 int PyType_HasFeature ( PyTypeObject * o , int feature ) ¶ Return non-zero if the type object o sets the feature feature . Type features are denoted by single bit flags. int PyType_IS_GC ( PyTypeObject * o ) ¶ Return true if the type object includes support for the cycle detector; this tests the type flag Py_TPFLAGS_HAVE_GC . int PyType_IsSubtype ( PyTypeObject * a , PyTypeObject * b ) ¶ 属于 稳定 ABI (应用程序二进制接口) . 返回 True 若 a is a subtype of b . This function only checks for actual subtypes, which means that __subclasscheck__() is not called on b 。调用 PyObject_IsSubclass() to do the same check that issubclass() would do. PyObject * PyType_GenericAlloc ( PyTypeObject * type , Py_ssize_t nitems ) ¶ 返回值：新引用。 属于 稳定 ABI (应用程序二进制接口) . Generic handler for the tp_alloc slot of a type object. Use Python’s default memory allocation mechanism to allocate a new instance and initialize all its contents to NULL . PyObject * PyType_GenericNew ( PyTypeObject * type , PyObject * args , PyObject * kwds ) ¶ 返回值：新引用。 属于 稳定 ABI (应用程序二进制接口) . Generic handler for the tp_new slot of a type object. Create a new instance using the type’s tp_alloc 槽。 int PyType_Ready ( PyTypeObject * type ) ¶ 属于 稳定 ABI (应用程序二进制接口) . Finalize a type object. This should be called on all type objects to finish their initialization. This function is responsible for adding inherited slots from a type’s base class. Return 0 on success, or return -1 and sets an exception on error. 注意 If some of the base classes implements the GC protocol and the provided type does not include the Py_TPFLAGS_HAVE_GC in its flags, then the GC protocol will be automatically implemented from its parents. On the contrary, if the type being created does include Py_TPFLAGS_HAVE_GC in its flags then it must implement the GC protocol itself by at least implementing the tp_traverse 句柄。 PyObject * PyType_GetName ( PyTypeObject * type ) ¶ 返回值：新引用。 属于 稳定 ABI (应用程序二进制接口) since version 3.11. Return the type’s name. Equivalent to getting the type’s __name__ 属性。 Added in version 3.11. PyObject * PyType_GetQualName ( PyTypeObject * type ) ¶ 返回值：新引用。 属于 稳定 ABI (应用程序二进制接口) since version 3.11. Return the type’s qualified name. Equivalent to getting the type’s __qualname__ 属性。 Added in version 3.11. void * PyType_GetSlot ( PyTypeObject * type , int slot ) ¶ 属于 稳定 ABI (应用程序二进制接口) since version 3.4. Return the function pointer stored in the given slot. If the result is NULL , this indicates that either the slot is NULL , or that the function was called with invalid parameters. Callers will typically cast the result pointer into the appropriate function type. 见 PyType_Slot.slot for possible values of the slot 自变量。 Added in version 3.4. 3.10 版改变： PyType_GetSlot() can now accept all types. Previously, it was limited to heap types . PyObject * PyType_GetModule ( PyTypeObject * type ) ¶ 属于 稳定 ABI (应用程序二进制接口) since version 3.10. Return the module object associated with the given type when the type was created using PyType_FromModuleAndSpec() . If no module is associated with the given type, sets TypeError 并返回 NULL . This function is usually used to get the module in which a method is defined. Note that in such a method, PyType_GetModule(Py_TYPE(self)) may not return the intended result. Py_TYPE(self) 可以是 subclass of the intended class, and subclasses are not necessarily defined in the same module as their superclass. See PyCMethod to get the class that defines the method. See PyType_GetModuleByDef() for cases when PyCMethod cannot be used. Added in version 3.9. void * PyType_GetModuleState ( PyTypeObject * type ) ¶ 属于 稳定 ABI (应用程序二进制接口) since version 3.10. Return the state of the module object associated with the given type. This is a shortcut for calling PyModule_GetState() on the result of PyType_GetModule() . If no module is associated with the given type, sets TypeError 并返回 NULL . 若 type has an associated module but its state is NULL ，返回 NULL without setting an exception. Added in version 3.9. PyObject * PyType_GetModuleByDef ( PyTypeObject * type , struct PyModuleDef * def ) ¶ Find the first superclass whose module was created from the given PyModuleDef def , and return that module. If no module is found, raises a TypeError 并返回 NULL . This function is intended to be used together with PyModule_GetState() to get module state from slot methods (such as tp_init or nb_add ) and other places where a method’s defining class cannot be passed using the PyCMethod 调用约定。 Added in version 3.11. int PyUnstable_Type_AssignVersionTag ( PyTypeObject * type ) ¶ 这为 Unstable API . It may change without warning in minor releases. Attempt to assign a version tag to the given type. Returns 1 if the type already had a valid version tag or a new one was assigned, or 0 if a new tag could not be assigned. 3.12 版添加。 Creating Heap-Allocated Types ¶ The following functions and structs are used to create heap types . PyObject * PyType_FromMetaclass ( PyTypeObject * metaclass , PyObject * 模块 , PyType_Spec * spec , PyObject * bases ) ¶ 属于 稳定 ABI (应用程序二进制接口) since version 3.12. Create and return a heap type 从 spec (见 Py_TPFLAGS_HEAPTYPE ). The metaclass metaclass is used to construct the resulting type object. When metaclass is NULL , the metaclass is derived from bases (或 Py_tp_base[s] slots if bases is NULL , see below). Metaclasses that override tp_new are not supported, except if tp_new is NULL . (For backwards compatibility, other PyType_From* functions allow such metaclasses. They ignore tp_new , which may result in incomplete initialization. This is deprecated and in Python 3.14+ such metaclasses will not be supported.) The bases argument can be used to specify base classes; it can either be only one class or a tuple of classes. If bases is NULL ， Py_tp_bases slot is used instead. If that also is NULL ， Py_tp_base slot is used instead. If that also is NULL , the new type derives from object . The 模块 argument can be used to record the module in which the new class is defined. It must be a module object or NULL . If not NULL , the module is associated with the new type and can later be retrieved with PyType_GetModule() . The associated module is not inherited by subclasses; it must be specified for each class individually. 此函数调用 PyType_Ready() on the new type. Note that this function does not fully match the behavior of calling type() or using the class statement. With user-provided base types or metaclasses, prefer 调用 type (or the metaclass) over PyType_From* functions. Specifically: __new__() is not called on the new class (and it must be set to type.__new__ ). __init__() is not called on the new class. __init_subclass__() is not called on any bases. __set_name__() is not called on new descriptors. 3.12 版添加。 PyObject * PyType_FromModuleAndSpec ( PyObject * 模块 , PyType_Spec * spec , PyObject * bases ) ¶ 返回值：新引用。 属于 稳定 ABI (应用程序二进制接口) since version 3.10. 相当于 PyType_FromMetaclass(NULL, module, spec, bases) . Added in version 3.9. 3.10 版改变： The function now accepts a single class as the bases argument and NULL 作为 tp_doc 槽。 Changed in version 3.12: The function now finds and uses a metaclass corresponding to the provided base classes. Previously, only type instances were returned. The tp_new of the metaclass is ignored . which may result in incomplete initialization. Creating classes whose metaclass overrides tp_new is deprecated and in Python 3.14+ it will be no longer allowed. PyObject * PyType_FromSpecWithBases ( PyType_Spec * spec , PyObject * bases ) ¶ 返回值：新引用。 属于 稳定 ABI (应用程序二进制接口) since version 3.3. 相当于 PyType_FromMetaclass(NULL, NULL, spec, bases) . Added in version 3.3. Changed in version 3.12: The function now finds and uses a metaclass corresponding to the provided base classes. Previously, only type instances were returned. The tp_new of the metaclass is ignored . which may result in incomplete initialization. Creating classes whose metaclass overrides tp_new is deprecated and in Python 3.14+ it will be no longer allowed. PyObject * PyType_FromSpec ( PyType_Spec * spec ) ¶ 返回值：新引用。 属于 稳定 ABI (应用程序二进制接口) . 相当于 PyType_FromMetaclass(NULL, NULL, spec, NULL) . Changed in version 3.12: The function now finds and uses a metaclass corresponding to the base classes provided in Py_tp_base[s] slots. Previously, only type instances were returned. The tp_new of the metaclass is ignored . which may result in incomplete initialization. Creating classes whose metaclass overrides tp_new is deprecated and in Python 3.14+ it will be no longer allowed. type PyType_Spec ¶ 属于 稳定 ABI (应用程序二进制接口) (including all members). Structure defining a type’s behavior. const char * name ¶ Name of the type, used to set PyTypeObject.tp_name . int basicsize ¶ If positive, specifies the size of the instance in bytes. It is used to set PyTypeObject.tp_basicsize . If zero, specifies that tp_basicsize should be inherited. If negative, the absolute value specifies how much space instances of the class need in addition to the superclass. Use PyObject_GetTypeData() to get a pointer to subclass-specific memory reserved this way. Changed in version 3.12: Previously, this field could not be negative. int itemsize ¶ Size of one element of a variable-size type, in bytes. Used to set PyTypeObject.tp_itemsize 。见 tp_itemsize documentation for caveats. If zero, tp_itemsize is inherited. Extending arbitrary variable-sized classes is dangerous, since some types use a fixed offset for variable-sized memory, which can then overlap fixed-sized memory used by a subclass. To help prevent mistakes, inheriting itemsize is only possible in the following situations: The base is not variable-sized (its tp_itemsize ). The requested PyType_Spec.basicsize is positive, suggesting that the memory layout of the base class is known. The requested PyType_Spec.basicsize is zero, suggesting that the subclass does not access the instance’s memory directly. With the Py_TPFLAGS_ITEMS_AT_END 标志。 unsigned int flags ¶ Type flags, used to set PyTypeObject.tp_flags . 若 Py_TPFLAGS_HEAPTYPE flag is not set, PyType_FromSpecWithBases() sets it automatically. PyType_Slot * slots ¶ Array of PyType_Slot structures. Terminated by the special slot value {0, NULL} . Each slot ID should be specified at most once. type PyType_Slot ¶ 属于 稳定 ABI (应用程序二进制接口) (including all members). Structure defining optional functionality of a type, containing a slot ID and a value pointer. int slot ¶ A slot ID. Slot IDs are named like the field names of the structures PyTypeObject , PyNumberMethods , PySequenceMethods , PyMappingMethods and PyAsyncMethods with an added Py_ prefix. For example, use: Py_tp_dealloc to set PyTypeObject.tp_dealloc Py_nb_add to set PyNumberMethods.nb_add Py_sq_length to set PySequenceMethods.sq_length The following “offset” fields cannot be set using PyType_Slot : tp_weaklistoffset (使用 Py_TPFLAGS_MANAGED_WEAKREF instead if possible) tp_dictoffset (使用 Py_TPFLAGS_MANAGED_DICT instead if possible) tp_vectorcall_offset (使用 "__vectorcalloffset__" in PyMemberDef ) If it is not possible to switch to a MANAGED flag (for example, for vectorcall or to support Python older than 3.12), specify the offset in Py_tp_members 。见 PyMemberDef documentation 了解细节。 The following fields cannot be set at all when creating a heap type: tp_vectorcall (使用 tp_new and/or tp_init ) Internal fields: tp_dict , tp_mro , tp_cache , tp_subclasses ，和 tp_weaklist . 设置 Py_tp_bases or Py_tp_base may be problematic on some platforms. To avoid issues, use the bases 自变量 PyType_FromSpecWithBases() 代替。 3.9 版改变： Slots in PyBufferProcs may be set in the unlimited API. 3.11 版改变： bf_getbuffer and bf_releasebuffer are now available under the limited API . void * pfunc ¶ The desired value of the slot. In most cases, this is a pointer to a function. Slots other than Py_tp_doc may not be NULL . 内容表 类型对象 Creating Heap-Allocated Types 上一话题 具体对象层 下一话题 The None 对象 本页 报告 Bug 展示源 快速搜索 键入搜索术语或模块、类、函数名称。 首页 Python 3.12.4 索引 模块 下一 上一 Python/C API 参考手册 具体对象层 类型对象
None 就业培训 下载中心 Wiki 联络 登录 注册 首页 Python 3.12.4 索引 模块 下一 上一 Python/C API 参考手册 具体对象层 类型对象 类型对象 ¶ type PyTypeObject ¶ 属于 Limited API (as an opaque struct). The C structure of the objects used to describe built-in types. PyTypeObject PyType_Type ¶ 属于 稳定 ABI (应用程序二进制接口) . This is the type object for type objects; it is the same object as type 在 Python 层。 int PyType_Check ( PyObject * o ) ¶ Return non-zero if the object o is a type object, including instances of types derived from the standard type object. Return 0 in all other cases. This function always succeeds. int PyType_CheckExact ( PyObject * o ) ¶ Return non-zero if the object o is a type object, but not a subtype of the standard type object. Return 0 in all other cases. This function always succeeds. unsigned int PyType_ClearCache ( ) ¶ 属于 稳定 ABI (应用程序二进制接口) . Clear the internal lookup cache. Return the current version tag. unsigned long PyType_GetFlags ( PyTypeObject * type ) ¶ 属于 稳定 ABI (应用程序二进制接口) . 返回 tp_flags member of type . This function is primarily meant for use with Py_LIMITED_API ; the individual flag bits are guaranteed to be stable across Python releases, but access to tp_flags itself is not part of the limited API . Added in version 3.2. 3.4 版改变： The return type is now unsigned long 而不是 long . PyObject * PyType_GetDict ( PyTypeObject * type ) ¶ Return the type object’s internal namespace, which is otherwise only exposed via a read-only proxy ( cls.__dict__ ). This is a replacement for accessing tp_dict directly. The returned dictionary must be treated as read-only. This function is meant for specific embedding and language-binding cases, where direct access to the dict is necessary and indirect access (e.g. via the proxy or PyObject_GetAttr() ) isn’t adequate. Extension modules should continue to use tp_dict , directly or indirectly, when setting up their own types. 3.12 版添加。 void PyType_Modified ( PyTypeObject * type ) ¶ 属于 稳定 ABI (应用程序二进制接口) . Invalidate the internal lookup cache for the type and all of its subtypes. This function must be called after any manual modification of the attributes or base classes of the type. int PyType_AddWatcher ( PyType_WatchCallback callback ) ¶ 注册 callback as a type watcher. Return a non-negative integer ID which must be passed to future calls to PyType_Watch() . In case of error (e.g. no more watcher IDs available), return -1 and set an exception. 3.12 版添加。 int PyType_ClearWatcher ( int watcher_id ) ¶ Clear watcher identified by watcher_id (previously returned from PyType_AddWatcher() ). Return 0 当成功时， -1 on error (e.g. if watcher_id was never registered.) An extension should never call PyType_ClearWatcher 采用 watcher_id that was not returned to it by a previous call to PyType_AddWatcher() . 3.12 版添加。 int PyType_Watch ( int watcher_id , PyObject * type ) ¶ Mark type as watched. The callback granted watcher_id by PyType_AddWatcher() will be called whenever PyType_Modified() reports a change to type . (The callback may be called only once for a series of consecutive modifications to type ，若 _PyType_Lookup() is not called on type between the modifications; this is an implementation detail and subject to change.) An extension should never call PyType_Watch 采用 watcher_id that was not returned to it by a previous call to PyType_AddWatcher() . 3.12 版添加。 typedef int ( * PyType_WatchCallback ) ( PyObject * type ) ¶ Type of a type-watcher callback function. The callback must not modify type or cause PyType_Modified() to be called on type or any type in its MRO; violating this rule could cause infinite recursion. 3.12 版添加。 int PyType_HasFeature ( PyTypeObject * o , int feature ) ¶ Return non-zero if the type object o sets the feature feature . Type features are denoted by single bit flags. int PyType_IS_GC ( PyTypeObject * o ) ¶ Return true if the type object includes support for the cycle detector; this tests the type flag Py_TPFLAGS_HAVE_GC . int PyType_IsSubtype ( PyTypeObject * a , PyTypeObject * b ) ¶ 属于 稳定 ABI (应用程序二进制接口) . 返回 True 若 a is a subtype of b . This function only checks for actual subtypes, which means that __subclasscheck__() is not called on b 。调用 PyObject_IsSubclass() to do the same check that issubclass() would do. PyObject * PyType_GenericAlloc ( PyTypeObject * type , Py_ssize_t nitems ) ¶ 返回值：新引用。 属于 稳定 ABI (应用程序二进制接口) . Generic handler for the tp_alloc slot of a type object. Use Python’s default memory allocation mechanism to allocate a new instance and initialize all its contents to NULL . PyObject * PyType_GenericNew ( PyTypeObject * type , PyObject * args , PyObject * kwds ) ¶ 返回值：新引用。 属于 稳定 ABI (应用程序二进制接口) . Generic handler for the tp_new slot of a type object. Create a new instance using the type’s tp_alloc 槽。 int PyType_Ready ( PyTypeObject * type ) ¶ 属于 稳定 ABI (应用程序二进制接口) . Finalize a type object. This should be called on all type objects to finish their initialization. This function is responsible for adding inherited slots from a type’s base class. Return 0 on success, or return -1 and sets an exception on error. 注意 If some of the base classes implements the GC protocol and the provided type does not include the Py_TPFLAGS_HAVE_GC in its flags, then the GC protocol will be automatically implemented from its parents. On the contrary, if the type being created does include Py_TPFLAGS_HAVE_GC in its flags then it must implement the GC protocol itself by at least implementing the tp_traverse 句柄。 PyObject * PyType_GetName ( PyTypeObject * type ) ¶ 返回值：新引用。 属于 稳定 ABI (应用程序二进制接口) since version 3.11. Return the type’s name. Equivalent to getting the type’s __name__ 属性。 Added in version 3.11. PyObject * PyType_GetQualName ( PyTypeObject * type ) ¶ 返回值：新引用。 属于 稳定 ABI (应用程序二进制接口) since version 3.11. Return the type’s qualified name. Equivalent to getting the type’s __qualname__ 属性。 Added in version 3.11. void * PyType_GetSlot ( PyTypeObject * type , int slot ) ¶ 属于 稳定 ABI (应用程序二进制接口) since version 3.4. Return the function pointer stored in the given slot. If the result is NULL , this indicates that either the slot is NULL , or that the function was called with invalid parameters. Callers will typically cast the result pointer into the appropriate function type. 见 PyType_Slot.slot for possible values of the slot 自变量。 Added in version 3.4. 3.10 版改变： PyType_GetSlot() can now accept all types. Previously, it was limited to heap types . PyObject * PyType_GetModule ( PyTypeObject * type ) ¶ 属于 稳定 ABI (应用程序二进制接口) since version 3.10. Return the module object associated with the given type when the type was created using PyType_FromModuleAndSpec() . If no module is associated with the given type, sets TypeError 并返回 NULL . This function is usually used to get the module in which a method is defined. Note that in such a method, PyType_GetModule(Py_TYPE(self)) may not return the intended result. Py_TYPE(self) 可以是 subclass of the intended class, and subclasses are not necessarily defined in the same module as their superclass. See PyCMethod to get the class that defines the method. See PyType_GetModuleByDef() for cases when PyCMethod cannot be used. Added in version 3.9. void * PyType_GetModuleState ( PyTypeObject * type ) ¶ 属于 稳定 ABI (应用程序二进制接口) since version 3.10. Return the state of the module object associated with the given type. This is a shortcut for calling PyModule_GetState() on the result of PyType_GetModule() . If no module is associated with the given type, sets TypeError 并返回 NULL . 若 type has an associated module but its state is NULL ，返回 NULL without setting an exception. Added in version 3.9. PyObject * PyType_GetModuleByDef ( PyTypeObject * type , struct PyModuleDef * def ) ¶ Find the first superclass whose module was created from the given PyModuleDef def , and return that module. If no module is found, raises a TypeError 并返回 NULL . This function is intended to be used together with PyModule_GetState() to get module state from slot methods (such as tp_init or nb_add ) and other places where a method’s defining class cannot be passed using the PyCMethod 调用约定。 Added in version 3.11. int PyUnstable_Type_AssignVersionTag ( PyTypeObject * type ) ¶ 这为 Unstable API . It may change without warning in minor releases. Attempt to assign a version tag to the given type. Returns 1 if the type already had a valid version tag or a new one was assigned, or 0 if a new tag could not be assigned. 3.12 版添加。 Creating Heap-Allocated Types ¶ The following functions and structs are used to create heap types . PyObject * PyType_FromMetaclass ( PyTypeObject * metaclass , PyObject * 模块 , PyType_Spec * spec , PyObject * bases ) ¶ 属于 稳定 ABI (应用程序二进制接口) since version 3.12. Create and return a heap type 从 spec (见 Py_TPFLAGS_HEAPTYPE ). The metaclass metaclass is used to construct the resulting type object. When metaclass is NULL , the metaclass is derived from bases (或 Py_tp_base[s] slots if bases is NULL , see below). Metaclasses that override tp_new are not supported, except if tp_new is NULL . (For backwards compatibility, other PyType_From* functions allow such metaclasses. They ignore tp_new , which may result in incomplete initialization. This is deprecated and in Python 3.14+ such metaclasses will not be supported.) The bases argument can be used to specify base classes; it can either be only one class or a tuple of classes. If bases is NULL ， Py_tp_bases slot is used instead. If that also is NULL ， Py_tp_base slot is used instead. If that also is NULL , the new type derives from object . The 模块 argument can be used to record the module in which the new class is defined. It must be a module object or NULL . If not NULL , the module is associated with the new type and can later be retrieved with PyType_GetModule() . The associated module is not inherited by subclasses; it must be specified for each class individually. 此函数调用 PyType_Ready() on the new type. Note that this function does not fully match the behavior of calling type() or using the class statement. With user-provided base types or metaclasses, prefer 调用 type (or the metaclass) over PyType_From* functions. Specifically: __new__() is not called on the new class (and it must be set to type.__new__ ). __init__() is not called on the new class. __init_subclass__() is not called on any bases. __set_name__() is not called on new descriptors. 3.12 版添加。 PyObject * PyType_FromModuleAndSpec ( PyObject * 模块 , PyType_Spec * spec , PyObject * bases ) ¶ 返回值：新引用。 属于 稳定 ABI (应用程序二进制接口) since version 3.10. 相当于 PyType_FromMetaclass(NULL, module, spec, bases) . Added in version 3.9. 3.10 版改变： The function now accepts a single class as the bases argument and NULL 作为 tp_doc 槽。 Changed in version 3.12: The function now finds and uses a metaclass corresponding to the provided base classes. Previously, only type instances were returned. The tp_new of the metaclass is ignored . which may result in incomplete initialization. Creating classes whose metaclass overrides tp_new is deprecated and in Python 3.14+ it will be no longer allowed. PyObject * PyType_FromSpecWithBases ( PyType_Spec * spec , PyObject * bases ) ¶ 返回值：新引用。 属于 稳定 ABI (应用程序二进制接口) since version 3.3. 相当于 PyType_FromMetaclass(NULL, NULL, spec, bases) . Added in version 3.3. Changed in version 3.12: The function now finds and uses a metaclass corresponding to the provided base classes. Previously, only type instances were returned. The tp_new of the metaclass is ignored . which may result in incomplete initialization. Creating classes whose metaclass overrides tp_new is deprecated and in Python 3.14+ it will be no longer allowed. PyObject * PyType_FromSpec ( PyType_Spec * spec ) ¶ 返回值：新引用。 属于 稳定 ABI (应用程序二进制接口) . 相当于 PyType_FromMetaclass(NULL, NULL, spec, NULL) . Changed in version 3.12: The function now finds and uses a metaclass corresponding to the base classes provided in Py_tp_base[s] slots. Previously, only type instances were returned. The tp_new of the metaclass is ignored . which may result in incomplete initialization. Creating classes whose metaclass overrides tp_new is deprecated and in Python 3.14+ it will be no longer allowed. type PyType_Spec ¶ 属于 稳定 ABI (应用程序二进制接口) (including all members). Structure defining a type’s behavior. const char * name ¶ Name of the type, used to set PyTypeObject.tp_name . int basicsize ¶ If positive, specifies the size of the instance in bytes. It is used to set PyTypeObject.tp_basicsize . If zero, specifies that tp_basicsize should be inherited. If negative, the absolute value specifies how much space instances of the class need in addition to the superclass. Use PyObject_GetTypeData() to get a pointer to subclass-specific memory reserved this way. Changed in version 3.12: Previously, this field could not be negative. int itemsize ¶ Size of one element of a variable-size type, in bytes. Used to set PyTypeObject.tp_itemsize 。见 tp_itemsize documentation for caveats. If zero, tp_itemsize is inherited. Extending arbitrary variable-sized classes is dangerous, since some types use a fixed offset for variable-sized memory, which can then overlap fixed-sized memory used by a subclass. To help prevent mistakes, inheriting itemsize is only possible in the following situations: The base is not variable-sized (its tp_itemsize ). The requested PyType_Spec.basicsize is positive, suggesting that the memory layout of the base class is known. The requested PyType_Spec.basicsize is zero, suggesting that the subclass does not access the instance’s memory directly. With the Py_TPFLAGS_ITEMS_AT_END 标志。 unsigned int flags ¶ Type flags, used to set PyTypeObject.tp_flags . 若 Py_TPFLAGS_HEAPTYPE flag is not set, PyType_FromSpecWithBases() sets it automatically. PyType_Slot * slots ¶ Array of PyType_Slot structures. Terminated by the special slot value {0, NULL} . Each slot ID should be specified at most once. type PyType_Slot ¶ 属于 稳定 ABI (应用程序二进制接口) (including all members). Structure defining optional functionality of a type, containing a slot ID and a value pointer. int slot ¶ A slot ID. Slot IDs are named like the field names of the structures PyTypeObject , PyNumberMethods , PySequenceMethods , PyMappingMethods and PyAsyncMethods with an added Py_ prefix. For example, use: Py_tp_dealloc to set PyTypeObject.tp_dealloc Py_nb_add to set PyNumberMethods.nb_add Py_sq_length to set PySequenceMethods.sq_length The following “offset” fields cannot be set using PyType_Slot : tp_weaklistoffset (使用 Py_TPFLAGS_MANAGED_WEAKREF instead if possible) tp_dictoffset (使用 Py_TPFLAGS_MANAGED_DICT instead if possible) tp_vectorcall_offset (使用 "__vectorcalloffset__" in PyMemberDef ) If it is not possible to switch to a MANAGED flag (for example, for vectorcall or to support Python older than 3.12), specify the offset in Py_tp_members 。见 PyMemberDef documentation 了解细节。 The following fields cannot be set at all when creating a heap type: tp_vectorcall (使用 tp_new and/or tp_init ) Internal fields: tp_dict , tp_mro , tp_cache , tp_subclasses ，和 tp_weaklist . 设置 Py_tp_bases or Py_tp_base may be problematic on some platforms. To avoid issues, use the bases 自变量 PyType_FromSpecWithBases() 代替。 3.9 版改变： Slots in PyBufferProcs may be set in the unlimited API. 3.11 版改变： bf_getbuffer and bf_releasebuffer are now available under the limited API . void * pfunc ¶ The desired value of the slot. In most cases, this is a pointer to a function. Slots other than Py_tp_doc may not be NULL . 内容表 类型对象 Creating Heap-Allocated Types 上一话题 具体对象层 下一话题 The None 对象 本页 报告 Bug 展示源 快速搜索 键入搜索术语或模块、类、函数名称。 首页 Python 3.12.4 索引 模块 下一 上一 Python/C API 参考手册 具体对象层 类型对象
The C structure of the objects used to describe built-in types.
This is the type object for type objects; it is the same object as type 在 Python 层。
type
Return non-zero if the object o is a type object, including instances of types derived from the standard type object. Return 0 in all other cases. This function always succeeds.
Return non-zero if the object o is a type object, but not a subtype of the standard type object. Return 0 in all other cases. This function always succeeds.
Clear the internal lookup cache. Return the current version tag.
返回 tp_flags member of type . This function is primarily meant for use with Py_LIMITED_API ; the individual flag bits are guaranteed to be stable across Python releases, but access to tp_flags itself is not part of the limited API .
tp_flags
Py_LIMITED_API
Added in version 3.2.
3.4 版改变： The return type is now unsigned long 而不是 long .
unsigned long
long
Return the type object’s internal namespace, which is otherwise only exposed via a read-only proxy ( cls.__dict__ ). This is a replacement for accessing tp_dict directly. The returned dictionary must be treated as read-only.
cls.__dict__
tp_dict
This function is meant for specific embedding and language-binding cases, where direct access to the dict is necessary and indirect access (e.g. via the proxy or PyObject_GetAttr() ) isn’t adequate.
PyObject_GetAttr()
Extension modules should continue to use tp_dict , directly or indirectly, when setting up their own types.
3.12 版添加。
Invalidate the internal lookup cache for the type and all of its subtypes. This function must be called after any manual modification of the attributes or base classes of the type.
注册 callback as a type watcher. Return a non-negative integer ID which must be passed to future calls to PyType_Watch() . In case of error (e.g. no more watcher IDs available), return -1 and set an exception.
PyType_Watch()
-1
Clear watcher identified by watcher_id (previously returned from PyType_AddWatcher() ). Return 0 当成功时， -1 on error (e.g. if watcher_id was never registered.)
PyType_AddWatcher()
0
An extension should never call PyType_ClearWatcher 采用 watcher_id that was not returned to it by a previous call to PyType_AddWatcher() .
PyType_ClearWatcher
Mark type as watched. The callback granted watcher_id by PyType_AddWatcher() will be called whenever PyType_Modified() reports a change to type . (The callback may be called only once for a series of consecutive modifications to type ，若 _PyType_Lookup() is not called on type between the modifications; this is an implementation detail and subject to change.)
PyType_Modified()
_PyType_Lookup()
An extension should never call PyType_Watch 采用 watcher_id that was not returned to it by a previous call to PyType_AddWatcher() .
PyType_Watch
Type of a type-watcher callback function.
The callback must not modify type or cause PyType_Modified() to be called on type or any type in its MRO; violating this rule could cause infinite recursion.
Return non-zero if the type object o sets the feature feature . Type features are denoted by single bit flags.
Return true if the type object includes support for the cycle detector; this tests the type flag Py_TPFLAGS_HAVE_GC .
Py_TPFLAGS_HAVE_GC
返回 True 若 a is a subtype of b .
This function only checks for actual subtypes, which means that __subclasscheck__() is not called on b 。调用 PyObject_IsSubclass() to do the same check that issubclass() would do.
__subclasscheck__()
PyObject_IsSubclass()
issubclass()
Generic handler for the tp_alloc slot of a type object. Use Python’s default memory allocation mechanism to allocate a new instance and initialize all its contents to NULL .
tp_alloc
NULL
Generic handler for the tp_new slot of a type object. Create a new instance using the type’s tp_alloc 槽。
tp_new
Finalize a type object. This should be called on all type objects to finish their initialization. This function is responsible for adding inherited slots from a type’s base class. Return 0 on success, or return -1 and sets an exception on error.
注意
If some of the base classes implements the GC protocol and the provided type does not include the Py_TPFLAGS_HAVE_GC in its flags, then the GC protocol will be automatically implemented from its parents. On the contrary, if the type being created does include Py_TPFLAGS_HAVE_GC in its flags then it must implement the GC protocol itself by at least implementing the tp_traverse 句柄。
tp_traverse
Return the type’s name. Equivalent to getting the type’s __name__ 属性。
__name__
Added in version 3.11.
Return the type’s qualified name. Equivalent to getting the type’s __qualname__ 属性。
__qualname__
Return the function pointer stored in the given slot. If the result is NULL , this indicates that either the slot is NULL , or that the function was called with invalid parameters. Callers will typically cast the result pointer into the appropriate function type.
见 PyType_Slot.slot for possible values of the slot 自变量。
PyType_Slot.slot
Added in version 3.4.
3.10 版改变： PyType_GetSlot() can now accept all types. Previously, it was limited to heap types .
PyType_GetSlot()
Return the module object associated with the given type when the type was created using PyType_FromModuleAndSpec() .
PyType_FromModuleAndSpec()
If no module is associated with the given type, sets TypeError 并返回 NULL .
TypeError
This function is usually used to get the module in which a method is defined. Note that in such a method, PyType_GetModule(Py_TYPE(self)) may not return the intended result. Py_TYPE(self) 可以是 subclass of the intended class, and subclasses are not necessarily defined in the same module as their superclass. See PyCMethod to get the class that defines the method. See PyType_GetModuleByDef() for cases when PyCMethod cannot be used.
PyType_GetModule(Py_TYPE(self))
Py_TYPE(self)
PyCMethod
PyType_GetModuleByDef()
Added in version 3.9.
Return the state of the module object associated with the given type. This is a shortcut for calling PyModule_GetState() on the result of PyType_GetModule() .
PyModule_GetState()
PyType_GetModule()
若 type has an associated module but its state is NULL ，返回 NULL without setting an exception.
Find the first superclass whose module was created from the given PyModuleDef def , and return that module.
PyModuleDef
If no module is found, raises a TypeError 并返回 NULL .
This function is intended to be used together with PyModule_GetState() to get module state from slot methods (such as tp_init or nb_add ) and other places where a method’s defining class cannot be passed using the PyCMethod 调用约定。
tp_init
nb_add
Attempt to assign a version tag to the given type.
Returns 1 if the type already had a valid version tag or a new one was assigned, or 0 if a new tag could not be assigned.
The following functions and structs are used to create heap types .
Create and return a heap type 从 spec (见 Py_TPFLAGS_HEAPTYPE ).
Py_TPFLAGS_HEAPTYPE
The metaclass metaclass is used to construct the resulting type object. When metaclass is NULL , the metaclass is derived from bases (或 Py_tp_base[s] slots if bases is NULL , see below).
Metaclasses that override tp_new are not supported, except if tp_new is NULL . (For backwards compatibility, other PyType_From* functions allow such metaclasses. They ignore tp_new , which may result in incomplete initialization. This is deprecated and in Python 3.14+ such metaclasses will not be supported.)
PyType_From*
The bases argument can be used to specify base classes; it can either be only one class or a tuple of classes. If bases is NULL ， Py_tp_bases slot is used instead. If that also is NULL ， Py_tp_base slot is used instead. If that also is NULL , the new type derives from object .
object
The 模块 argument can be used to record the module in which the new class is defined. It must be a module object or NULL . If not NULL , the module is associated with the new type and can later be retrieved with PyType_GetModule() . The associated module is not inherited by subclasses; it must be specified for each class individually.
此函数调用 PyType_Ready() on the new type.
PyType_Ready()
Note that this function does not fully match the behavior of calling type() or using the class statement. With user-provided base types or metaclasses, prefer 调用 type (or the metaclass) over PyType_From* functions. Specifically:
type()
class
__new__() is not called on the new class (and it must be set to type.__new__ ).
__new__()
type.__new__
__init__() is not called on the new class.
__init__()
__init_subclass__() is not called on any bases.
__init_subclass__()
__set_name__() is not called on new descriptors.
__set_name__()
相当于 PyType_FromMetaclass(NULL, module, spec, bases) .
PyType_FromMetaclass(NULL, module, spec, bases)
3.10 版改变： The function now accepts a single class as the bases argument and NULL 作为 tp_doc 槽。
tp_doc
Changed in version 3.12: The function now finds and uses a metaclass corresponding to the provided base classes. Previously, only type instances were returned.
The tp_new of the metaclass is ignored . which may result in incomplete initialization. Creating classes whose metaclass overrides tp_new is deprecated and in Python 3.14+ it will be no longer allowed.
相当于 PyType_FromMetaclass(NULL, NULL, spec, bases) .
PyType_FromMetaclass(NULL, NULL, spec, bases)
Added in version 3.3.
相当于 PyType_FromMetaclass(NULL, NULL, spec, NULL) .
PyType_FromMetaclass(NULL, NULL, spec, NULL)
Changed in version 3.12: The function now finds and uses a metaclass corresponding to the base classes provided in Py_tp_base[s] slots. Previously, only type instances were returned.
Structure defining a type’s behavior.
Name of the type, used to set PyTypeObject.tp_name .
PyTypeObject.tp_name
If positive, specifies the size of the instance in bytes. It is used to set PyTypeObject.tp_basicsize .
PyTypeObject.tp_basicsize
If zero, specifies that tp_basicsize should be inherited.
tp_basicsize
If negative, the absolute value specifies how much space instances of the class need in addition to the superclass. Use PyObject_GetTypeData() to get a pointer to subclass-specific memory reserved this way.
PyObject_GetTypeData()
Changed in version 3.12: Previously, this field could not be negative.
Size of one element of a variable-size type, in bytes. Used to set PyTypeObject.tp_itemsize 。见 tp_itemsize documentation for caveats.
PyTypeObject.tp_itemsize
tp_itemsize
If zero, tp_itemsize is inherited. Extending arbitrary variable-sized classes is dangerous, since some types use a fixed offset for variable-sized memory, which can then overlap fixed-sized memory used by a subclass. To help prevent mistakes, inheriting itemsize is only possible in the following situations:
itemsize
The base is not variable-sized (its tp_itemsize ).
The requested PyType_Spec.basicsize is positive, suggesting that the memory layout of the base class is known.
PyType_Spec.basicsize
The requested PyType_Spec.basicsize is zero, suggesting that the subclass does not access the instance’s memory directly.
With the Py_TPFLAGS_ITEMS_AT_END 标志。
Py_TPFLAGS_ITEMS_AT_END
Type flags, used to set PyTypeObject.tp_flags .
PyTypeObject.tp_flags
若 Py_TPFLAGS_HEAPTYPE flag is not set, PyType_FromSpecWithBases() sets it automatically.
PyType_FromSpecWithBases()
Array of PyType_Slot structures. Terminated by the special slot value {0, NULL} .
PyType_Slot
{0, NULL}
Each slot ID should be specified at most once.
Structure defining optional functionality of a type, containing a slot ID and a value pointer.
A slot ID. Slot IDs are named like the field names of the structures PyTypeObject , PyNumberMethods , PySequenceMethods , PyMappingMethods and PyAsyncMethods with an added Py_ prefix. For example, use: Py_tp_dealloc to set PyTypeObject.tp_dealloc Py_nb_add to set PyNumberMethods.nb_add Py_sq_length to set PySequenceMethods.sq_length The following “offset” fields cannot be set using PyType_Slot : tp_weaklistoffset (使用 Py_TPFLAGS_MANAGED_WEAKREF instead if possible) tp_dictoffset (使用 Py_TPFLAGS_MANAGED_DICT instead if possible) tp_vectorcall_offset (使用 "__vectorcalloffset__" in PyMemberDef ) If it is not possible to switch to a MANAGED flag (for example, for vectorcall or to support Python older than 3.12), specify the offset in Py_tp_members 。见 PyMemberDef documentation 了解细节。
A slot ID.
Slot IDs are named like the field names of the structures PyTypeObject , PyNumberMethods , PySequenceMethods , PyMappingMethods and PyAsyncMethods with an added Py_ prefix. For example, use:
PyTypeObject
PyNumberMethods
PySequenceMethods
PyMappingMethods
PyAsyncMethods
Py_
Py_tp_dealloc to set PyTypeObject.tp_dealloc
Py_tp_dealloc
PyTypeObject.tp_dealloc
Py_nb_add to set PyNumberMethods.nb_add
Py_nb_add
PyNumberMethods.nb_add
Py_sq_length to set PySequenceMethods.sq_length
Py_sq_length
PySequenceMethods.sq_length
The following “offset” fields cannot be set using PyType_Slot :
tp_weaklistoffset (使用 Py_TPFLAGS_MANAGED_WEAKREF instead if possible)
tp_weaklistoffset
Py_TPFLAGS_MANAGED_WEAKREF
tp_dictoffset (使用 Py_TPFLAGS_MANAGED_DICT instead if possible)
tp_dictoffset
Py_TPFLAGS_MANAGED_DICT
tp_vectorcall_offset (使用 "__vectorcalloffset__" in PyMemberDef )
tp_vectorcall_offset
"__vectorcalloffset__"
If it is not possible to switch to a MANAGED flag (for example, for vectorcall or to support Python older than 3.12), specify the offset in Py_tp_members 。见 PyMemberDef documentation 了解细节。
MANAGED
Py_tp_members
The following fields cannot be set at all when creating a heap type:
tp_vectorcall (使用 tp_new and/or tp_init )
tp_vectorcall
Internal fields: tp_dict , tp_mro , tp_cache , tp_subclasses ，和 tp_weaklist .
tp_mro
tp_cache
tp_subclasses
tp_weaklist
设置 Py_tp_bases or Py_tp_base may be problematic on some platforms. To avoid issues, use the bases 自变量 PyType_FromSpecWithBases() 代替。
Py_tp_bases
Py_tp_base
3.9 版改变： Slots in PyBufferProcs may be set in the unlimited API.
PyBufferProcs
3.11 版改变： bf_getbuffer and bf_releasebuffer are now available under the limited API .
bf_getbuffer
bf_releasebuffer
The desired value of the slot. In most cases, this is a pointer to a function.
Slots other than Py_tp_doc may not be NULL .
Py_tp_doc
The None 对象
None
键入搜索术语或模块、类、函数名称。