Type Objects¶
- 
type PyTypeObject¶
-  Part of the Limited API (as an opaque struct).The C structure of the objects used to describe built-in types. 
- 
PyTypeObject PyType_Type¶
-  Part of the Stable ABI.This is the type object for type objects; it is the same object as typein the Python layer.
- 
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()¶
-  Part of the Stable ABI.Clear the internal lookup cache. Return the current version tag. 
- 
unsigned long PyType_GetFlags(PyTypeObject *type)¶
-  Part of the Stable ABI.Return the tp_flagsmember of type. This function is primarily meant for use withPy_LIMITED_API; the individual flag bits are guaranteed to be stable across Python releases, but access totp_flagsitself is not part of the limited API.Added in version 3.2. Changed in version 3.4: The return type is now unsigned longrather thanlong.
- 
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_dictdirectly. 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.- Added in version 3.12. 
- 
void PyType_Modified(PyTypeObject *type)¶
-  Part of the Stable 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)¶
- Register 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- -1and set an exception.- Added in version 3.12. 
- 
int PyType_ClearWatcher(int watcher_id)¶
- Clear watcher identified by watcher_id (previously returned from - PyType_AddWatcher()). Return- 0on success,- -1on error (e.g. if watcher_id was never registered.)- An extension should never call - PyType_ClearWatcherwith a watcher_id that was not returned to it by a previous call to- PyType_AddWatcher().- Added in version 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, if- _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_Watchwith a watcher_id that was not returned to it by a previous call to- PyType_AddWatcher().- Added in version 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.- Added in version 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)¶
-  Part of the Stable ABI.Return true if a is a subtype of b. This function only checks for actual subtypes, which means that __subclasscheck__()is not called on b. CallPyObject_IsSubclass()to do the same check thatissubclass()would do.
- 
PyObject *PyType_GenericAlloc(PyTypeObject *type, Py_ssize_t nitems)¶
- Return value: New reference. Part of the Stable ABI.Generic handler for the tp_allocslot of a type object. Use Python’s default memory allocation mechanism to allocate a new instance and initialize all its contents toNULL.
- 
PyObject *PyType_GenericNew(PyTypeObject *type, PyObject *args, PyObject *kwds)¶
- Return value: New reference. Part of the Stable ABI.Generic handler for the tp_newslot of a type object. Create a new instance using the type’stp_allocslot.
- 
int PyType_Ready(PyTypeObject *type)¶
-  Part of the Stable 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 0on success, or return-1and sets an exception on error.Note If some of the base classes implements the GC protocol and the provided type does not include the Py_TPFLAGS_HAVE_GCin its flags, then the GC protocol will be automatically implemented from its parents. On the contrary, if the type being created does includePy_TPFLAGS_HAVE_GCin its flags then it must implement the GC protocol itself by at least implementing thetp_traversehandle.
- 
PyObject *PyType_GetName(PyTypeObject *type)¶
- Return value: New reference. Part of the Stable ABI since version 3.11.Return the type’s name. Equivalent to getting the type’s __name__attribute.Added in version 3.11. 
- 
PyObject *PyType_GetQualName(PyTypeObject *type)¶
- Return value: New reference. Part of the Stable ABI since version 3.11.Return the type’s qualified name. Equivalent to getting the type’s __qualname__attribute.Added in version 3.11. 
- 
PyObject *PyType_GetFullyQualifiedName(PyTypeObject *type)¶
-  Part of the Stable ABI since version 3.13.Return the type’s fully qualified name. Equivalent to f"{type.__module__}.{type.__qualname__}", ortype.__qualname__iftype.__module__is not a string or is equal to"builtins".Added in version 3.13. 
- 
PyObject *PyType_GetModuleName(PyTypeObject *type)¶
-  Part of the Stable ABI since version 3.13.Return the type’s module name. Equivalent to getting the type.__module__attribute.Added in version 3.13. 
- 
void *PyType_GetSlot(PyTypeObject *type, int slot)¶
-  Part of the Stable 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 isNULL, or that the function was called with invalid parameters. Callers will typically cast the result pointer into the appropriate function type.See PyType_Slot.slotfor possible values of the slot argument.Added in version 3.4. Changed in version 3.10: PyType_GetSlot()can now accept all types. Previously, it was limited to heap types.
- 
PyObject *PyType_GetModule(PyTypeObject *type)¶
-  Part of the Stable 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 TypeErrorand returnsNULL.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)may be a subclass of the intended class, and subclasses are not necessarily defined in the same module as their superclass. SeePyCMethodto get the class that defines the method. SeePyType_GetModuleByDef()for cases whenPyCMethodcannot be used.Added in version 3.9. 
- 
void *PyType_GetModuleState(PyTypeObject *type)¶
-  Part of the Stable 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 ofPyType_GetModule().If no module is associated with the given type, sets TypeErrorand returnsNULL.If the type has an associated module but its state is NULL, returnsNULLwithout setting an exception.Added in version 3.9. 
- 
PyObject *PyType_GetModuleByDef(PyTypeObject *type, struct PyModuleDef *def)¶
-  Part of the Stable ABI since version 3.13.Find the first superclass whose module was created from the given PyModuleDefdef, and return that module.If no module is found, raises a TypeErrorand returnsNULL.This function is intended to be used together with PyModule_GetState()to get module state from slot methods (such astp_initornb_add) and other places where a method’s defining class cannot be passed using thePyCMethodcalling convention.Added in version 3.11. 
- 
int PyUnstable_Type_AssignVersionTag(PyTypeObject *type)¶
- This is 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. Added in version 3.12. 
Creating Heap-Allocated Types¶
The following functions and structs are used to create heap types.
- 
PyObject *PyType_FromMetaclass(PyTypeObject *metaclass, PyObject *module, PyType_Spec *spec, PyObject *bases)¶
-  Part of the Stable ABI since version 3.12.Create and return a heap type from the spec (see Py_TPFLAGS_HEAPTYPE).The metaclass metaclass is used to construct the resulting type object. When metaclass is NULL, the metaclass is derived from bases (or Py_tp_base[s] slots if bases isNULL, see below).Metaclasses that override tp_neware not supported, except iftp_newisNULL. (For backwards compatibility, otherPyType_From*functions allow such metaclasses. They ignoretp_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, the Py_tp_bases slot is used instead. If that also isNULL, the Py_tp_base slot is used instead. If that also isNULL, the new type derives fromobject.The module argument can be used to record the module in which the new class is defined. It must be a module object or NULL. If notNULL, the module is associated with the new type and can later be retrieved withPyType_GetModule(). The associated module is not inherited by subclasses; it must be specified for each class individually.This function calls PyType_Ready()on the new type.Note that this function does not fully match the behavior of calling type()or using theclassstatement. With user-provided base types or metaclasses, prefer callingtype(or the metaclass) overPyType_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.
 Added in version 3.12. 
- 
PyObject *PyType_FromModuleAndSpec(PyObject *module, PyType_Spec *spec, PyObject *bases)¶
- Return value: New reference. Part of the Stable ABI since version 3.10.Equivalent to PyType_FromMetaclass(NULL, module, spec, bases).Added in version 3.9. Changed in version 3.10: The function now accepts a single class as the bases argument and NULLas thetp_docslot.Changed in version 3.12: The function now finds and uses a metaclass corresponding to the provided base classes. Previously, only typeinstances were returned.The tp_newof the metaclass is ignored. which may result in incomplete initialization. Creating classes whose metaclass overridestp_newis deprecated and in Python 3.14+ it will be no longer allowed.
- 
PyObject *PyType_FromSpecWithBases(PyType_Spec *spec, PyObject *bases)¶
- Return value: New reference. Part of the Stable ABI since version 3.3.Equivalent to 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 typeinstances were returned.The tp_newof the metaclass is ignored. which may result in incomplete initialization. Creating classes whose metaclass overridestp_newis deprecated and in Python 3.14+ it will be no longer allowed.
- 
PyObject *PyType_FromSpec(PyType_Spec *spec)¶
- Return value: New reference. Part of the Stable ABI.Equivalent to 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 typeinstances were returned.The tp_newof the metaclass is ignored. which may result in incomplete initialization. Creating classes whose metaclass overridestp_newis deprecated and in Python 3.14+ it will be no longer allowed.
- 
type PyType_Spec¶
-  Part of the Stable 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_basicsizeshould 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. See- tp_itemsizedocumentation for caveats.- If zero, - tp_itemsizeis 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- itemsizeis only possible in the following situations:- The base is not variable-sized (its - tp_itemsize).
- The requested - PyType_Spec.basicsizeis positive, suggesting that the memory layout of the base class is known.
- The requested - PyType_Spec.basicsizeis zero, suggesting that the subclass does not access the instance’s memory directly.
- With the - Py_TPFLAGS_ITEMS_AT_ENDflag.
 
 - 
unsigned int flags¶
- Type flags, used to set - PyTypeObject.tp_flags.- If the - Py_TPFLAGS_HEAPTYPEflag is not set,- PyType_FromSpecWithBases()sets it automatically.
 - 
PyType_Slot *slots¶
- Array of - PyType_Slotstructures. Terminated by the special slot value- {0, NULL}.- Each slot ID should be specified at most once. 
 
- 
const char *name¶
- 
type PyType_Slot¶
-  Part of the Stable 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,- PyMappingMethodsand- PyAsyncMethodswith an added- Py_prefix. For example, use:- Py_tp_deallocto set- PyTypeObject.tp_dealloc
- Py_nb_addto set- PyNumberMethods.nb_add
- Py_sq_lengthto set- PySequenceMethods.sq_length
 - The following “offset” fields cannot be set using - PyType_Slot:- tp_weaklistoffset(use- Py_TPFLAGS_MANAGED_WEAKREFinstead if possible)
- tp_dictoffset(use- Py_TPFLAGS_MANAGED_DICTinstead if possible)
- tp_vectorcall_offset(use- "__vectorcalloffset__"in PyMemberDef)
 - If it is not possible to switch to a - MANAGEDflag (for example, for vectorcall or to support Python older than 3.12), specify the offset in- Py_tp_members. See PyMemberDef documentation for details.- The following fields cannot be set at all when creating a heap type: - tp_vectorcall(use- tp_newand/or- tp_init)
- Internal fields: - tp_dict,- tp_mro,- tp_cache,- tp_subclasses, and- tp_weaklist.
 - Setting - Py_tp_basesor- Py_tp_basemay be problematic on some platforms. To avoid issues, use the bases argument of- PyType_FromSpecWithBases()instead.- Changed in version 3.9: Slots in - PyBufferProcsmay be set in the unlimited API.- Changed in version 3.11: - bf_getbufferand- bf_releasebufferare 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_docmay not be- NULL.
 
- 
int slot¶