| Server IP : 121.121.20.254 / Your IP : 216.73.217.51 Web Server : Microsoft-IIS/10.0 System : Windows NT WEB-SERVER 10.0 build 20348 (Windows Server 2022) AMD64 User : IUSR ( 0) PHP Version : 8.3.28 Disable Function : NONE MySQL : ON | cURL : ON | WGET : OFF | Perl : OFF | Python : OFF | Sudo : OFF | Pkexec : OFF Directory : C:/Python315/Doc/html/c-api/ |
Upload File : |
<!DOCTYPE html>
<html lang="en" data-content_root="../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta property="og:title" content="Defining extension modules" />
<meta property="og:type" content="website" />
<meta property="og:url" content="https://docs.python.org/3/c-api/extension-modules.html" />
<meta property="og:site_name" content="Python documentation" />
<meta property="og:description" content="A C extension for CPython is a shared library (for example, a.so file on Linux,.pyd DLL on Windows), which is loadable into the Python process (for example, it is compiled with compatible compiler ..." />
<meta property="og:image" content="_static/og-image.png" />
<meta property="og:image:alt" content="Python documentation" />
<meta name="description" content="A C extension for CPython is a shared library (for example, a.so file on Linux,.pyd DLL on Windows), which is loadable into the Python process (for example, it is compiled with compatible compiler ..." />
<meta name="theme-color" content="#3776ab">
<meta property="og:image:width" content="200">
<meta property="og:image:height" content="200">
<title>Defining extension modules — Python 3.15.0rc1 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../_static/classic.css?v=234b1a7c" />
<link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=4365c8fe" />
<link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=0fc419ee" />
<script src="../_static/documentation_options.js?v=791e38b1"></script>
<script src="../_static/doctools.js?v=9bcbadda"></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.15.0rc1 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="Definition slots" href="slots.html" />
<link rel="prev" title="Exception Handling" href="exceptions.html" />
<link rel="canonical" href="https://docs.python.org/3/c-api/extension-modules.html">
<style>
@media only screen {
table.full-width-table {
width: 100%;
}
}
</style>
<link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">
<link rel="shortcut icon" type="image/png" href="../_static/py.svg">
<script type="text/javascript" src="../_static/copybutton.js"></script>
<script type="text/javascript" src="../_static/menu.js"></script>
<script type="text/javascript" src="../_static/search-focus.js"></script>
<script type="text/javascript" src="../_static/themetoggle.js"></script>
<script type="text/javascript" src="../_static/rtd_switcher.js"></script>
<meta name="readthedocs-addons-api-version" content="1">
</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">
<span></span>
</label>
<span class="nav-items-wrapper">
<a href="https://www.python.org/" class="nav-logo">
<img src="../_static/py.svg" alt="Python logo">
</a>
<span class="version_switcher_placeholder"></span>
<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>
</span>
</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="#">Defining extension modules</a><ul>
<li><a class="reference internal" href="#extension-export-hook">Extension export hook</a></li>
<li><a class="reference internal" href="#multi-phase-initialization">Multi-phase initialization</a></li>
<li><a class="reference internal" href="#multiple-module-instances">Multiple module instances</a></li>
<li><a class="reference internal" href="#pyinit-function"><code class="docutils literal notranslate"><span class="pre">PyInit</span></code> function</a><ul>
<li><a class="reference internal" href="#legacy-single-phase-initialization">Legacy single-phase initialization</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="exceptions.html"
title="previous chapter">Exception Handling</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="slots.html"
title="next chapter">Definition slots</a></p>
</div>
<script>
document.addEventListener('DOMContentLoaded', () => {
const title = document.querySelector('meta[property="og:title"]').content;
const elements = document.querySelectorAll('.improvepage');
const pageurl = window.location.href.split('?')[0];
elements.forEach(element => {
const url = new URL(element.href.split('?')[0].replace("-nojs", ""));
url.searchParams.set('pagetitle', title);
url.searchParams.set('pageurl', pageurl);
url.searchParams.set('pagesource', "c-api/extension-modules.rst");
element.href = url.toString();
});
});
</script>
<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 class="improvepage" href="../improve-page-nojs.html">Improve this page</a></li>
<li>
<a href="https://github.com/python/cpython/blob/main/Doc/c-api/extension-modules.rst?plain=1"
rel="nofollow">Show source
</a>
</li>
</ul>
</div>
</nav>
</div>
</div>
<div class="related" role="navigation" aria-label="Related">
<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="slots.html" title="Definition slots"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="exceptions.html" title="Exception Handling"
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> »</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.15.0rc1 Documentation</a> »
</li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Python/C API reference manual</a> »</li>
<li class="nav-item nav-item-this"><a href="">Defining extension modules</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="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="defining-extension-modules">
<span id="extension-modules"></span><h1>Defining extension modules<a class="headerlink" href="#defining-extension-modules" title="Link to this heading">¶</a></h1>
<p>A C extension for CPython is a shared library (for example, a <code class="docutils literal notranslate"><span class="pre">.so</span></code> file
on Linux, <code class="docutils literal notranslate"><span class="pre">.pyd</span></code> DLL on Windows), which is loadable into the Python process
(for example, it is compiled with compatible compiler settings), and which
exports an <em class="dfn">export hook</em> function (or an
old-style <a class="reference internal" href="#extension-pyinit"><span class="std std-ref">initialization function</span></a>).</p>
<p>To be importable by default (that is, by
<a class="reference internal" href="../library/importlib.html#importlib.machinery.ExtensionFileLoader" title="importlib.machinery.ExtensionFileLoader"><code class="xref py py-class docutils literal notranslate"><span class="pre">importlib.machinery.ExtensionFileLoader</span></code></a>),
the shared library must be available on <a class="reference internal" href="../library/sys.html#sys.path" title="sys.path"><code class="xref py py-attr docutils literal notranslate"><span class="pre">sys.path</span></code></a>,
and must be named after the module name plus an extension listed in
<a class="reference internal" href="../library/importlib.html#importlib.machinery.EXTENSION_SUFFIXES" title="importlib.machinery.EXTENSION_SUFFIXES"><code class="xref py py-attr docutils literal notranslate"><span class="pre">importlib.machinery.EXTENSION_SUFFIXES</span></code></a>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Building, packaging and distributing extension modules is best done with
third-party tools, and is out of scope of this document.
One suitable tool is Setuptools, whose documentation can be found at
<a class="reference external" href="https://setuptools.pypa.io/en/latest/setuptools.html">https://setuptools.pypa.io/en/latest/setuptools.html</a>.</p>
</div>
<section id="extension-export-hook">
<span id="id1"></span><h2>Extension export hook<a class="headerlink" href="#extension-export-hook" title="Link to this heading">¶</a></h2>
<div class="versionadded">
<p><span class="versionmodified added">Added in version 3.15: </span>Support for the <code class="samp docutils literal notranslate"><span class="pre">PyModExport_</span><em><span class="pre"><name></span></em></code> export hook was added in Python
3.15. The older way of defining modules is still available: consult either
the <a class="reference internal" href="#extension-pyinit"><span class="std std-ref">PyInit function</span></a> section or earlier versions of this
documentation if you plan to support earlier Python versions.</p>
</div>
<p>The export hook must be an exported function with the following signature:</p>
<dl class="c function">
<dt class="sig sig-object c" id="c.PyModExport_modulename">
<a class="reference internal" href="slots.html#c.PySlot" title="PySlot"><span class="n"><span class="pre">PySlot</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">PyModExport_modulename</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">void</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyModExport_modulename" title="Link to this definition">¶</a><br /></dt>
<dd></dd></dl>
<p>For modules with ASCII-only names, the <a class="reference internal" href="#extension-export-hook"><span class="std std-ref">export hook</span></a>
must be named <code class="samp docutils literal notranslate"><span class="pre">PyModExport_</span><em><span class="pre"><name></span></em></code>,
with <code class="docutils literal notranslate"><span class="pre"><name></span></code> replaced by the module’s name.</p>
<p>For non-ASCII module names, the export hook must instead be named
<code class="samp docutils literal notranslate"><span class="pre">PyModExportU_</span><em><span class="pre"><name></span></em></code> (note the <code class="docutils literal notranslate"><span class="pre">U</span></code>), with <code class="docutils literal notranslate"><span class="pre"><name></span></code> encoded using
Python’s <em>punycode</em> encoding with hyphens replaced by underscores. In Python:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">def</span><span class="w"> </span><span class="nf">hook_name</span><span class="p">(</span><span class="n">name</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">suffix</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">'_'</span> <span class="o">+</span> <span class="n">name</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'ascii'</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">UnicodeEncodeError</span><span class="p">:</span>
<span class="n">suffix</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">'U_'</span> <span class="o">+</span> <span class="n">name</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'punycode'</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="sa">b</span><span class="s1">'-'</span><span class="p">,</span> <span class="sa">b</span><span class="s1">'_'</span><span class="p">)</span>
<span class="k">return</span> <span class="sa">b</span><span class="s1">'PyModExport'</span> <span class="o">+</span> <span class="n">suffix</span>
</pre></div>
</div>
<p>The export hook returns an array of <a class="reference internal" href="slots.html#c.PySlot" title="PySlot"><code class="xref c c-type docutils literal notranslate"><span class="pre">PySlot</span></code></a> entries,
terminated by an entry with a slot ID of <code class="docutils literal notranslate"><span class="pre">0</span></code>.
These slots describe how the module should be created and initialized.</p>
<p>This array must remain valid and constant until interpreter shutdown.
Typically, it should use <code class="docutils literal notranslate"><span class="pre">static</span></code> storage.
Prefer using the <a class="reference internal" href="module.html#c.Py_mod_create" title="Py_mod_create"><code class="xref c c-macro docutils literal notranslate"><span class="pre">Py_mod_create</span></code></a> and <a class="reference internal" href="module.html#c.Py_mod_exec" title="Py_mod_exec"><code class="xref c c-macro docutils literal notranslate"><span class="pre">Py_mod_exec</span></code></a> slots
for any dynamic behavior.</p>
<p>The export hook may return <code class="docutils literal notranslate"><span class="pre">NULL</span></code> with an exception set to signal failure.</p>
<p>It is recommended to define the export hook function using a helper macro:</p>
<dl class="c macro">
<dt class="sig sig-object c" id="c.PyMODEXPORT_FUNC">
<span class="sig-name descname"><span class="n"><span class="pre">PyMODEXPORT_FUNC</span></span></span><a class="headerlink" href="#c.PyMODEXPORT_FUNC" title="Link to this definition">¶</a><br /></dt>
<dd><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a> since version 3.15.</em><p>Declare an extension module export hook.
This macro:</p>
<ul class="simple">
<li><p>specifies the <span class="c-expr sig sig-inline c"><a class="reference internal" href="slots.html#c.PySlot" title="PySlot"><span class="n">PySlot</span></a><span class="p">*</span></span> return type,</p></li>
<li><p>adds any special linkage declarations required by the platform, and</p></li>
<li><p>for C++, declares the function as <code class="docutils literal notranslate"><span class="pre">extern</span> <span class="pre">"C"</span></code>.</p></li>
</ul>
</dd></dl>
<p>For example, a module called <code class="docutils literal notranslate"><span class="pre">spam</span></code> would be defined like this:</p>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="n">PyABIInfo_VAR</span><span class="p">(</span><span class="n">abi_info</span><span class="p">);</span>
<span class="k">static</span><span class="w"> </span><span class="n">PySlot</span><span class="w"> </span><span class="n">spam_slots</span><span class="p">[]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="n">PySlot_STATIC_DATA</span><span class="p">(</span><span class="n">Py_mod_abi</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="n">abi_info</span><span class="p">),</span>
<span class="w"> </span><span class="n">PySlot_STATIC_DATA</span><span class="p">(</span><span class="n">Py_mod_name</span><span class="p">,</span><span class="w"> </span><span class="s">"spam"</span><span class="p">),</span>
<span class="w"> </span><span class="n">PySlot_FUNC</span><span class="p">(</span><span class="n">Py_mod_init</span><span class="p">,</span><span class="w"> </span><span class="n">spam_init_function</span><span class="p">),</span>
<span class="w"> </span><span class="p">...</span>
<span class="w"> </span><span class="n">PySlot_END</span>
<span class="p">};</span>
<span class="n">PyMODEXPORT_FUNC</span>
<span class="nf">PyModExport_spam</span><span class="p">(</span><span class="kt">void</span><span class="p">)</span>
<span class="p">{</span>
<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="n">spam_slots</span><span class="p">;</span>
<span class="p">}</span>
</pre></div>
</div>
<p>The export hook is typically the only non-<code class="docutils literal notranslate"><span class="pre">static</span></code>
item defined in the module’s C source.</p>
<p id="pymodexport-api-caveats">The hook should be kept short.
If it does more than <code class="docutils literal notranslate"><span class="pre">return</span></code> a static array, several caveats apply:</p>
<ul class="simple">
<li><p>If you need to use any Python C API, it is recommended to call
<a class="reference internal" href="stable.html#c.PyABIInfo_Check" title="PyABIInfo_Check"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyABIInfo_Check()</span></code></a> first to raise an exception,
rather than crash, in common cases of ABI mismatch.</p></li>
<li><p>Code in the export hook must never rely on the <a class="reference internal" href="../glossary.html#term-GIL"><span class="xref std std-term">GIL</span></a>:
<a class="reference internal" href="../glossary.html#term-free-threaded-build"><span class="xref std std-term">free-threaded builds</span></a> of Python can only check
the <a class="reference internal" href="module.html#c.Py_mod_gil" title="Py_mod_gil"><code class="xref c c-macro docutils literal notranslate"><span class="pre">Py_mod_gil</span></code></a> slot (or the lack of it) after the hook returns,</p></li>
<li><p>Similarly, the hook may be called in any subinterpreter, since the
<a class="reference internal" href="module.html#c.Py_mod_multiple_interpreters" title="Py_mod_multiple_interpreters"><code class="xref c c-macro docutils literal notranslate"><span class="pre">Py_mod_multiple_interpreters</span></code></a> slot (or lack of it)
is only checked after the hook returns.</p></li>
</ul>
<p>For example:</p>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="n">PyMODEXPORT_FUNC</span>
<span class="nf">PyModExport_modulename</span><span class="p">(</span><span class="kt">void</span><span class="p">)</span>
<span class="p">{</span>
<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">PyABIInfo_Check</span><span class="p">(</span><span class="o">&</span><span class="n">abi_info</span><span class="p">,</span><span class="w"> </span><span class="s">"modulename"</span><span class="p">)</span><span class="w"> </span><span class="o"><</span><span class="w"> </span><span class="mi">0</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="cm">/* ABI mismatch. It's not safe to examine the raised exception. */</span>
<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="nb">NULL</span><span class="p">;</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="cm">/* use Python API (as little as possible); don't rely on GIL */</span>
<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="n">modulename_slots</span><span class="p">;</span>
<span class="p">}</span>
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>It is possible to export multiple modules from a single shared library by
defining multiple export hooks.
However, importing them requires a custom importer or suitably named
copies/links of the extension file, because Python’s import machinery only
finds the function corresponding to the filename.
See the <a class="reference external" href="https://peps.python.org/pep-0489/#multiple-modules-in-one-library">Multiple modules in one library</a>
section in <span class="target" id="index-0"></span><a class="pep reference external" href="https://peps.python.org/pep-0489/"><strong>PEP 489</strong></a> for details.</p>
</div>
</section>
<section id="multi-phase-initialization">
<span id="id2"></span><h2>Multi-phase initialization<a class="headerlink" href="#multi-phase-initialization" title="Link to this heading">¶</a></h2>
<p>The process of creating an extension module follows several phases:</p>
<ul class="simple">
<li><p>Python finds and calls the export hook to get information on how to
create the module.</p></li>
<li><p>Before any substantial code is executed, Python can determine which
capabilities the module supports, and it can adjust the environment or
refuse loading an incompatible extension.
Slots like <a class="reference internal" href="module.html#c.Py_mod_abi" title="Py_mod_abi"><code class="xref c c-data docutils literal notranslate"><span class="pre">Py_mod_abi</span></code></a>, <a class="reference internal" href="module.html#c.Py_mod_gil" title="Py_mod_gil"><code class="xref c c-data docutils literal notranslate"><span class="pre">Py_mod_gil</span></code></a> and
<a class="reference internal" href="module.html#c.Py_mod_multiple_interpreters" title="Py_mod_multiple_interpreters"><code class="xref c c-data docutils literal notranslate"><span class="pre">Py_mod_multiple_interpreters</span></code></a> influence this step.</p></li>
<li><p>By default, Python itself then creates the module object – that is, it does
the equivalent of calling <a class="reference internal" href="../reference/datamodel.html#object.__new__" title="object.__new__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__new__()</span></code></a> when creating an object.
This step can be overridden using the <a class="reference internal" href="module.html#c.Py_mod_create" title="Py_mod_create"><code class="xref c c-data docutils literal notranslate"><span class="pre">Py_mod_create</span></code></a> slot.</p></li>
<li><p>Python sets initial module attributes like <a class="reference internal" href="../reference/datamodel.html#module.__package__" title="module.__package__"><code class="xref py py-attr docutils literal notranslate"><span class="pre">__package__</span></code></a> and
<a class="reference internal" href="../reference/datamodel.html#module.__loader__" title="module.__loader__"><code class="xref py py-attr docutils literal notranslate"><span class="pre">__loader__</span></code></a>, and inserts the module object into
<a class="reference internal" href="../library/sys.html#sys.modules" title="sys.modules"><code class="xref py py-attr docutils literal notranslate"><span class="pre">sys.modules</span></code></a>.</p></li>
<li><p>Afterwards, the module object is initialized in an extension-specific way
– the equivalent of <a class="reference internal" href="../reference/datamodel.html#object.__init__" title="object.__init__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__init__()</span></code></a> when creating an object,
or of executing top-level code in a Python-language module.
The behavior is specified using the <a class="reference internal" href="module.html#c.Py_mod_exec" title="Py_mod_exec"><code class="xref c c-data docutils literal notranslate"><span class="pre">Py_mod_exec</span></code></a> slot.</p></li>
</ul>
<p>This is called <em>multi-phase initialization</em> to distinguish it from the legacy
(but still supported) <a class="reference internal" href="#single-phase-initialization"><span class="std std-ref">single-phase initialization</span></a>,
where an initialization function returns a fully constructed module.</p>
<div class="versionchanged">
<p><span class="versionmodified changed">Changed in version 3.5: </span>Added support for multi-phase initialization (<span class="target" id="index-1"></span><a class="pep reference external" href="https://peps.python.org/pep-0489/"><strong>PEP 489</strong></a>).</p>
</div>
</section>
<section id="multiple-module-instances">
<h2>Multiple module instances<a class="headerlink" href="#multiple-module-instances" title="Link to this heading">¶</a></h2>
<p>By default, extension modules are not singletons.
For example, if the <a class="reference internal" href="../library/sys.html#sys.modules" title="sys.modules"><code class="xref py py-attr docutils literal notranslate"><span class="pre">sys.modules</span></code></a> entry is removed and the module
is re-imported, a new module object is created and, typically, populated with
fresh method and type objects.
The old module is subject to normal garbage collection.
This mirrors the behavior of pure-Python modules.</p>
<p>Additional module instances may be created in
<a class="reference internal" href="subinterpreters.html#sub-interpreter-support"><span class="std std-ref">sub-interpreters</span></a>
or after Python runtime reinitialization
(<a class="reference internal" href="interp-lifecycle.html#c.Py_Finalize" title="Py_Finalize"><code class="xref c c-func docutils literal notranslate"><span class="pre">Py_Finalize()</span></code></a> and <a class="reference internal" href="interp-lifecycle.html#c.Py_Initialize" title="Py_Initialize"><code class="xref c c-func docutils literal notranslate"><span class="pre">Py_Initialize()</span></code></a>).
In these cases, sharing Python objects between module instances would likely
cause crashes or undefined behavior.</p>
<p>To avoid such issues, each instance of an extension module should
be <em>isolated</em>: changes to one instance should not implicitly affect the others,
and all state owned by the module, including references to Python objects,
should be specific to a particular module instance.
See <a class="reference internal" href="../howto/isolating-extensions.html#isolating-extensions-howto"><span class="std std-ref">Isolating Extension Modules</span></a> for more details and a practical guide.</p>
<p>A simpler way to avoid these issues is
<a class="reference internal" href="../howto/isolating-extensions.html#isolating-extensions-optout"><span class="std std-ref">raising an error on repeated initialization</span></a>.</p>
<p>All modules are expected to support
<a class="reference internal" href="subinterpreters.html#sub-interpreter-support"><span class="std std-ref">sub-interpreters</span></a>, or otherwise explicitly
signal a lack of support.
This is usually achieved by isolation or blocking repeated initialization,
as above.
A module may also be limited to the main interpreter using
the <a class="reference internal" href="module.html#c.Py_mod_multiple_interpreters" title="Py_mod_multiple_interpreters"><code class="xref c c-data docutils literal notranslate"><span class="pre">Py_mod_multiple_interpreters</span></code></a> slot.</p>
</section>
<section id="pyinit-function">
<span id="extension-pyinit"></span><h2><code class="docutils literal notranslate"><span class="pre">PyInit</span></code> function<a class="headerlink" href="#pyinit-function" title="Link to this heading">¶</a></h2>
<div class="versionchanged soft-deprecated">
<p><span class="versionmodified soft-deprecated"><a class="reference internal" href="../glossary.html#term-soft-deprecated">Soft deprecated</a> since version 3.15: </span>This functionality will not get new features,
but there are no plans to remove it.</p>
</div>
<p>Instead of <a class="reference internal" href="#c.PyModExport_modulename" title="PyModExport_modulename"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyModExport_modulename()</span></code></a>, an extension module can define
an older-style <em class="dfn">initialization function</em> with the signature:</p>
<dl class="c function">
<dt class="sig sig-object c" id="c.PyInit_modulename">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">PyInit_modulename</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">void</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyInit_modulename" title="Link to this definition">¶</a><br /></dt>
<dd></dd></dl>
<p>Its name should be <code class="samp docutils literal notranslate"><span class="pre">PyInit_</span><em><span class="pre"><name></span></em></code>, with <code class="docutils literal notranslate"><span class="pre"><name></span></code> replaced by the
name of the module.
For non-ASCII module names, use <code class="samp docutils literal notranslate"><span class="pre">PyInitU_</span><em><span class="pre"><name></span></em></code> instead, with
<code class="docutils literal notranslate"><span class="pre"><name></span></code> encoded in the same way as for the
<a class="reference internal" href="#extension-export-hook"><span class="std std-ref">export hook</span></a> (that is, using Punycode
with underscores).</p>
<p>If a module exports both <code class="samp docutils literal notranslate"><span class="pre">PyInit_</span><em><span class="pre"><name></span></em></code> and
<code class="samp docutils literal notranslate"><span class="pre">PyModExport_</span><em><span class="pre"><name></span></em></code>, the <code class="samp docutils literal notranslate"><span class="pre">PyInit_</span><em><span class="pre"><name></span></em></code> function
is ignored.</p>
<p>Like with <a class="reference internal" href="#c.PyMODEXPORT_FUNC" title="PyMODEXPORT_FUNC"><code class="xref c c-macro docutils literal notranslate"><span class="pre">PyMODEXPORT_FUNC</span></code></a>, it is recommended to define the
initialization function using a helper macro:</p>
<dl class="c macro">
<dt class="sig sig-object c" id="c.PyMODINIT_FUNC">
<span class="sig-name descname"><span class="n"><span class="pre">PyMODINIT_FUNC</span></span></span><a class="headerlink" href="#c.PyMODINIT_FUNC" title="Link to this definition">¶</a><br /></dt>
<dd><p>Declare an extension module initialization function.
This macro:</p>
<ul class="simple">
<li><p>specifies the <span class="c-expr sig sig-inline c"><a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n">PyObject</span></a><span class="p">*</span></span> return type,</p></li>
<li><p>adds any special linkage declarations required by the platform, and</p></li>
<li><p>for C++, declares the function as <code class="docutils literal notranslate"><span class="pre">extern</span> <span class="pre">"C"</span></code>.</p></li>
</ul>
</dd></dl>
<p>Normally, the initialization function (<code class="docutils literal notranslate"><span class="pre">PyInit_modulename</span></code>) returns
a <a class="reference internal" href="module.html#c.PyModuleDef" title="PyModuleDef"><code class="xref c c-type docutils literal notranslate"><span class="pre">PyModuleDef</span></code></a> instance with non-<code class="docutils literal notranslate"><span class="pre">NULL</span></code>
<a class="reference internal" href="module.html#c.PyModuleDef.m_slots" title="PyModuleDef.m_slots"><code class="xref c c-member docutils literal notranslate"><span class="pre">m_slots</span></code></a>. This allows Python to use
<a class="reference internal" href="#multi-phase-initialization"><span class="std std-ref">multi-phase initialization</span></a>.</p>
<p>Before it is returned, the <code class="docutils literal notranslate"><span class="pre">PyModuleDef</span></code> instance must be initialized
using the following function:</p>
<dl class="c function">
<dt class="sig sig-object c" id="c.PyModuleDef_Init">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">PyModuleDef_Init</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="module.html#c.PyModuleDef" title="PyModuleDef"><span class="n"><span class="pre">PyModuleDef</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">def</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyModuleDef_Init" title="Link to this definition">¶</a><br /></dt>
<dd><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a> since version 3.5.</em><p>Ensure a module definition is a properly initialized Python object that
correctly reports its type and a reference count.</p>
<p>Return <em>def</em> cast to <code class="docutils literal notranslate"><span class="pre">PyObject*</span></code>, or <code class="docutils literal notranslate"><span class="pre">NULL</span></code> if an error occurred.</p>
<p>Calling this function is required before returning a <a class="reference internal" href="module.html#c.PyModuleDef" title="PyModuleDef"><code class="xref c c-type docutils literal notranslate"><span class="pre">PyModuleDef</span></code></a>
from a module initialization function.
It should not be used in other contexts.</p>
<p>Note that Python assumes that <code class="docutils literal notranslate"><span class="pre">PyModuleDef</span></code> structures are statically
allocated.
This function may return either a new reference or a borrowed one;
this reference must not be released.</p>
<div class="versionadded">
<p><span class="versionmodified added">Added in version 3.5.</span></p>
</div>
</dd></dl>
<p>For example, a module called <code class="docutils literal notranslate"><span class="pre">spam</span></code> would be defined like this:</p>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="k">static</span><span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="nc">PyModuleDef</span><span class="w"> </span><span class="n">spam_module</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="p">.</span><span class="n">m_base</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">PyModuleDef_HEAD_INIT</span><span class="p">,</span>
<span class="w"> </span><span class="p">.</span><span class="n">m_name</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"spam"</span><span class="p">,</span>
<span class="w"> </span><span class="p">...</span>
<span class="p">};</span>
<span class="n">PyMODINIT_FUNC</span>
<span class="nf">PyInit_spam</span><span class="p">(</span><span class="kt">void</span><span class="p">)</span>
<span class="p">{</span>
<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="n">PyModuleDef_Init</span><span class="p">(</span><span class="o">&</span><span class="n">spam_module</span><span class="p">);</span>
<span class="p">}</span>
</pre></div>
</div>
<section id="legacy-single-phase-initialization">
<span id="single-phase-initialization"></span><h3>Legacy single-phase initialization<a class="headerlink" href="#legacy-single-phase-initialization" title="Link to this heading">¶</a></h3>
<div class="versionchanged soft-deprecated">
<p><span class="versionmodified soft-deprecated"><a class="reference internal" href="../glossary.html#term-soft-deprecated">Soft deprecated</a> since version 3.15: </span>Single-phase initialization is a legacy mechanism to initialize extension
modules, with known drawbacks and design flaws. Extension module authors
are encouraged to use multi-phase initialization instead.</p>
<p>However, there are no plans to remove support for it.</p>
</div>
<p>In single-phase initialization, the old-style
<a class="reference internal" href="#extension-pyinit"><span class="std std-ref">initialization function</span></a> (<code class="docutils literal notranslate"><span class="pre">PyInit_modulename</span></code>)
should create, populate and return a module object.
This is typically done using <a class="reference internal" href="module.html#c.PyModule_Create" title="PyModule_Create"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyModule_Create()</span></code></a> and functions like
<a class="reference internal" href="module.html#c.PyModule_AddObjectRef" title="PyModule_AddObjectRef"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyModule_AddObjectRef()</span></code></a>.</p>
<p>Single-phase initialization differs from the <a class="reference internal" href="#multi-phase-initialization"><span class="std std-ref">default</span></a>
in the following ways:</p>
<ul>
<li><p>Single-phase modules are, or rather <em>contain</em>, “singletons”.</p>
<p>When the module is first initialized, Python saves the contents of
the module’s <code class="docutils literal notranslate"><span class="pre">__dict__</span></code> (that is, typically, the module’s functions and
types).</p>
<p>For subsequent imports, Python does not call the initialization function
again.
Instead, it creates a new module object with a new <code class="docutils literal notranslate"><span class="pre">__dict__</span></code>, and copies
the saved contents to it.
For example, given a single-phase module <code class="docutils literal notranslate"><span class="pre">_testsinglephase</span></code>
<a class="footnote-reference brackets" href="#testsinglephase" id="id3" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a> that defines a function <code class="docutils literal notranslate"><span class="pre">sum</span></code> and an exception class
<code class="docutils literal notranslate"><span class="pre">error</span></code>:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span><span class="w"> </span><span class="nn">sys</span>
<span class="gp">>>> </span><span class="kn">import</span><span class="w"> </span><span class="nn">_testsinglephase</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">one</span>
<span class="gp">>>> </span><span class="k">del</span> <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="s1">'_testsinglephase'</span><span class="p">]</span>
<span class="gp">>>> </span><span class="kn">import</span><span class="w"> </span><span class="nn">_testsinglephase</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">two</span>
<span class="gp">>>> </span><span class="n">one</span> <span class="ow">is</span> <span class="n">two</span>
<span class="go">False</span>
<span class="gp">>>> </span><span class="n">one</span><span class="o">.</span><span class="vm">__dict__</span> <span class="ow">is</span> <span class="n">two</span><span class="o">.</span><span class="vm">__dict__</span>
<span class="go">False</span>
<span class="gp">>>> </span><span class="n">one</span><span class="o">.</span><span class="n">sum</span> <span class="ow">is</span> <span class="n">two</span><span class="o">.</span><span class="n">sum</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="n">one</span><span class="o">.</span><span class="n">error</span> <span class="ow">is</span> <span class="n">two</span><span class="o">.</span><span class="n">error</span>
<span class="go">True</span>
</pre></div>
</div>
<p>The exact behavior should be considered a CPython implementation detail.</p>
</li>
<li><p>To work around the fact that <code class="docutils literal notranslate"><span class="pre">PyInit_modulename</span></code> does not take a <em>spec</em>
argument, some state of the import machinery is saved and applied to the
first suitable module created during the <code class="docutils literal notranslate"><span class="pre">PyInit_modulename</span></code> call.
Specifically, when a sub-module is imported, this mechanism prepends the
parent package name to the name of the module.</p>
<p>A single-phase <code class="docutils literal notranslate"><span class="pre">PyInit_modulename</span></code> function should create “its” module
object as soon as possible, before any other module objects can be created.</p>
</li>
<li><p>Non-ASCII module names (<code class="docutils literal notranslate"><span class="pre">PyInitU_modulename</span></code>) are not supported.</p></li>
<li><p>Single-phase modules support module lookup functions like
<a class="reference internal" href="module.html#c.PyState_FindModule" title="PyState_FindModule"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyState_FindModule()</span></code></a>.</p></li>
<li><p>The module’s <a class="reference internal" href="module.html#c.PyModuleDef.m_slots" title="PyModuleDef.m_slots"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyModuleDef.m_slots</span></code></a> must be NULL.</p></li>
</ul>
<aside class="footnote-list brackets">
<aside class="footnote brackets" id="testsinglephase" role="doc-footnote">
<span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id3">1</a><span class="fn-bracket">]</span></span>
<p><code class="docutils literal notranslate"><span class="pre">_testsinglephase</span></code> is an internal module used
in CPython’s self-test suite; your installation may or may not
include it.</p>
</aside>
</aside>
</section>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<div>
<h3><a href="../contents.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Defining extension modules</a><ul>
<li><a class="reference internal" href="#extension-export-hook">Extension export hook</a></li>
<li><a class="reference internal" href="#multi-phase-initialization">Multi-phase initialization</a></li>
<li><a class="reference internal" href="#multiple-module-instances">Multiple module instances</a></li>
<li><a class="reference internal" href="#pyinit-function"><code class="docutils literal notranslate"><span class="pre">PyInit</span></code> function</a><ul>
<li><a class="reference internal" href="#legacy-single-phase-initialization">Legacy single-phase initialization</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="exceptions.html"
title="previous chapter">Exception Handling</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="slots.html"
title="next chapter">Definition slots</a></p>
</div>
<script>
document.addEventListener('DOMContentLoaded', () => {
const title = document.querySelector('meta[property="og:title"]').content;
const elements = document.querySelectorAll('.improvepage');
const pageurl = window.location.href.split('?')[0];
elements.forEach(element => {
const url = new URL(element.href.split('?')[0].replace("-nojs", ""));
url.searchParams.set('pagetitle', title);
url.searchParams.set('pageurl', pageurl);
url.searchParams.set('pagesource', "c-api/extension-modules.rst");
element.href = url.toString();
});
});
</script>
<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 class="improvepage" href="../improve-page-nojs.html">Improve this page</a></li>
<li>
<a href="https://github.com/python/cpython/blob/main/Doc/c-api/extension-modules.rst?plain=1"
rel="nofollow">Show source
</a>
</li>
</ul>
</div>
</div>
<div id="sidebarbutton" title="Collapse sidebar">
<span>«</span>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="Related">
<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="slots.html" title="Definition slots"
>next</a> |</li>
<li class="right" >
<a href="exceptions.html" title="Exception Handling"
>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> »</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.15.0rc1 Documentation</a> »
</li>
<li class="nav-item nav-item-1"><a href="index.html" >Python/C API reference manual</a> »</li>
<li class="nav-item nav-item-this"><a href="">Defining extension modules</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">
© <a href="../copyright.html">Copyright</a> 2001 Python Software Foundation.
<br>
This page is licensed under the Python Software Foundation License Version 2.
<br>
Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
<br>
See <a href="/license.html">History and License</a> for more information.<br>
<br>
The Python Software Foundation is a non-profit corporation.
<a href="https://www.python.org/psf/donations/">Please donate.</a>
<br>
<br>
Last updated on Aug 04, 2026 (11:13 UTC).
<a href="/bugs.html">Found a bug</a>?
<br>
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
</div>
</body>
</html>