Mr.Combet Webshell 🔥

Edit File Name : type.html

<!DOCTYPE html>

<title>Type Objects &#8212; Python 3.12.3 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
 
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
 <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=bb723527" />
 <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=b20cc3f5" />
 
 <script src="../_static/documentation_options.js?v=2c828074"></script>
 <script src="../_static/doctools.js?v=888ff710"></script>
 <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
 
 <script src="../_static/sidebar.js"></script>
 
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within Python 3.12.3 documentation"
 href="../_static/opensearch.xml"/>
 <link rel="author" title="About these documents" href="../about.html" />
 <link rel="index" title="Index" href="../genindex.html" />
 <link rel="search" title="Search" href="../search.html" />
 <link rel="copyright" title="Copyright" href="../copyright.html" />
 <link rel="next" title="The None Object" href="none.html" />
 <link rel="prev" title="Concrete Objects Layer" href="concrete.html" />
 <link rel="canonical" href="https://docs.python.org/3/c-api/type.html" />

</head>
<body>
<div class="mobile-nav">
 <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"
 aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />
 <nav class="nav-content" role="navigation">
 <label for="menuToggler" class="toggler__label">
 
 </label>
 
 <a href="https://www.python.org/" class="nav-logo">
 <img src="../_static/py.svg" alt="Python logo"/>
 </a>
 
 <form role="search" class="search" action="../search.html" method="get">
 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">
 <path fill-rule="nonzero" fill="currentColor" d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"></path>
 </svg>
 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />
 <input type="submit" value="Go"/>
 </form>
 
 </nav>
 <div class="menu-wrapper">
 <nav class="menu" role="navigation" aria-label="main navigation">
 <div class="language_switcher_placeholder"></div>
 
<label class="theme-selector-label">
 Theme
 <select class="theme-selector" oninput="activateTheme(this.value)">
 <option value="auto" selected>Auto</option>
 <option value="light">Light</option>
 <option value="dark">Dark</option>
 </select>
</label>
 <div>
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#">Type Objects</a><ul>
<li><a class="reference internal" href="#creating-heap-allocated-types">Creating Heap-Allocated Types</a></li>
</ul>
</li>
</ul>

</div>
 <div>
 <h4>Previous topic</h4>
 <a href="concrete.html"
 title="previous chapter">Concrete Objects Layer</a>
 </div>
 <div>
 <h4>Next topic</h4>
 <a href="none.html"
 title="next chapter">The <code class="docutils literal notranslate">None</code> Object</a>
 </div>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../bugs.html">Report a Bug</a></li>
 <li>
 <a href="https://github.com/python/cpython/blob/main/Doc/c-api/type.rst"
 rel="nofollow">Show Source
 </a>
 </li>
 </ul>
 </div>
 </nav>
 </div>
</div>

<div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="none.html" title="The None Object"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="concrete.html" title="Concrete Objects Layer"
 accesskey="P">previous</a> |</li>

<li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li class="switchers">
 <div class="language_switcher_placeholder"></div>
 <div class="version_switcher_placeholder"></div>
 </li>
 <li>
 
 </li>
 <li id="cpython-language-and-version">
 <a href="../index.html">3.12.3 Documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >Python/C API Reference Manual</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="concrete.html" accesskey="U">Concrete Objects Layer</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">Type Objects</a></li>
 <li class="right">

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="type-objects">
<h1>Type Objects<a class="headerlink" href="#type-objects" title="Link to this heading">¶</a></h1>
<dl class="c type" id="index-0">
<dt class="sig sig-object c" id="c.PyTypeObject">
type PyTypeObject<a class="headerlink" href="#c.PyTypeObject" title="Link to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Limited API</a> (as an opaque struct).The C structure of the objects used to describe built-in types.
</dd></dl>

<dl class="c var">
<dt class="sig sig-object c" id="c.PyType_Type">
<a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> PyType_Type<a class="headerlink" href="#c.PyType_Type" title="Link to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.This is the type object for type objects; it is the same object as
<a class="reference internal" href="../library/functions.html#type" title="type"><code class="xref py py-class docutils literal notranslate">type</code></a> in the Python layer.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyType_Check">
int PyType_Check(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyType_Check" title="Link to this definition">¶</a> </dt>
<dd>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.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyType_CheckExact">
int PyType_CheckExact(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyType_CheckExact" title="Link to this definition">¶</a> </dt>
<dd>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.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyType_ClearCache">
unsigned int PyType_ClearCache()<a class="headerlink" href="#c.PyType_ClearCache" title="Link to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Clear the internal lookup cache. Return the current version tag.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyType_GetFlags">
unsigned long PyType_GetFlags(<a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *type)<a class="headerlink" href="#c.PyType_GetFlags" title="Link to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Return the <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_flags" title="PyTypeObject.tp_flags"><code class="xref c c-member docutils literal notranslate">tp_flags</code></a> member of type. This function is primarily
meant for use with <code class="docutils literal notranslate">Py_LIMITED_API</code>; the individual flag bits are
guaranteed to be stable across Python releases, but access to
<a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_flags" title="PyTypeObject.tp_flags"><code class="xref c c-member docutils literal notranslate">tp_flags</code></a> itself is not part of the <a class="reference internal" href="stable.html#limited-c-api">limited API</a>.
<div class="versionadded">
New in version 3.2.
</div>
<div class="versionchanged">
Changed in version 3.4: The return type is now <code class="docutils literal notranslate">unsigned long</code> rather than <code class="docutils literal notranslate">long</code>.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyType_GetDict">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyType_GetDict(<a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *type)<a class="headerlink" href="#c.PyType_GetDict" title="Link to this definition">¶</a> </dt>
<dd>Return the type object’s internal namespace, which is otherwise only
exposed via a read-only proxy (<code class="docutils literal notranslate">cls.__dict__</code>). This is a
replacement for accessing <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_dict" title="PyTypeObject.tp_dict"><code class="xref c c-member docutils literal notranslate">tp_dict</code></a> 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 <a class="reference internal" href="object.html#c.PyObject_GetAttr" title="PyObject_GetAttr"><code class="xref c c-func docutils literal notranslate">PyObject_GetAttr()</code></a>) isn’t adequate.
Extension modules should continue to use <code class="docutils literal notranslate">tp_dict</code>,
directly or indirectly, when setting up their own types.
<div class="versionadded">
New in version 3.12.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyType_Modified">
void PyType_Modified(<a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *type)<a class="headerlink" href="#c.PyType_Modified" title="Link to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.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.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyType_AddWatcher">
int PyType_AddWatcher(<a class="reference internal" href="#c.PyType_WatchCallback" title="PyType_WatchCallback">PyType_WatchCallback</a> callback)<a class="headerlink" href="#c.PyType_AddWatcher" title="Link to this definition">¶</a> </dt>
<dd>Register callback as a type watcher. Return a non-negative integer ID
which must be passed to future calls to <a class="reference internal" href="#c.PyType_Watch" title="PyType_Watch"><code class="xref c c-func docutils literal notranslate">PyType_Watch()</code></a>. In case of
error (e.g. no more watcher IDs available), return <code class="docutils literal notranslate">-1</code> and set an
exception.
<div class="versionadded">
New in version 3.12.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyType_ClearWatcher">
int PyType_ClearWatcher(int watcher_id)<a class="headerlink" href="#c.PyType_ClearWatcher" title="Link to this definition">¶</a> </dt>
<dd>Clear watcher identified by watcher_id (previously returned from
<a class="reference internal" href="#c.PyType_AddWatcher" title="PyType_AddWatcher"><code class="xref c c-func docutils literal notranslate">PyType_AddWatcher()</code></a>). Return <code class="docutils literal notranslate">0</code> on success, <code class="docutils literal notranslate">-1</code> on error (e.g.
if watcher_id was never registered.)
An extension should never call <code class="docutils literal notranslate">PyType_ClearWatcher</code> with a watcher_id
that was not returned to it by a previous call to
<a class="reference internal" href="#c.PyType_AddWatcher" title="PyType_AddWatcher"><code class="xref c c-func docutils literal notranslate">PyType_AddWatcher()</code></a>.
<div class="versionadded">
New in version 3.12.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyType_Watch">
int PyType_Watch(int watcher_id, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *type)<a class="headerlink" href="#c.PyType_Watch" title="Link to this definition">¶</a> </dt>
<dd>Mark type as watched. The callback granted watcher_id by
<a class="reference internal" href="#c.PyType_AddWatcher" title="PyType_AddWatcher"><code class="xref c c-func docutils literal notranslate">PyType_AddWatcher()</code></a> will be called whenever
<a class="reference internal" href="#c.PyType_Modified" title="PyType_Modified"><code class="xref c c-func docutils literal notranslate">PyType_Modified()</code></a> reports a change to type. (The callback may be
called only once for a series of consecutive modifications to type, if
<code class="xref c c-func docutils literal notranslate">_PyType_Lookup()</code> is not called on type between the modifications;
this is an implementation detail and subject to change.)
An extension should never call <code class="docutils literal notranslate">PyType_Watch</code> with a watcher_id that was
not returned to it by a previous call to <a class="reference internal" href="#c.PyType_AddWatcher" title="PyType_AddWatcher"><code class="xref c c-func docutils literal notranslate">PyType_AddWatcher()</code></a>.
<div class="versionadded">
New in version 3.12.
</div>
</dd></dl>

<dl class="c type">
<dt class="sig sig-object c" id="c.PyType_WatchCallback">
typedef int (*PyType_WatchCallback)(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *type)<a class="headerlink" href="#c.PyType_WatchCallback" title="Link to this definition">¶</a> </dt>
<dd>Type of a type-watcher callback function.
The callback must not modify type or cause <a class="reference internal" href="#c.PyType_Modified" title="PyType_Modified"><code class="xref c c-func docutils literal notranslate">PyType_Modified()</code></a> to be
called on type or any type in its MRO; violating this rule could cause
infinite recursion.
<div class="versionadded">
New in version 3.12.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyType_HasFeature">
int PyType_HasFeature(<a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *o, int feature)<a class="headerlink" href="#c.PyType_HasFeature" title="Link to this definition">¶</a> </dt>
<dd>Return non-zero if the type object o sets the feature feature.
Type features are denoted by single bit flags.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyType_IS_GC">
int PyType_IS_GC(<a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *o)<a class="headerlink" href="#c.PyType_IS_GC" title="Link to this definition">¶</a> </dt>
<dd>Return true if the type object includes support for the cycle detector; this
tests the type flag <a class="reference internal" href="typeobj.html#c.Py_TPFLAGS_HAVE_GC" title="Py_TPFLAGS_HAVE_GC"><code class="xref c c-macro docutils literal notranslate">Py_TPFLAGS_HAVE_GC</code></a>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyType_IsSubtype">
int PyType_IsSubtype(<a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *a, <a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *b)<a class="headerlink" href="#c.PyType_IsSubtype" title="Link to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Return true if a is a subtype of b.
This function only checks for actual subtypes, which means that
<a class="reference internal" href="../reference/datamodel.html#class.__subclasscheck__" title="class.__subclasscheck__"><code class="xref py py-meth docutils literal notranslate">__subclasscheck__()</code></a> is not called on b. Call
<a class="reference internal" href="object.html#c.PyObject_IsSubclass" title="PyObject_IsSubclass"><code class="xref c c-func docutils literal notranslate">PyObject_IsSubclass()</code></a> to do the same check that <a class="reference internal" href="../library/functions.html#issubclass" title="issubclass"><code class="xref py py-func docutils literal notranslate">issubclass()</code></a>
would do.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyType_GenericAlloc">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyType_GenericAlloc(<a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *type, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> nitems)<a class="headerlink" href="#c.PyType_GenericAlloc" title="Link to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Generic handler for the <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_alloc" title="PyTypeObject.tp_alloc"><code class="xref c c-member docutils literal notranslate">tp_alloc</code></a> slot of a type object. Use
Python’s default memory allocation mechanism to allocate a new instance and
initialize all its contents to <code class="docutils literal notranslate">NULL</code>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyType_GenericNew">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyType_GenericNew(<a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *type, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *args, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *kwds)<a class="headerlink" href="#c.PyType_GenericNew" title="Link to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Generic handler for the <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_new" title="PyTypeObject.tp_new"><code class="xref c c-member docutils literal notranslate">tp_new</code></a> slot of a type object. Create a
new instance using the type’s <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_alloc" title="PyTypeObject.tp_alloc"><code class="xref c c-member docutils literal notranslate">tp_alloc</code></a> slot.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyType_Ready">
int PyType_Ready(<a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *type)<a class="headerlink" href="#c.PyType_Ready" title="Link to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.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 <code class="docutils literal notranslate">0</code> on success, or return <code class="docutils literal notranslate">-1</code> and sets an
exception on error.
<div class="admonition note">
Note
If some of the base classes implements the GC protocol and the provided
type does not include the <a class="reference internal" href="typeobj.html#c.Py_TPFLAGS_HAVE_GC" title="Py_TPFLAGS_HAVE_GC"><code class="xref c c-macro docutils literal notranslate">Py_TPFLAGS_HAVE_GC</code></a> in its flags, then
the GC protocol will be automatically implemented from its parents. On
the contrary, if the type being created does include
<a class="reference internal" href="typeobj.html#c.Py_TPFLAGS_HAVE_GC" title="Py_TPFLAGS_HAVE_GC"><code class="xref c c-macro docutils literal notranslate">Py_TPFLAGS_HAVE_GC</code></a> in its flags then it must implement the
GC protocol itself by at least implementing the
<a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_traverse" title="PyTypeObject.tp_traverse"><code class="xref c c-member docutils literal notranslate">tp_traverse</code></a> handle.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyType_GetName">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyType_GetName(<a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *type)<a class="headerlink" href="#c.PyType_GetName" title="Link to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a> since version 3.11.Return the type’s name. Equivalent to getting the type’s <code class="docutils literal notranslate">__name__</code> attribute.
<div class="versionadded">
New in version 3.11.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyType_GetQualName">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyType_GetQualName(<a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *type)<a class="headerlink" href="#c.PyType_GetQualName" title="Link to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a> since version 3.11.Return the type’s qualified name. Equivalent to getting the
type’s <code class="docutils literal notranslate">__qualname__</code> attribute.
<div class="versionadded">
New in version 3.11.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyType_GetSlot">
void *PyType_GetSlot(<a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *type, int slot)<a class="headerlink" href="#c.PyType_GetSlot" title="Link to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a> since version 3.4.Return the function pointer stored in the given slot. If the
result is <code class="docutils literal notranslate">NULL</code>, this indicates that either the slot is <code class="docutils literal notranslate">NULL</code>,
or that the function was called with invalid parameters.
Callers will typically cast the result pointer into the appropriate
function type.
See <a class="reference internal" href="#c.PyType_Slot.slot" title="PyType_Slot.slot"><code class="xref c c-member docutils literal notranslate">PyType_Slot.slot</code></a> for possible values of the slot argument.
<div class="versionadded">
New in version 3.4.
</div>
<div class="versionchanged">
Changed in version 3.10: <a class="reference internal" href="#c.PyType_GetSlot" title="PyType_GetSlot"><code class="xref c c-func docutils literal notranslate">PyType_GetSlot()</code></a> can now accept all types.
Previously, it was limited to <a class="reference internal" href="typeobj.html#heap-types">heap types</a>.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyType_GetModule">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyType_GetModule(<a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *type)<a class="headerlink" href="#c.PyType_GetModule" title="Link to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a> since version 3.10.Return the module object associated with the given type when the type was
created using <a class="reference internal" href="#c.PyType_FromModuleAndSpec" title="PyType_FromModuleAndSpec"><code class="xref c c-func docutils literal notranslate">PyType_FromModuleAndSpec()</code></a>.
If no module is associated with the given type, sets <a class="reference internal" href="../library/exceptions.html#TypeError" title="TypeError"><code class="xref py py-class docutils literal notranslate">TypeError</code></a>
and returns <code class="docutils literal notranslate">NULL</code>.
This function is usually used to get the module in which a method is defined.
Note that in such a method, <code class="docutils literal notranslate">PyType_GetModule(Py_TYPE(self))</code>
may not return the intended result.
<code class="docutils literal notranslate">Py_TYPE(self)</code> may be a subclass of the intended class, and subclasses
are not necessarily defined in the same module as their superclass.
See <a class="reference internal" href="structures.html#c.PyCMethod" title="PyCMethod"><code class="xref c c-type docutils literal notranslate">PyCMethod</code></a> to get the class that defines the method.
See <a class="reference internal" href="#c.PyType_GetModuleByDef" title="PyType_GetModuleByDef"><code class="xref c c-func docutils literal notranslate">PyType_GetModuleByDef()</code></a> for cases when <code class="xref c c-type docutils literal notranslate">PyCMethod</code> cannot
be used.
<div class="versionadded">
New in version 3.9.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyType_GetModuleState">
void *PyType_GetModuleState(<a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *type)<a class="headerlink" href="#c.PyType_GetModuleState" title="Link to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a> since version 3.10.Return the state of the module object associated with the given type.
This is a shortcut for calling <a class="reference internal" href="module.html#c.PyModule_GetState" title="PyModule_GetState"><code class="xref c c-func docutils literal notranslate">PyModule_GetState()</code></a> on the result
of <a class="reference internal" href="#c.PyType_GetModule" title="PyType_GetModule"><code class="xref c c-func docutils literal notranslate">PyType_GetModule()</code></a>.
If no module is associated with the given type, sets <a class="reference internal" href="../library/exceptions.html#TypeError" title="TypeError"><code class="xref py py-class docutils literal notranslate">TypeError</code></a>
and returns <code class="docutils literal notranslate">NULL</code>.
If the type has an associated module but its state is <code class="docutils literal notranslate">NULL</code>,
returns <code class="docutils literal notranslate">NULL</code> without setting an exception.
<div class="versionadded">
New in version 3.9.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyType_GetModuleByDef">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyType_GetModuleByDef(<a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *type, struct <a class="reference internal" href="module.html#c.PyModuleDef" title="PyModuleDef">PyModuleDef</a> *def)<a class="headerlink" href="#c.PyType_GetModuleByDef" title="Link to this definition">¶</a> </dt>
<dd>Find the first superclass whose module was created from
the given <a class="reference internal" href="module.html#c.PyModuleDef" title="PyModuleDef"><code class="xref c c-type docutils literal notranslate">PyModuleDef</code></a> def, and return that module.
If no module is found, raises a <a class="reference internal" href="../library/exceptions.html#TypeError" title="TypeError"><code class="xref py py-class docutils literal notranslate">TypeError</code></a> and returns <code class="docutils literal notranslate">NULL</code>.
This function is intended to be used together with
<a class="reference internal" href="module.html#c.PyModule_GetState" title="PyModule_GetState"><code class="xref c c-func docutils literal notranslate">PyModule_GetState()</code></a> to get module state from slot methods (such as
<a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_init" title="PyTypeObject.tp_init"><code class="xref c c-member docutils literal notranslate">tp_init</code></a> or <a class="reference internal" href="typeobj.html#c.PyNumberMethods.nb_add" title="PyNumberMethods.nb_add"><code class="xref c c-member docutils literal notranslate">nb_add</code></a>)
and other places where a method’s defining class cannot be passed using the
<a class="reference internal" href="structures.html#c.PyCMethod" title="PyCMethod"><code class="xref c c-type docutils literal notranslate">PyCMethod</code></a> calling convention.
<div class="versionadded">
New in version 3.11.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnstable_Type_AssignVersionTag">
int PyUnstable_Type_AssignVersionTag(<a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *type)<a class="headerlink" href="#c.PyUnstable_Type_AssignVersionTag" title="Link to this definition">¶</a> </dt>
<dd><div class="unstable-c-api warning admonition">
This is <a class="reference internal" href="stable.html#unstable-c-api">Unstable API</a>. It may change without warning in minor releases.</div>
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.
<div class="versionadded">
New in version 3.12.
</div>
</dd></dl>

<section id="creating-heap-allocated-types">
<h2>Creating Heap-Allocated Types<a class="headerlink" href="#creating-heap-allocated-types" title="Link to this heading">¶</a></h2>
The following functions and structs are used to create
<a class="reference internal" href="typeobj.html#heap-types">heap types</a>.
<dl class="c function">
<dt class="sig sig-object c" id="c.PyType_FromMetaclass">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyType_FromMetaclass(<a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *metaclass, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *module, <a class="reference internal" href="#c.PyType_Spec" title="PyType_Spec">PyType_Spec</a> *spec, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *bases)<a class="headerlink" href="#c.PyType_FromMetaclass" title="Link to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a> since version 3.12.Create and return a <a class="reference internal" href="typeobj.html#heap-types">heap type</a> from the spec
(see <a class="reference internal" href="typeobj.html#c.Py_TPFLAGS_HEAPTYPE" title="Py_TPFLAGS_HEAPTYPE"><code class="xref c c-macro docutils literal notranslate">Py_TPFLAGS_HEAPTYPE</code></a>).
The metaclass metaclass is used to construct the resulting type object.
When metaclass is <code class="docutils literal notranslate">NULL</code>, the metaclass is derived from bases
(or Py_tp_base[s] slots if bases is <code class="docutils literal notranslate">NULL</code>, see below).
Metaclasses that override <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_new" title="PyTypeObject.tp_new"><code class="xref c c-member docutils literal notranslate">tp_new</code></a> are not
supported, except if <code class="docutils literal notranslate">tp_new</code> is <code class="docutils literal notranslate">NULL</code>.
(For backwards compatibility, other <code class="docutils literal notranslate">PyType_From*</code> functions allow
such metaclasses. They ignore <code class="docutils literal notranslate">tp_new</code>, 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 <code class="docutils literal notranslate">NULL</code>, the Py_tp_bases slot is used instead.
If that also is <code class="docutils literal notranslate">NULL</code>, the Py_tp_base slot is used instead.
If that also is <code class="docutils literal notranslate">NULL</code>, the new type derives from <a class="reference internal" href="../library/functions.html#object" title="object"><code class="xref py py-class docutils literal notranslate">object</code></a>.
The module argument can be used to record the module in which the new
class is defined. It must be a module object or <code class="docutils literal notranslate">NULL</code>.
If not <code class="docutils literal notranslate">NULL</code>, the module is associated with the new type and can later be
retrieved with <a class="reference internal" href="#c.PyType_GetModule" title="PyType_GetModule"><code class="xref c c-func docutils literal notranslate">PyType_GetModule()</code></a>.
The associated module is not inherited by subclasses; it must be specified
for each class individually.
This function calls <a class="reference internal" href="#c.PyType_Ready" title="PyType_Ready"><code class="xref c c-func docutils literal notranslate">PyType_Ready()</code></a> on the new type.
Note that this function does not fully match the behavior of
calling <a class="reference internal" href="../library/functions.html#type" title="type"><code class="xref py py-class docutils literal notranslate">type()</code></a> or using the <a class="reference internal" href="../reference/compound_stmts.html#class"><code class="xref std std-keyword docutils literal notranslate">class</code></a> statement.
With user-provided base types or metaclasses, prefer
<a class="reference internal" href="call.html#capi-call">calling</a> <a class="reference internal" href="../library/functions.html#type" title="type"><code class="xref py py-class docutils literal notranslate">type</code></a> (or the metaclass)
over <code class="docutils literal notranslate">PyType_From*</code> functions.
Specifically:
<ul class="simple">
<li><a class="reference internal" href="../reference/datamodel.html#object.__new__" title="object.__new__"><code class="xref py py-meth docutils literal notranslate">__new__()</code></a> is not called on the new class
(and it must be set to <code class="docutils literal notranslate">type.__new__</code>).</li>
<li><a class="reference internal" href="../reference/datamodel.html#object.__init__" title="object.__init__"><code class="xref py py-meth docutils literal notranslate">__init__()</code></a> is not called on the new class.</li>
<li><a class="reference internal" href="../reference/datamodel.html#object.__init_subclass__" title="object.__init_subclass__"><code class="xref py py-meth docutils literal notranslate">__init_subclass__()</code></a> is not called on any bases.</li>
<li><a class="reference internal" href="../reference/datamodel.html#object.__set_name__" title="object.__set_name__"><code class="xref py py-meth docutils literal notranslate">__set_name__()</code></a> is not called on new descriptors.</li>
</ul>
<div class="versionadded">
New in version 3.12.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyType_FromModuleAndSpec">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyType_FromModuleAndSpec(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *module, <a class="reference internal" href="#c.PyType_Spec" title="PyType_Spec">PyType_Spec</a> *spec, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *bases)<a class="headerlink" href="#c.PyType_FromModuleAndSpec" title="Link to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a> since version 3.10.Equivalent to <code class="docutils literal notranslate">PyType_FromMetaclass(NULL, module, spec, bases)</code>.
<div class="versionadded">
New in version 3.9.
</div>
<div class="versionchanged">
Changed in version 3.10: The function now accepts a single class as the bases argument and
<code class="docutils literal notranslate">NULL</code> as the <code class="docutils literal notranslate">tp_doc</code> slot.
</div>
<div class="versionchanged">
Changed in version 3.12: The function now finds and uses a metaclass corresponding to the provided
base classes. Previously, only <a class="reference internal" href="../library/functions.html#type" title="type"><code class="xref py py-class docutils literal notranslate">type</code></a> instances were returned.
The <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_new" title="PyTypeObject.tp_new"><code class="xref c c-member docutils literal notranslate">tp_new</code></a> of the metaclass is ignored.
which may result in incomplete initialization.
Creating classes whose metaclass overrides
<a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_new" title="PyTypeObject.tp_new"><code class="xref c c-member docutils literal notranslate">tp_new</code></a> is deprecated and in Python 3.14+ it
will be no longer allowed.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyType_FromSpecWithBases">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyType_FromSpecWithBases(<a class="reference internal" href="#c.PyType_Spec" title="PyType_Spec">PyType_Spec</a> *spec, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *bases)<a class="headerlink" href="#c.PyType_FromSpecWithBases" title="Link to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a> since version 3.3.Equivalent to <code class="docutils literal notranslate">PyType_FromMetaclass(NULL, NULL, spec, bases)</code>.
<div class="versionadded">
New in version 3.3.
</div>
<div class="versionchanged">
Changed in version 3.12: The function now finds and uses a metaclass corresponding to the provided
base classes. Previously, only <a class="reference internal" href="../library/functions.html#type" title="type"><code class="xref py py-class docutils literal notranslate">type</code></a> instances were returned.
The <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_new" title="PyTypeObject.tp_new"><code class="xref c c-member docutils literal notranslate">tp_new</code></a> of the metaclass is ignored.
which may result in incomplete initialization.
Creating classes whose metaclass overrides
<a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_new" title="PyTypeObject.tp_new"><code class="xref c c-member docutils literal notranslate">tp_new</code></a> is deprecated and in Python 3.14+ it
will be no longer allowed.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyType_FromSpec">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyType_FromSpec(<a class="reference internal" href="#c.PyType_Spec" title="PyType_Spec">PyType_Spec</a> *spec)<a class="headerlink" href="#c.PyType_FromSpec" title="Link to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Equivalent to <code class="docutils literal notranslate">PyType_FromMetaclass(NULL, NULL, spec, NULL)</code>.
<div class="versionchanged">
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 <a class="reference internal" href="../library/functions.html#type" title="type"><code class="xref py py-class docutils literal notranslate">type</code></a> instances were returned.
The <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_new" title="PyTypeObject.tp_new"><code class="xref c c-member docutils literal notranslate">tp_new</code></a> of the metaclass is ignored.
which may result in incomplete initialization.
Creating classes whose metaclass overrides
<a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_new" title="PyTypeObject.tp_new"><code class="xref c c-member docutils literal notranslate">tp_new</code></a> is deprecated and in Python 3.14+ it
will be no longer allowed.
</div>
</dd></dl>

<dl class="c type">
<dt class="sig sig-object c" id="c.PyType_Spec">
type PyType_Spec<a class="headerlink" href="#c.PyType_Spec" title="Link to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a> (including all members).Structure defining a type’s behavior.
<dl class="c member">
<dt class="sig sig-object c" id="c.PyType_Spec.name">
const char *name<a class="headerlink" href="#c.PyType_Spec.name" title="Link to this definition">¶</a> </dt>
<dd>Name of the type, used to set <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_name" title="PyTypeObject.tp_name"><code class="xref c c-member docutils literal notranslate">PyTypeObject.tp_name</code></a>.
</dd></dl>

<dl class="c member">
<dt class="sig sig-object c" id="c.PyType_Spec.basicsize">
int basicsize<a class="headerlink" href="#c.PyType_Spec.basicsize" title="Link to this definition">¶</a> </dt>
<dd>If positive, specifies the size of the instance in bytes.
It is used to set <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_basicsize" title="PyTypeObject.tp_basicsize"><code class="xref c c-member docutils literal notranslate">PyTypeObject.tp_basicsize</code></a>.
If zero, specifies that <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_basicsize" title="PyTypeObject.tp_basicsize"><code class="xref c c-member docutils literal notranslate">tp_basicsize</code></a>
should be inherited.
If negative, the absolute value specifies how much space instances of the
class need in addition to the superclass.
Use <a class="reference internal" href="object.html#c.PyObject_GetTypeData" title="PyObject_GetTypeData"><code class="xref c c-func docutils literal notranslate">PyObject_GetTypeData()</code></a> to get a pointer to subclass-specific
memory reserved this way.
<div class="versionchanged">
Changed in version 3.12: Previously, this field could not be negative.
</div>
</dd></dl>

<dl class="c member">
<dt class="sig sig-object c" id="c.PyType_Spec.itemsize">
int itemsize<a class="headerlink" href="#c.PyType_Spec.itemsize" title="Link to this definition">¶</a> </dt>
<dd>Size of one element of a variable-size type, in bytes.
Used to set <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_itemsize" title="PyTypeObject.tp_itemsize"><code class="xref c c-member docutils literal notranslate">PyTypeObject.tp_itemsize</code></a>.
See <code class="docutils literal notranslate">tp_itemsize</code> documentation for caveats.
If zero, <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_itemsize" title="PyTypeObject.tp_itemsize"><code class="xref c c-member docutils literal notranslate">tp_itemsize</code></a> 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 <code class="docutils literal notranslate">itemsize</code> is only possible
in the following situations:
<ul class="simple">
<li>The base is not variable-sized (its
<a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_itemsize" title="PyTypeObject.tp_itemsize"><code class="xref c c-member docutils literal notranslate">tp_itemsize</code></a>).</li>
<li>The requested <a class="reference internal" href="#c.PyType_Spec.basicsize" title="PyType_Spec.basicsize"><code class="xref c c-member docutils literal notranslate">PyType_Spec.basicsize</code></a> is positive,
suggesting that the memory layout of the base class is known.</li>
<li>The requested <a class="reference internal" href="#c.PyType_Spec.basicsize" title="PyType_Spec.basicsize"><code class="xref c c-member docutils literal notranslate">PyType_Spec.basicsize</code></a> is zero,
suggesting that the subclass does not access the instance’s memory
directly.</li>
<li>With the <a class="reference internal" href="typeobj.html#c.Py_TPFLAGS_ITEMS_AT_END" title="Py_TPFLAGS_ITEMS_AT_END"><code class="xref c c-macro docutils literal notranslate">Py_TPFLAGS_ITEMS_AT_END</code></a> flag.</li>
</ul>
</dd></dl>

<dl class="c member">
<dt class="sig sig-object c" id="c.PyType_Spec.flags">
unsigned int flags<a class="headerlink" href="#c.PyType_Spec.flags" title="Link to this definition">¶</a> </dt>
<dd>Type flags, used to set <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_flags" title="PyTypeObject.tp_flags"><code class="xref c c-member docutils literal notranslate">PyTypeObject.tp_flags</code></a>.
If the <code class="docutils literal notranslate">Py_TPFLAGS_HEAPTYPE</code> flag is not set,
<a class="reference internal" href="#c.PyType_FromSpecWithBases" title="PyType_FromSpecWithBases"><code class="xref c c-func docutils literal notranslate">PyType_FromSpecWithBases()</code></a> sets it automatically.
</dd></dl>

<dl class="c member">
<dt class="sig sig-object c" id="c.PyType_Spec.slots">
<a class="reference internal" href="#c.PyType_Slot" title="PyType_Slot">PyType_Slot</a> *slots<a class="headerlink" href="#c.PyType_Spec.slots" title="Link to this definition">¶</a> </dt>
<dd>Array of <a class="reference internal" href="#c.PyType_Slot" title="PyType_Slot"><code class="xref c c-type docutils literal notranslate">PyType_Slot</code></a> structures.
Terminated by the special slot value <code class="docutils literal notranslate">{0, NULL}</code>.
Each slot ID should be specified at most once.
</dd></dl>

</dd></dl>

<dl class="c type">
<dt class="sig sig-object c" id="c.PyType_Slot">
type PyType_Slot<a class="headerlink" href="#c.PyType_Slot" title="Link to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a> (including all members).Structure defining optional functionality of a type, containing a slot ID
and a value pointer.
<dl class="c member">
<dt class="sig sig-object c" id="c.PyType_Slot.slot">
int slot<a class="headerlink" href="#c.PyType_Slot.slot" title="Link to this definition">¶</a> </dt>
<dd><blockquote>
<div>A slot ID.
Slot IDs are named like the field names of the structures
<a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject"><code class="xref c c-type docutils literal notranslate">PyTypeObject</code></a>, <a class="reference internal" href="typeobj.html#c.PyNumberMethods" title="PyNumberMethods"><code class="xref c c-type docutils literal notranslate">PyNumberMethods</code></a>,
<a class="reference internal" href="typeobj.html#c.PySequenceMethods" title="PySequenceMethods"><code class="xref c c-type docutils literal notranslate">PySequenceMethods</code></a>, <a class="reference internal" href="typeobj.html#c.PyMappingMethods" title="PyMappingMethods"><code class="xref c c-type docutils literal notranslate">PyMappingMethods</code></a> and
<a class="reference internal" href="typeobj.html#c.PyAsyncMethods" title="PyAsyncMethods"><code class="xref c c-type docutils literal notranslate">PyAsyncMethods</code></a> with an added <code class="docutils literal notranslate">Py_</code> prefix.
For example, use:
<ul class="simple">
<li><code class="docutils literal notranslate">Py_tp_dealloc</code> to set <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_dealloc" title="PyTypeObject.tp_dealloc"><code class="xref c c-member docutils literal notranslate">PyTypeObject.tp_dealloc</code></a></li>
<li><code class="docutils literal notranslate">Py_nb_add</code> to set <a class="reference internal" href="typeobj.html#c.PyNumberMethods.nb_add" title="PyNumberMethods.nb_add"><code class="xref c c-member docutils literal notranslate">PyNumberMethods.nb_add</code></a></li>
<li><code class="docutils literal notranslate">Py_sq_length</code> to set <a class="reference internal" href="typeobj.html#c.PySequenceMethods.sq_length" title="PySequenceMethods.sq_length"><code class="xref c c-member docutils literal notranslate">PySequenceMethods.sq_length</code></a></li>
</ul>
The following “offset” fields cannot be set using <a class="reference internal" href="#c.PyType_Slot" title="PyType_Slot"><code class="xref c c-type docutils literal notranslate">PyType_Slot</code></a>:
<blockquote>
<div><ul class="simple">
<li><a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_weaklistoffset" title="PyTypeObject.tp_weaklistoffset"><code class="xref c c-member docutils literal notranslate">tp_weaklistoffset</code></a>
(use <a class="reference internal" href="typeobj.html#c.Py_TPFLAGS_MANAGED_WEAKREF" title="Py_TPFLAGS_MANAGED_WEAKREF"><code class="xref c c-macro docutils literal notranslate">Py_TPFLAGS_MANAGED_WEAKREF</code></a> instead if possible)</li>
<li><a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_dictoffset" title="PyTypeObject.tp_dictoffset"><code class="xref c c-member docutils literal notranslate">tp_dictoffset</code></a>
(use <a class="reference internal" href="typeobj.html#c.Py_TPFLAGS_MANAGED_DICT" title="Py_TPFLAGS_MANAGED_DICT"><code class="xref c c-macro docutils literal notranslate">Py_TPFLAGS_MANAGED_DICT</code></a> instead if possible)</li>
<li><a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_vectorcall_offset" title="PyTypeObject.tp_vectorcall_offset"><code class="xref c c-member docutils literal notranslate">tp_vectorcall_offset</code></a>
(use <code class="docutils literal notranslate">&quot;__vectorcalloffset__&quot;</code> in
<a class="reference internal" href="structures.html#pymemberdef-offsets">PyMemberDef</a>)</li>
</ul>
If it is not possible to switch to a <code class="docutils literal notranslate">MANAGED</code> flag (for example,
for vectorcall or to support Python older than 3.12), specify the
offset in <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_members" title="PyTypeObject.tp_members"><code class="xref c c-member docutils literal notranslate">Py_tp_members</code></a>.
See <a class="reference internal" href="structures.html#pymemberdef-offsets">PyMemberDef documentation</a>
for details.
</div></blockquote>
The following fields cannot be set at all when creating a heap type:
<ul class="simple">
<li><a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_vectorcall" title="PyTypeObject.tp_vectorcall"><code class="xref c c-member docutils literal notranslate">tp_vectorcall</code></a>
(use <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_new" title="PyTypeObject.tp_new"><code class="xref c c-member docutils literal notranslate">tp_new</code></a> and/or
<a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_init" title="PyTypeObject.tp_init"><code class="xref c c-member docutils literal notranslate">tp_init</code></a>)</li>
<li>Internal fields:
<a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_dict" title="PyTypeObject.tp_dict"><code class="xref c c-member docutils literal notranslate">tp_dict</code></a>,
<a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_mro" title="PyTypeObject.tp_mro"><code class="xref c c-member docutils literal notranslate">tp_mro</code></a>,
<a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_cache" title="PyTypeObject.tp_cache"><code class="xref c c-member docutils literal notranslate">tp_cache</code></a>,
<a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_subclasses" title="PyTypeObject.tp_subclasses"><code class="xref c c-member docutils literal notranslate">tp_subclasses</code></a>, and
<a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_weaklist" title="PyTypeObject.tp_weaklist"><code class="xref c c-member docutils literal notranslate">tp_weaklist</code></a>.</li>
</ul>
Setting <code class="xref c c-data docutils literal notranslate">Py_tp_bases</code> or <code class="xref c c-data docutils literal notranslate">Py_tp_base</code> may be
problematic on some platforms.
To avoid issues, use the bases argument of
<a class="reference internal" href="#c.PyType_FromSpecWithBases" title="PyType_FromSpecWithBases"><code class="xref c c-func docutils literal notranslate">PyType_FromSpecWithBases()</code></a> instead.
</div></blockquote>
<div class="versionchanged">
Changed in version 3.9: Slots in <a class="reference internal" href="typeobj.html#c.PyBufferProcs" title="PyBufferProcs"><code class="xref c c-type docutils literal notranslate">PyBufferProcs</code></a> may be set in the unlimited API.
</div>
<div class="versionchanged">
Changed in version 3.11: <a class="reference internal" href="typeobj.html#c.PyBufferProcs.bf_getbuffer" title="PyBufferProcs.bf_getbuffer"><code class="xref c c-member docutils literal notranslate">bf_getbuffer</code></a> and
<a class="reference internal" href="typeobj.html#c.PyBufferProcs.bf_releasebuffer" title="PyBufferProcs.bf_releasebuffer"><code class="xref c c-member docutils literal notranslate">bf_releasebuffer</code></a> are now available
under the <a class="reference internal" href="stable.html#limited-c-api">limited API</a>.
</div>
</dd></dl>

<dl class="c member">
<dt class="sig sig-object c" id="c.PyType_Slot.pfunc">
void *pfunc<a class="headerlink" href="#c.PyType_Slot.pfunc" title="Link to this definition">¶</a> </dt>
<dd>The desired value of the slot. In most cases, this is a pointer
to a function.
Slots other than <code class="docutils literal notranslate">Py_tp_doc</code> may not be <code class="docutils literal notranslate">NULL</code>.
</dd></dl>

</dd></dl>

</section>
</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <div>
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#">Type Objects</a><ul>
<li><a class="reference internal" href="#creating-heap-allocated-types">Creating Heap-Allocated Types</a></li>
</ul>
</li>
</ul>

</div>
 <div class="clearer"></div>
 </div> 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="none.html" title="The None Object"
 >next</a> |</li>
 <li class="right" >
 <a href="concrete.html" title="Concrete Objects Layer"
 >previous</a> |</li>

<li class="nav-item nav-item-1"><a href="index.html" >Python/C API Reference Manual</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="concrete.html" >Concrete Objects Layer</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">Type Objects</a></li>
 <li class="right">

<div class="inline-search" role="search">
 <form class="inline-search" action="../search.html" method="get">
 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />
 <input type="submit" value="Go" />
 </form>
 </div>
 |
 </li>
 <li class="right">
<label class="theme-selector-label">
 Theme
 <select class="theme-selector" oninput="activateTheme(this.value)">
 <option value="auto" selected>Auto</option>
 <option value="light">Light</option>
 <option value="dark">Dark</option>
 </select>
</label> |</li>
 
 </ul>
 </div> 
 <div class="footer">
 &copy; 
 <a href="../copyright.html">
 
 Copyright
 
 </a>
 2001-2024, Python Software Foundation.
 
 This page is licensed under the Python Software Foundation License Version 2.
 
 Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
 
 
 See <a href="/license.html">History and License</a> for more information.

The Python Software Foundation is a non-profit corporation.
<a href="https://www.python.org/psf/donations/">Please donate.</a>
 
 
 Last updated on Apr 09, 2024 (13:47 UTC).
 
 <a href="/bugs.html">Found a bug</a>?

Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
 </div>

</body>
</html>