PyTypeObject
The C structure of the objects used to describe built-in types.
PyType_Type
This is the type object for type objects; it is the same object as
in the Python layer.
int PyType_Check(
*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(
*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()
Clear the internal lookup cache. Return the current version tag.
unsigned long PyType_GetFlags(
* type)
Return the
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
itself is not part of the limited API.
New in version 3.2.
Changed in version 3.4: The return type is now unsignedlong rather than long.
void PyType_Modified(
*type)
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_HasFeature(
*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(
*o)
Return true if the type object includes support for the cycle detector; this tests the type flag
.
int PyType_IsSubtype(
*a,
*b)
Return true if a is a subtype of b.
This function only checks for actual subtypes, which means that
is not called on b. Call
to do the same check that
would do.
* PyType_GenericAlloc(
*type,
nitems)
Return value: New reference.Generic handler for the
slot of a type object. Use Python’s default memory allocation mechanism to allocate a new instance and initialize all its contents to NULL.
* PyType_GenericNew(
*type,
*args,
*kwds)
Return value: New reference.Generic handler for the
slot of a type object. Create a new instance using the type’s
slot.
int PyType_Ready(
*type)
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.
Note
If some of the base classes implements the GC protocol and the provided type does not include the
in its flags, then the GC protocol will be automatically implemented from its parents. On the contrary, if the type being created does include
in its flags then it must implement the GC protocol itself by at least implementing the
handle.
void* PyType_GetSlot(
*type, int slot)
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.
See PyType_Slot.slot for possible values of the slot argument.
An exception is raised if type is not a heap type.
New in version 3.4.
* PyType_GetModule(
*type)
Return the module object associated with the given type when the type was created using
.
If no module is associated with the given type, sets
and returns 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) may be a subclass of the intended class, and subclasses are not necessarily defined in the same module as their superclass. See
to get the class that defines the method.
New in version 3.9.
void* PyType_GetModuleState(
*type)
Return the state of the module object associated with the given type. This is a shortcut for calling
on the result of
.
If no module is associated with the given type, sets
and returns NULL.
If the type has an associated module but its state is NULL, returns NULL without setting an exception.
New in version 3.9.
Creating Heap-Allocated Types
The following functions and structs are used to create
.
* PyType_FromModuleAndSpec(
*module,
*spec,
*bases)
Return value: New reference.Creates and returns a heap type object from the spec (
).
If bases is a tuple, the created heap type contains all types contained in it as base types.
If bases is NULL, the Py_tp_bases slot is used instead. If that also is NULL, the Py_tp_base slot is used instead. If that also is NULL, the new type derives from
.
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 not NULL, the module is associated with the new type and can later be retrieved with
. The associated module is not inherited by subclasses; it must be specified for each class individually.
This function calls
on the new type.
New in version 3.9.
* PyType_FromSpecWithBases(
*spec,
*bases)
Return value: New reference.Equivalent to PyType_FromModuleAndSpec(NULL,spec,bases).
New in version 3.3.
* PyType_FromSpec(
*spec)
Return value: New reference.Equivalent to PyType_FromSpecWithBases(spec,NULL).
PyType_Spec
Structure defining a type’s behavior.
const char* PyType_Spec.name
Name of the type, used to set
.
int PyType_Spec.basicsize
int PyType_Spec.itemsize
Size of the instance in bytes, used to set
and
.
int PyType_Spec.flags
Type flags, used to set
.
If the Py_TPFLAGS_HEAPTYPE flag is not set,
sets it automatically.
*PyType_Spec.slots
Array of
structures. Terminated by the special slot value {0,NULL}.
PyType_Slot
Structure defining optional functionality of a type, containing a slot ID and a value pointer.
int PyType_Slot.slot
Changed in version 3.9: Slots in
may be set in the unlimited API.
void *PyType_Slot.pfunc
The desired value of the slot. In most cases, this is a pointer to a function.
May not be NULL.