型別物件¶

type PyTypeObject¶

為 穩定 ABI 的一部分 （做為一個不透明結構 (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 in 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()¶

為 穩定 ABI 的一部分.

Clear the internal lookup cache. Return the current version tag.

unsigned long PyType_GetFlags(PyTypeObject *type)¶

為 穩定 ABI 的一部分.

Return the 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.

在 3.2 版被加入.

在 3.4 版的變更: The return type is now unsigned long rather than 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)¶

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 -1 and set an exception.

In free-threaded builds, PyType_AddWatcher() is not thread-safe, so it must be called at start up (before spawning the first thread).

在 3.12 版被加入.

int PyType_ClearWatcher(int watcher_id)¶

Clear watcher identified by watcher_id (previously returned from PyType_AddWatcher()). Return 0 on success, -1 on error (e.g. if watcher_id was never registered.)

An extension should never call PyType_ClearWatcher with a 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, if _PyType_Lookup() is not called on type between the modifications; this is an implementation detail and subject to change.)

The callback is also invoked when a watched heap type is deallocated.

An extension should never call PyType_Watch with a watcher_id that was not returned to it by a previous call to PyType_AddWatcher().

在 3.12 版被加入.

在 3.15 版的變更: The callback is now also invoked when a watched heap type is deallocated.

int PyType_Unwatch(int watcher_id, PyObject *type)¶

Mark type as not watched. This undoes a previous call to PyType_Watch(). type must not be NULL.

An extension should never call this function with a watcher_id that was not returned to it by a previous call to PyType_AddWatcher().

成功時此函式會回傳 0。失敗時此函式回傳 -1 並設定例外。

在 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.

The callback may be called during type deallocation. In this case, the type object is temporarily resurrected (its reference count is at least 1) and all its attributes are still valid. However, the callback should not store new strong references to the type, as this would resurrect the object and prevent its deallocation.

在 3.12 版被加入.

在 3.15 版的變更: The callback may now be called during deallocation of a watched heap type.

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_FastSubclass(PyTypeObject *type, int flag)¶

Return non-zero if the type object type sets the subclass flag flag. Subclass flags are denoted by Py_TPFLAGS_*_SUBCLASS. This function is used by many _Check functions for common types.

也參考

PyObject_TypeCheck(), which is used as a slower alternative in _Check functions for types that don't come with subclass 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 的一部分.

如果 a 是 b 的子類別則回傳 true。

This function only checks for actual subtypes, which means that __subclasscheck__() is not called on b. Call 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. Uses Python's default memory allocation mechanism to allocate memory for a new instance, zeros the memory, then initializes the memory as if by calling PyObject_Init() or PyObject_InitVar().

Do not call this directly to allocate memory for an object; call the type's tp_alloc slot instead.

For types that support garbage collection (i.e., the Py_TPFLAGS_HAVE_GC flag is set), this function behaves like PyObject_GC_New or PyObject_GC_NewVar (except the memory is guaranteed to be zeroed before initialization), and should be paired with PyObject_GC_Del() in tp_free. Otherwise, it behaves like PyObject_New or PyObject_NewVar (except the memory is guaranteed to be zeroed before initialization) and should be paired with PyObject_Free() in tp_free.

PyObject *PyType_GenericNew(PyTypeObject *type, PyObject *args, PyObject *kwds)¶

回傳值：新的參照。 為 穩定 ABI 的一部分.

Generic handler for the tp_new slot of a type object. Creates a new instance using the type's tp_alloc slot and returns the resulting object.

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 handle.

PyObject *PyType_GetName(PyTypeObject *type)¶

回傳值：新的參照。 為 穩定 ABI 的一部分 自 3.11 版本開始.

Return the type's name. Equivalent to getting the type's __name__ attribute.

在 3.11 版被加入.

PyObject *PyType_GetQualName(PyTypeObject *type)¶

回傳值：新的參照。 為 穩定 ABI 的一部分 自 3.11 版本開始.

Return the type's qualified name. Equivalent to getting the type's __qualname__ attribute.

在 3.11 版被加入.

PyObject *PyType_GetFullyQualifiedName(PyTypeObject *type)¶

為 穩定 ABI 的一部分 自 3.13 版本開始.

Return the type's fully qualified name. Equivalent to f"{type.__module__}.{type.__qualname__}", or type.__qualname__ if type.__module__ is not a string or is equal to "builtins".

在 3.13 版被加入.

PyObject *PyType_GetModuleName(PyTypeObject *type)¶

為 穩定 ABI 的一部分 自 3.13 版本開始.

Return the type's module name. Equivalent to getting the type.__module__ attribute.

在 3.13 版被加入.

void *PyType_GetSlot(PyTypeObject *type, int slot)¶

為 穩定 ABI 的一部分 自 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.

See PyType_Slot.slot for possible values of the slot argument.

在 3.4 版被加入.

在 3.10 版的變更: PyType_GetSlot() can now accept all types. Previously, it was limited to heap types.

PyObject *PyType_GetModule(PyTypeObject *type)¶

回傳值：借用參照。 為 穩定 ABI 的一部分 自 3.10 版本開始.

Return the module object associated with the given type when the type was created using PyType_FromModuleAndSpec().

The returned reference is borrowed from type, and will be valid as long as you hold a reference to type. Do not release it with Py_DECREF() or similar.

If no module is associated with the given type, sets TypeError 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 PyCMethod to get the class that defines the method. See PyType_GetModuleByToken() for cases when PyCMethod cannot be used.

在 3.9 版被加入.

void *PyType_GetModuleState(PyTypeObject *type)¶

為 穩定 ABI 的一部分 自 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 and returns NULL.

If the type has an associated module but its state is NULL, returns NULL without setting an exception.

在 3.9 版被加入.

PyObject *PyType_GetModuleByToken(PyTypeObject *type, const void *mod_token)¶

回傳值：新的參照。 為 穩定 ABI 的一部分 自 3.15 版本開始.

Find the first superclass whose module has the given module token, and return that module.

If no module is found, raises a TypeError and returns 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 calling convention.

在 3.15 版被加入.

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

回傳值：借用參照。 為 穩定 ABI 的一部分 自 3.13 版本開始.

Find the first superclass whose module was created from the given PyModuleDef def, or whose module token is equal to def, and return that module.

Note that modules created from a PyModuleDef always have their token set to the PyModuleDef's address. In other words, this function is equivalent to PyType_GetModuleByToken(), except that it:

• returns a borrowed reference, and

• has a non-void* argument type (which is a cosmetic difference in C).

The returned reference is borrowed from type, and will be valid as long as you hold a reference to type. Do not release it with Py_DECREF() or similar.

在 3.11 版被加入.

int PyType_GetBaseByToken(PyTypeObject *type, void *tp_token, PyTypeObject **result)¶

為 穩定 ABI 的一部分 自 3.14 版本開始.

Find the first superclass in type's method resolution order whose Py_tp_token token is equal to tp_token.

• If found, set *result to a new strong reference to it and return 1.

• 如果沒找到，則將 *result 設為 NULL 並回傳 0。

• 在發生錯誤時，將 *result 設為 NULL 並回傳 -1，同時設定例外。

如果 result 引數為 NULL，則不會設定 *result。如果你只需要回傳值，請使用此選項。

The tp_token argument may not be NULL.

在 3.14 版被加入.

int PyUnstable_Type_AssignVersionTag(PyTypeObject *type)¶

這是 不穩定 API，它可能在小版本發布中沒有任何警告地被變更。

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 版被加入.

int PyType_SUPPORTS_WEAKREFS(PyTypeObject *type)¶

Return true if instances of type support creating weak references, false otherwise. This function always succeeds. type must not be NULL.

也參考

• 弱參照物件

• weakref