Baoding-FenShuaJiang
/
Green_GoodERP18_FSJ_Standard
Segui 1
Vota 0
Wiki 捐赠
gooderp18绿色标准版
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Albero (Tree): 0f75e31513
Rami (Branch) Tag
${ item.name }
Crea branch ${ searchTerm }
da '0f75e31513'
${ noResults }
Green_GoodERP18_FSJ_Standard/python/Doc/html/c-api/module.html

1029 lines
102KB
Originale Blame Cronologia 

  1. <!DOCTYPE html>

  2. 

  3. <html lang="en" data-content_root="../">

  4.   <head>

  5.     <meta charset="utf-8" />

  6.     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  7. <meta property="og:title" content="Module Objects" />

  8. <meta property="og:type" content="website" />

  9. <meta property="og:url" content="https://docs.python.org/3/c-api/module.html" />

  10. <meta property="og:site_name" content="Python documentation" />

  11. <meta property="og:description" content="Initializing C modules: Modules objects are usually created from extension modules (shared libraries which export an initialization function), or compiled-in modules (where the initialization funct..." />

  12. <meta property="og:image" content="https://docs.python.org/3/_static/og-image.png" />

  13. <meta property="og:image:alt" content="Python documentation" />

  14. <meta name="description" content="Initializing C modules: Modules objects are usually created from extension modules (shared libraries which export an initialization function), or compiled-in modules (where the initialization funct..." />

  15. <meta property="og:image:width" content="200" />

  16. <meta property="og:image:height" content="200" />

  17. <meta name="theme-color" content="#3776ab" />

  18. 

  19.     <title>Module Objects &#8212; Python 3.12.3 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">

  20.     

  21.     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />

  22.     <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=bb723527" />

  23.     <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=b20cc3f5" />

  24.     

  25.     <script src="../_static/documentation_options.js?v=2c828074"></script>

  26.     <script src="../_static/doctools.js?v=888ff710"></script>

  27.     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>

  28.     

  29.     <script src="../_static/sidebar.js"></script>

  30.     

  31.     <link rel="search" type="application/opensearchdescription+xml"

  32.           title="Search within Python 3.12.3 documentation"

  33.           href="../_static/opensearch.xml"/>

  34.     <link rel="author" title="About these documents" href="../about.html" />

  35.     <link rel="index" title="Index" href="../genindex.html" />

  36.     <link rel="search" title="Search" href="../search.html" />

  37.     <link rel="copyright" title="Copyright" href="../copyright.html" />

  38.     <link rel="next" title="Iterator Objects" href="iterator.html" />

  39.     <link rel="prev" title="File Objects" href="file.html" />

  40.     <link rel="canonical" href="https://docs.python.org/3/c-api/module.html" />

  41.     

  42.       

  43.     

  44. 

  45.     

  46.     <style>

  47.       @media only screen {

  48.         table.full-width-table {

  49.             width: 100%;

  50.         }

  51.       }

  52.     </style>

  53. <link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">

  54.     <link rel="shortcut icon" type="image/png" href="../_static/py.svg" />

  55.             <script type="text/javascript" src="../_static/copybutton.js"></script>

  56.             <script type="text/javascript" src="../_static/menu.js"></script>

  57.             <script type="text/javascript" src="../_static/search-focus.js"></script>

  58.             <script type="text/javascript" src="../_static/themetoggle.js"></script> 

  59. 

  60.   </head>

  61. <body>

  62. <div class="mobile-nav">

  63.     <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"

  64.            aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />

  65.     <nav class="nav-content" role="navigation">

  66.         <label for="menuToggler" class="toggler__label">

  67.             <span></span>

  68.         </label>

  69.         <span class="nav-items-wrapper">

  70.             <a href="https://www.python.org/" class="nav-logo">

  71.                 <img src="../_static/py.svg" alt="Python logo"/>

  72.             </a>

  73.             <span class="version_switcher_placeholder"></span>

  74.             <form role="search" class="search" action="../search.html" method="get">

  75.                 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">

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

  77.                 </svg>

  78.                 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />

  79.                 <input type="submit" value="Go"/>

  80.             </form>

  81.         </span>

  82.     </nav>

  83.     <div class="menu-wrapper">

  84.         <nav class="menu" role="navigation" aria-label="main navigation">

  85.             <div class="language_switcher_placeholder"></div>

  86.             

  87. <label class="theme-selector-label">

  88.     Theme

  89.     <select class="theme-selector" oninput="activateTheme(this.value)">

  90.         <option value="auto" selected>Auto</option>

  91.         <option value="light">Light</option>

  92.         <option value="dark">Dark</option>

  93.     </select>

  94. </label>

  95.   <div>

  96.     <h3><a href="../contents.html">Table of Contents</a></h3>

  97.     <ul>

  98. <li><a class="reference internal" href="#">Module Objects</a><ul>

  99. <li><a class="reference internal" href="#initializing-c-modules">Initializing C modules</a><ul>

  100. <li><a class="reference internal" href="#single-phase-initialization">Single-phase initialization</a></li>

  101. <li><a class="reference internal" href="#multi-phase-initialization">Multi-phase initialization</a></li>

  102. <li><a class="reference internal" href="#low-level-module-creation-functions">Low-level module creation functions</a></li>

  103. <li><a class="reference internal" href="#support-functions">Support functions</a></li>

  104. </ul>

  105. </li>

  106. <li><a class="reference internal" href="#module-lookup">Module lookup</a></li>

  107. </ul>

  108. </li>

  109. </ul>

  110. 

  111.   </div>

  112.   <div>

  113.     <h4>Previous topic</h4>

  114.     <p class="topless"><a href="file.html"

  115.                           title="previous chapter">File Objects</a></p>

  116.   </div>

  117.   <div>

  118.     <h4>Next topic</h4>

  119.     <p class="topless"><a href="iterator.html"

  120.                           title="next chapter">Iterator Objects</a></p>

  121.   </div>

  122.   <div role="note" aria-label="source link">

  123.     <h3>This Page</h3>

  124.     <ul class="this-page-menu">

  125.       <li><a href="../bugs.html">Report a Bug</a></li>

  126.       <li>

  127.         <a href="https://github.com/python/cpython/blob/main/Doc/c-api/module.rst"

  128.             rel="nofollow">Show Source

  129.         </a>

  130.       </li>

  131.     </ul>

  132.   </div>

  133.         </nav>

  134.     </div>

  135. </div>

  136. 

  137.   

  138.     <div class="related" role="navigation" aria-label="related navigation">

  139.       <h3>Navigation</h3>

  140.       <ul>

  141.         <li class="right" style="margin-right: 10px">

  142.           <a href="../genindex.html" title="General Index"

  143.              accesskey="I">index</a></li>

  144.         <li class="right" >

  145.           <a href="../py-modindex.html" title="Python Module Index"

  146.              >modules</a> |</li>

  147.         <li class="right" >

  148.           <a href="iterator.html" title="Iterator Objects"

  149.              accesskey="N">next</a> |</li>

  150.         <li class="right" >

  151.           <a href="file.html" title="File Objects"

  152.              accesskey="P">previous</a> |</li>

  153. 

  154.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  155.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  156.           <li class="switchers">

  157.             <div class="language_switcher_placeholder"></div>

  158.             <div class="version_switcher_placeholder"></div>

  159.           </li>

  160.           <li>

  161.               

  162.           </li>

  163.     <li id="cpython-language-and-version">

  164.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  165.     </li>

  166. 

  167.           <li class="nav-item nav-item-1"><a href="index.html" >Python/C API Reference Manual</a> &#187;</li>

  168.           <li class="nav-item nav-item-2"><a href="concrete.html" accesskey="U">Concrete Objects Layer</a> &#187;</li>

  169.         <li class="nav-item nav-item-this"><a href="">Module Objects</a></li>

  170.                 <li class="right">

  171.                     

  172. 

  173.     <div class="inline-search" role="search">

  174.         <form class="inline-search" action="../search.html" method="get">

  175.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  176.           <input type="submit" value="Go" />

  177.         </form>

  178.     </div>

  179.                      |

  180.                 </li>

  181.             <li class="right">

  182. <label class="theme-selector-label">

  183.     Theme

  184.     <select class="theme-selector" oninput="activateTheme(this.value)">

  185.         <option value="auto" selected>Auto</option>

  186.         <option value="light">Light</option>

  187.         <option value="dark">Dark</option>

  188.     </select>

  189. </label> |</li>

  190.             

  191.       </ul>

  192.     </div>    

  193. 

  194.     <div class="document">

  195.       <div class="documentwrapper">

  196.         <div class="bodywrapper">

  197.           <div class="body" role="main">

  198.             

  199.   <section id="module-objects">

  200. <span id="moduleobjects"></span><h1>Module Objects<a class="headerlink" href="#module-objects" title="Link to this heading">¶</a></h1>

  201. <dl class="c var" id="index-0">

  202. <dt class="sig sig-object c" id="c.PyModule_Type">

  203. <a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject"><span class="n"><span class="pre">PyTypeObject</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyModule_Type</span></span></span><a class="headerlink" href="#c.PyModule_Type" title="Link to this definition">¶</a><br /></dt>

  204. <dd><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a>.</em><p id="index-1">This instance of <a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject"><code class="xref c c-type docutils literal notranslate"><span class="pre">PyTypeObject</span></code></a> represents the Python module type.  This

  205. is exposed to Python programs as <code class="docutils literal notranslate"><span class="pre">types.ModuleType</span></code>.</p>

  206. </dd></dl>

  207. 

  208. <dl class="c function">

  209. <dt class="sig sig-object c" id="c.PyModule_Check">

  210. <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyModule_Check</span></span></span><span class="sig-paren">(</span><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="n"><span class="pre">p</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyModule_Check" title="Link to this definition">¶</a><br /></dt>

  211. <dd><p>Return true if <em>p</em> is a module object, or a subtype of a module object.

  212. This function always succeeds.</p>

  213. </dd></dl>

  214. 

  215. <dl class="c function">

  216. <dt class="sig sig-object c" id="c.PyModule_CheckExact">

  217. <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyModule_CheckExact</span></span></span><span class="sig-paren">(</span><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="n"><span class="pre">p</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyModule_CheckExact" title="Link to this definition">¶</a><br /></dt>

  218. <dd><p>Return true if <em>p</em> is a module object, but not a subtype of

  219. <a class="reference internal" href="#c.PyModule_Type" title="PyModule_Type"><code class="xref c c-data docutils literal notranslate"><span class="pre">PyModule_Type</span></code></a>.  This function always succeeds.</p>

  220. </dd></dl>

  221. 

  222. <dl class="c function">

  223. <dt class="sig sig-object c" id="c.PyModule_NewObject">

  224. <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">PyModule_NewObject</span></span></span><span class="sig-paren">(</span><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="n"><span class="pre">name</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyModule_NewObject" title="Link to this definition">¶</a><br /></dt>

  225. <dd><em class="refcount">Return value: New reference.</em><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.7.</em><p id="index-2">Return a new module object with the <a class="reference internal" href="../reference/import.html#name__" title="__name__"><code class="xref py py-attr docutils literal notranslate"><span class="pre">__name__</span></code></a> attribute set to <em>name</em>.

  226. The module’s <a class="reference internal" href="../reference/import.html#name__" title="__name__"><code class="xref py py-attr docutils literal notranslate"><span class="pre">__name__</span></code></a>, <code class="xref py py-attr docutils literal notranslate"><span class="pre">__doc__</span></code>, <a class="reference internal" href="../reference/import.html#package__" title="__package__"><code class="xref py py-attr docutils literal notranslate"><span class="pre">__package__</span></code></a>, and

  227. <a class="reference internal" href="../reference/import.html#loader__" title="__loader__"><code class="xref py py-attr docutils literal notranslate"><span class="pre">__loader__</span></code></a> attributes are filled in (all but <a class="reference internal" href="../reference/import.html#name__" title="__name__"><code class="xref py py-attr docutils literal notranslate"><span class="pre">__name__</span></code></a> are set

  228. to <code class="docutils literal notranslate"><span class="pre">None</span></code>); the caller is responsible for providing a <a class="reference internal" href="../reference/import.html#file__" title="__file__"><code class="xref py py-attr docutils literal notranslate"><span class="pre">__file__</span></code></a>

  229. attribute.</p>

  230. <div class="versionadded">

  231. <p><span class="versionmodified added">New in version 3.3.</span></p>

  232. </div>

  233. <div class="versionchanged">

  234. <p><span class="versionmodified changed">Changed in version 3.4: </span><a class="reference internal" href="../reference/import.html#package__" title="__package__"><code class="xref py py-attr docutils literal notranslate"><span class="pre">__package__</span></code></a> and <a class="reference internal" href="../reference/import.html#loader__" title="__loader__"><code class="xref py py-attr docutils literal notranslate"><span class="pre">__loader__</span></code></a> are set to <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>

  235. </div>

  236. </dd></dl>

  237. 

  238. <dl class="c function">

  239. <dt class="sig sig-object c" id="c.PyModule_New">

  240. <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">PyModule_New</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">name</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyModule_New" title="Link to this definition">¶</a><br /></dt>

  241. <dd><em class="refcount">Return value: New reference.</em><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a>.</em><p>Similar to <a class="reference internal" href="#c.PyModule_NewObject" title="PyModule_NewObject"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyModule_NewObject()</span></code></a>, but the name is a UTF-8 encoded

  242. string instead of a Unicode object.</p>

  243. </dd></dl>

  244. 

  245. <dl class="c function">

  246. <dt class="sig sig-object c" id="c.PyModule_GetDict">

  247. <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">PyModule_GetDict</span></span></span><span class="sig-paren">(</span><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="n"><span class="pre">module</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyModule_GetDict" title="Link to this definition">¶</a><br /></dt>

  248. <dd><em class="refcount">Return value: Borrowed reference.</em><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a>.</em><p id="index-3">Return the dictionary object that implements <em>module</em>’s namespace; this object

  249. is the same as the <a class="reference internal" href="../library/stdtypes.html#object.__dict__" title="object.__dict__"><code class="xref py py-attr docutils literal notranslate"><span class="pre">__dict__</span></code></a> attribute of the module object.

  250. If <em>module</em> is not a module object (or a subtype of a module object),

  251. <a class="reference internal" href="../library/exceptions.html#SystemError" title="SystemError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">SystemError</span></code></a> is raised and <code class="docutils literal notranslate"><span class="pre">NULL</span></code> is returned.</p>

  252. <p>It is recommended extensions use other <code class="docutils literal notranslate"><span class="pre">PyModule_*</span></code> and

  253. <code class="docutils literal notranslate"><span class="pre">PyObject_*</span></code> functions rather than directly manipulate a module’s

  254. <a class="reference internal" href="../library/stdtypes.html#object.__dict__" title="object.__dict__"><code class="xref py py-attr docutils literal notranslate"><span class="pre">__dict__</span></code></a>.</p>

  255. </dd></dl>

  256. 

  257. <dl class="c function">

  258. <dt class="sig sig-object c" id="c.PyModule_GetNameObject">

  259. <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">PyModule_GetNameObject</span></span></span><span class="sig-paren">(</span><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="n"><span class="pre">module</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyModule_GetNameObject" title="Link to this definition">¶</a><br /></dt>

  260. <dd><em class="refcount">Return value: New reference.</em><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.7.</em><p id="index-4">Return <em>module</em>’s <a class="reference internal" href="../reference/import.html#name__" title="__name__"><code class="xref py py-attr docutils literal notranslate"><span class="pre">__name__</span></code></a> value.  If the module does not provide one,

  261. or if it is not a string, <a class="reference internal" href="../library/exceptions.html#SystemError" title="SystemError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">SystemError</span></code></a> is raised and <code class="docutils literal notranslate"><span class="pre">NULL</span></code> is returned.</p>

  262. <div class="versionadded">

  263. <p><span class="versionmodified added">New in version 3.3.</span></p>

  264. </div>

  265. </dd></dl>

  266. 

  267. <dl class="c function">

  268. <dt class="sig sig-object c" id="c.PyModule_GetName">

  269. <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">PyModule_GetName</span></span></span><span class="sig-paren">(</span><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="n"><span class="pre">module</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyModule_GetName" title="Link to this definition">¶</a><br /></dt>

  270. <dd><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a>.</em><p>Similar to <a class="reference internal" href="#c.PyModule_GetNameObject" title="PyModule_GetNameObject"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyModule_GetNameObject()</span></code></a> but return the name encoded to

  271. <code class="docutils literal notranslate"><span class="pre">'utf-8'</span></code>.</p>

  272. </dd></dl>

  273. 

  274. <dl class="c function">

  275. <dt class="sig sig-object c" id="c.PyModule_GetState">

  276. <span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">PyModule_GetState</span></span></span><span class="sig-paren">(</span><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="n"><span class="pre">module</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyModule_GetState" title="Link to this definition">¶</a><br /></dt>

  277. <dd><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a>.</em><p>Return the “state” of the module, that is, a pointer to the block of memory

  278. allocated at module creation time, or <code class="docutils literal notranslate"><span class="pre">NULL</span></code>.  See

  279. <a class="reference internal" href="#c.PyModuleDef.m_size" title="PyModuleDef.m_size"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyModuleDef.m_size</span></code></a>.</p>

  280. </dd></dl>

  281. 

  282. <dl class="c function">

  283. <dt class="sig sig-object c" id="c.PyModule_GetDef">

  284. <a class="reference internal" href="#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="sig-name descname"><span class="n"><span class="pre">PyModule_GetDef</span></span></span><span class="sig-paren">(</span><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="n"><span class="pre">module</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyModule_GetDef" title="Link to this definition">¶</a><br /></dt>

  285. <dd><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a>.</em><p>Return a pointer to the <a class="reference internal" href="#c.PyModuleDef" title="PyModuleDef"><code class="xref c c-type docutils literal notranslate"><span class="pre">PyModuleDef</span></code></a> struct from which the module was

  286. created, or <code class="docutils literal notranslate"><span class="pre">NULL</span></code> if the module wasn’t created from a definition.</p>

  287. </dd></dl>

  288. 

  289. <dl class="c function">

  290. <dt class="sig sig-object c" id="c.PyModule_GetFilenameObject">

  291. <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">PyModule_GetFilenameObject</span></span></span><span class="sig-paren">(</span><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="n"><span class="pre">module</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyModule_GetFilenameObject" title="Link to this definition">¶</a><br /></dt>

  292. <dd><em class="refcount">Return value: New reference.</em><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a>.</em><p id="index-5">Return the name of the file from which <em>module</em> was loaded using <em>module</em>’s

  293. <a class="reference internal" href="../reference/import.html#file__" title="__file__"><code class="xref py py-attr docutils literal notranslate"><span class="pre">__file__</span></code></a> attribute.  If this is not defined, or if it is not a

  294. unicode string, raise <a class="reference internal" href="../library/exceptions.html#SystemError" title="SystemError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">SystemError</span></code></a> and return <code class="docutils literal notranslate"><span class="pre">NULL</span></code>; otherwise return

  295. a reference to a Unicode object.</p>

  296. <div class="versionadded">

  297. <p><span class="versionmodified added">New in version 3.2.</span></p>

  298. </div>

  299. </dd></dl>

  300. 

  301. <dl class="c function">

  302. <dt class="sig sig-object c" id="c.PyModule_GetFilename">

  303. <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">PyModule_GetFilename</span></span></span><span class="sig-paren">(</span><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="n"><span class="pre">module</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyModule_GetFilename" title="Link to this definition">¶</a><br /></dt>

  304. <dd><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a>.</em><p>Similar to <a class="reference internal" href="#c.PyModule_GetFilenameObject" title="PyModule_GetFilenameObject"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyModule_GetFilenameObject()</span></code></a> but return the filename

  305. encoded to ‘utf-8’.</p>

  306. <div class="deprecated">

  307. <p><span class="versionmodified deprecated">Deprecated since version 3.2: </span><a class="reference internal" href="#c.PyModule_GetFilename" title="PyModule_GetFilename"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyModule_GetFilename()</span></code></a> raises <a class="reference internal" href="../library/exceptions.html#UnicodeEncodeError" title="UnicodeEncodeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">UnicodeEncodeError</span></code></a> on

  308. unencodable filenames, use <a class="reference internal" href="#c.PyModule_GetFilenameObject" title="PyModule_GetFilenameObject"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyModule_GetFilenameObject()</span></code></a> instead.</p>

  309. </div>

  310. </dd></dl>

  311. 

  312. <section id="initializing-c-modules">

  313. <span id="initializing-modules"></span><h2>Initializing C modules<a class="headerlink" href="#initializing-c-modules" title="Link to this heading">¶</a></h2>

  314. <p>Modules objects are usually created from extension modules (shared libraries

  315. which export an initialization function), or compiled-in modules

  316. (where the initialization function is added using <a class="reference internal" href="import.html#c.PyImport_AppendInittab" title="PyImport_AppendInittab"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyImport_AppendInittab()</span></code></a>).

  317. See <a class="reference internal" href="../extending/building.html#building"><span class="std std-ref">Building C and C++ Extensions</span></a> or <a class="reference internal" href="../extending/embedding.html#extending-with-embedding"><span class="std std-ref">Extending Embedded Python</span></a> for details.</p>

  318. <p>The initialization function can either pass a module definition instance

  319. to <a class="reference internal" href="#c.PyModule_Create" title="PyModule_Create"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyModule_Create()</span></code></a>, and return the resulting module object,

  320. or request “multi-phase initialization” by returning the definition struct itself.</p>

  321. <dl class="c type">

  322. <dt class="sig sig-object c" id="c.PyModuleDef">

  323. <span class="k"><span class="pre">type</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyModuleDef</span></span></span><a class="headerlink" href="#c.PyModuleDef" title="Link to this definition">¶</a><br /></dt>

  324. <dd><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a> (including all members).</em><p>The module definition struct, which holds all information needed to create

  325. a module object. There is usually only one statically initialized variable

  326. of this type for each module.</p>

  327. <dl class="c member">

  328. <dt class="sig sig-object c" id="c.PyModuleDef.m_base">

  329. <span class="n"><span class="pre">PyModuleDef_Base</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">m_base</span></span></span><a class="headerlink" href="#c.PyModuleDef.m_base" title="Link to this definition">¶</a><br /></dt>

  330. <dd><p>Always initialize this member to <code class="xref c c-macro docutils literal notranslate"><span class="pre">PyModuleDef_HEAD_INIT</span></code>.</p>

  331. </dd></dl>

  332. 

  333. <dl class="c member">

  334. <dt class="sig sig-object c" id="c.PyModuleDef.m_name">

  335. <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">m_name</span></span></span><a class="headerlink" href="#c.PyModuleDef.m_name" title="Link to this definition">¶</a><br /></dt>

  336. <dd><p>Name for the new module.</p>

  337. </dd></dl>

  338. 

  339. <dl class="c member">

  340. <dt class="sig sig-object c" id="c.PyModuleDef.m_doc">

  341. <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">m_doc</span></span></span><a class="headerlink" href="#c.PyModuleDef.m_doc" title="Link to this definition">¶</a><br /></dt>

  342. <dd><p>Docstring for the module; usually a docstring variable created with

  343. <a class="reference internal" href="intro.html#c.PyDoc_STRVAR" title="PyDoc_STRVAR"><code class="xref c c-macro docutils literal notranslate"><span class="pre">PyDoc_STRVAR</span></code></a> is used.</p>

  344. </dd></dl>

  345. 

  346. <dl class="c member">

  347. <dt class="sig sig-object c" id="c.PyModuleDef.m_size">

  348. <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t"><span class="n"><span class="pre">Py_ssize_t</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">m_size</span></span></span><a class="headerlink" href="#c.PyModuleDef.m_size" title="Link to this definition">¶</a><br /></dt>

  349. <dd><p>Module state may be kept in a per-module memory area that can be

  350. retrieved with <a class="reference internal" href="#c.PyModule_GetState" title="PyModule_GetState"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyModule_GetState()</span></code></a>, rather than in static globals.

  351. This makes modules safe for use in multiple sub-interpreters.</p>

  352. <p>This memory area is allocated based on <em>m_size</em> on module creation,

  353. and freed when the module object is deallocated, after the

  354. <a class="reference internal" href="#c.PyModuleDef.m_free" title="PyModuleDef.m_free"><code class="xref c c-member docutils literal notranslate"><span class="pre">m_free</span></code></a> function has been called, if present.</p>

  355. <p>Setting <code class="docutils literal notranslate"><span class="pre">m_size</span></code> to <code class="docutils literal notranslate"><span class="pre">-1</span></code> means that the module does not support

  356. sub-interpreters, because it has global state.</p>

  357. <p>Setting it to a non-negative value means that the module can be

  358. re-initialized and specifies the additional amount of memory it requires

  359. for its state. Non-negative <code class="docutils literal notranslate"><span class="pre">m_size</span></code> is required for multi-phase

  360. initialization.</p>

  361. <p>See <span class="target" id="index-6"></span><a class="pep reference external" href="https://peps.python.org/pep-3121/"><strong>PEP 3121</strong></a> for more details.</p>

  362. </dd></dl>

  363. 

  364. <dl class="c member">

  365. <dt class="sig sig-object c" id="c.PyModuleDef.m_methods">

  366. <a class="reference internal" href="structures.html#c.PyMethodDef" title="PyMethodDef"><span class="n"><span class="pre">PyMethodDef</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">m_methods</span></span></span><a class="headerlink" href="#c.PyModuleDef.m_methods" title="Link to this definition">¶</a><br /></dt>

  367. <dd><p>A pointer to a table of module-level functions, described by

  368. <a class="reference internal" href="structures.html#c.PyMethodDef" title="PyMethodDef"><code class="xref c c-type docutils literal notranslate"><span class="pre">PyMethodDef</span></code></a> values.  Can be <code class="docutils literal notranslate"><span class="pre">NULL</span></code> if no functions are present.</p>

  369. </dd></dl>

  370. 

  371. <dl class="c member">

  372. <dt class="sig sig-object c" id="c.PyModuleDef.m_slots">

  373. <a class="reference internal" href="#c.PyModuleDef_Slot" title="PyModuleDef_Slot"><span class="n"><span class="pre">PyModuleDef_Slot</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">m_slots</span></span></span><a class="headerlink" href="#c.PyModuleDef.m_slots" title="Link to this definition">¶</a><br /></dt>

  374. <dd><p>An array of slot definitions for multi-phase initialization, terminated by

  375. a <code class="docutils literal notranslate"><span class="pre">{0,</span> <span class="pre">NULL}</span></code> entry.

  376. When using single-phase initialization, <em>m_slots</em> must be <code class="docutils literal notranslate"><span class="pre">NULL</span></code>.</p>

  377. <div class="versionchanged">

  378. <p><span class="versionmodified changed">Changed in version 3.5: </span>Prior to version 3.5, this member was always set to <code class="docutils literal notranslate"><span class="pre">NULL</span></code>,

  379. and was defined as:</p>

  380. <blockquote>

  381. <div><dl class="c member">

  382. <dt class="sig sig-object c" id="c.PyModuleDef.m_slots.m_reload">

  383. <a class="reference internal" href="gcsupport.html#c.inquiry" title="inquiry"><span class="n"><span class="pre">inquiry</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">m_reload</span></span></span><a class="headerlink" href="#c.PyModuleDef.m_slots.m_reload" title="Link to this definition">¶</a><br /></dt>

  384. <dd></dd></dl>

  385. 

  386. </div></blockquote>

  387. </div>

  388. </dd></dl>

  389. 

  390. <dl class="c member">

  391. <dt class="sig sig-object c" id="c.PyModuleDef.m_traverse">

  392. <a class="reference internal" href="gcsupport.html#c.traverseproc" title="traverseproc"><span class="n"><span class="pre">traverseproc</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">m_traverse</span></span></span><a class="headerlink" href="#c.PyModuleDef.m_traverse" title="Link to this definition">¶</a><br /></dt>

  393. <dd><p>A traversal function to call during GC traversal of the module object, or

  394. <code class="docutils literal notranslate"><span class="pre">NULL</span></code> if not needed.</p>

  395. <p>This function is not called if the module state was requested but is not

  396. allocated yet. This is the case immediately after the module is created

  397. and before the module is executed (<a class="reference internal" href="#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> function). More

  398. precisely, this function is not called if <a class="reference internal" href="#c.PyModuleDef.m_size" title="PyModuleDef.m_size"><code class="xref c c-member docutils literal notranslate"><span class="pre">m_size</span></code></a> is greater

  399. than 0 and the module state (as returned by <a class="reference internal" href="#c.PyModule_GetState" title="PyModule_GetState"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyModule_GetState()</span></code></a>)

  400. is <code class="docutils literal notranslate"><span class="pre">NULL</span></code>.</p>

  401. <div class="versionchanged">

  402. <p><span class="versionmodified changed">Changed in version 3.9: </span>No longer called before the module state is allocated.</p>

  403. </div>

  404. </dd></dl>

  405. 

  406. <dl class="c member">

  407. <dt class="sig sig-object c" id="c.PyModuleDef.m_clear">

  408. <a class="reference internal" href="gcsupport.html#c.inquiry" title="inquiry"><span class="n"><span class="pre">inquiry</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">m_clear</span></span></span><a class="headerlink" href="#c.PyModuleDef.m_clear" title="Link to this definition">¶</a><br /></dt>

  409. <dd><p>A clear function to call during GC clearing of the module object, or

  410. <code class="docutils literal notranslate"><span class="pre">NULL</span></code> if not needed.</p>

  411. <p>This function is not called if the module state was requested but is not

  412. allocated yet. This is the case immediately after the module is created

  413. and before the module is executed (<a class="reference internal" href="#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> function). More

  414. precisely, this function is not called if <a class="reference internal" href="#c.PyModuleDef.m_size" title="PyModuleDef.m_size"><code class="xref c c-member docutils literal notranslate"><span class="pre">m_size</span></code></a> is greater

  415. than 0 and the module state (as returned by <a class="reference internal" href="#c.PyModule_GetState" title="PyModule_GetState"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyModule_GetState()</span></code></a>)

  416. is <code class="docutils literal notranslate"><span class="pre">NULL</span></code>.</p>

  417. <p>Like <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_clear" title="PyTypeObject.tp_clear"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyTypeObject.tp_clear</span></code></a>, this function is not <em>always</em>

  418. called before a module is deallocated. For example, when reference

  419. counting is enough to determine that an object is no longer used,

  420. the cyclic garbage collector is not involved and

  421. <a class="reference internal" href="#c.PyModuleDef.m_free" title="PyModuleDef.m_free"><code class="xref c c-member docutils literal notranslate"><span class="pre">m_free</span></code></a> is called directly.</p>

  422. <div class="versionchanged">

  423. <p><span class="versionmodified changed">Changed in version 3.9: </span>No longer called before the module state is allocated.</p>

  424. </div>

  425. </dd></dl>

  426. 

  427. <dl class="c member">

  428. <dt class="sig sig-object c" id="c.PyModuleDef.m_free">

  429. <a class="reference internal" href="typeobj.html#c.freefunc" title="freefunc"><span class="n"><span class="pre">freefunc</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">m_free</span></span></span><a class="headerlink" href="#c.PyModuleDef.m_free" title="Link to this definition">¶</a><br /></dt>

  430. <dd><p>A function to call during deallocation of the module object, or <code class="docutils literal notranslate"><span class="pre">NULL</span></code>

  431. if not needed.</p>

  432. <p>This function is not called if the module state was requested but is not

  433. allocated yet. This is the case immediately after the module is created

  434. and before the module is executed (<a class="reference internal" href="#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> function). More

  435. precisely, this function is not called if <a class="reference internal" href="#c.PyModuleDef.m_size" title="PyModuleDef.m_size"><code class="xref c c-member docutils literal notranslate"><span class="pre">m_size</span></code></a> is greater

  436. than 0 and the module state (as returned by <a class="reference internal" href="#c.PyModule_GetState" title="PyModule_GetState"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyModule_GetState()</span></code></a>)

  437. is <code class="docutils literal notranslate"><span class="pre">NULL</span></code>.</p>

  438. <div class="versionchanged">

  439. <p><span class="versionmodified changed">Changed in version 3.9: </span>No longer called before the module state is allocated.</p>

  440. </div>

  441. </dd></dl>

  442. 

  443. </dd></dl>

  444. 

  445. <section id="single-phase-initialization">

  446. <h3>Single-phase initialization<a class="headerlink" href="#single-phase-initialization" title="Link to this heading">¶</a></h3>

  447. <p>The module initialization function may create and return the module object

  448. directly. This is referred to as “single-phase initialization”, and uses one

  449. of the following two module creation functions:</p>

  450. <dl class="c function">

  451. <dt class="sig sig-object c" id="c.PyModule_Create">

  452. <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">PyModule_Create</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#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.PyModule_Create" title="Link to this definition">¶</a><br /></dt>

  453. <dd><em class="refcount">Return value: New reference.</em><p>Create a new module object, given the definition in <em>def</em>.  This behaves

  454. like <a class="reference internal" href="#c.PyModule_Create2" title="PyModule_Create2"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyModule_Create2()</span></code></a> with <em>module_api_version</em> set to

  455. <code class="xref c c-macro docutils literal notranslate"><span class="pre">PYTHON_API_VERSION</span></code>.</p>

  456. </dd></dl>

  457. 

  458. <dl class="c function">

  459. <dt class="sig sig-object c" id="c.PyModule_Create2">

  460. <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">PyModule_Create2</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#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="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">module_api_version</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyModule_Create2" title="Link to this definition">¶</a><br /></dt>

  461. <dd><em class="refcount">Return value: New reference.</em><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a>.</em><p>Create a new module object, given the definition in <em>def</em>, assuming the

  462. API version <em>module_api_version</em>.  If that version does not match the version

  463. of the running interpreter, a <a class="reference internal" href="../library/exceptions.html#RuntimeWarning" title="RuntimeWarning"><code class="xref py py-exc docutils literal notranslate"><span class="pre">RuntimeWarning</span></code></a> is emitted.</p>

  464. <div class="admonition note">

  465. <p class="admonition-title">Note</p>

  466. <p>Most uses of this function should be using <a class="reference internal" href="#c.PyModule_Create" title="PyModule_Create"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyModule_Create()</span></code></a>

  467. instead; only use this if you are sure you need it.</p>

  468. </div>

  469. </dd></dl>

  470. 

  471. <p>Before it is returned from in the initialization function, the resulting module

  472. object is typically populated using functions like <a class="reference internal" href="#c.PyModule_AddObjectRef" title="PyModule_AddObjectRef"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyModule_AddObjectRef()</span></code></a>.</p>

  473. </section>

  474. <section id="multi-phase-initialization">

  475. <span id="id1"></span><h3>Multi-phase initialization<a class="headerlink" href="#multi-phase-initialization" title="Link to this heading">¶</a></h3>

  476. <p>An alternate way to specify extensions is to request “multi-phase initialization”.

  477. Extension modules created this way behave more like Python modules: the

  478. initialization is split between the <em>creation phase</em>, when the module object

  479. is created, and the <em>execution phase</em>, when it is populated.

  480. The distinction is similar to the <code class="xref py py-meth docutils literal notranslate"><span class="pre">__new__()</span></code> and <code class="xref py py-meth docutils literal notranslate"><span class="pre">__init__()</span></code> methods

  481. of classes.</p>

  482. <p>Unlike modules created using single-phase initialization, these modules are not

  483. singletons: if the <em>sys.modules</em> entry is removed and the module is re-imported,

  484. a new module object is created, and the old module is subject to normal garbage

  485. collection – as with Python modules.

  486. By default, multiple modules created from the same definition should be

  487. independent: changes to one should not affect the others.

  488. This means that all state should be specific to the module object (using e.g.

  489. using <a class="reference internal" href="#c.PyModule_GetState" title="PyModule_GetState"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyModule_GetState()</span></code></a>), or its contents (such as the module’s

  490. <a class="reference internal" href="../library/stdtypes.html#object.__dict__" title="object.__dict__"><code class="xref py py-attr docutils literal notranslate"><span class="pre">__dict__</span></code></a> or individual classes created with <a class="reference internal" href="type.html#c.PyType_FromSpec" title="PyType_FromSpec"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyType_FromSpec()</span></code></a>).</p>

  491. <p>All modules created using multi-phase initialization are expected to support

  492. <a class="reference internal" href="init.html#sub-interpreter-support"><span class="std std-ref">sub-interpreters</span></a>. Making sure multiple modules

  493. are independent is typically enough to achieve this.</p>

  494. <p>To request multi-phase initialization, the initialization function

  495. (PyInit_modulename) returns a <a class="reference internal" href="#c.PyModuleDef" title="PyModuleDef"><code class="xref c c-type docutils literal notranslate"><span class="pre">PyModuleDef</span></code></a> instance with non-empty

  496. <a class="reference internal" href="#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>. Before it is returned, the <code class="docutils literal notranslate"><span class="pre">PyModuleDef</span></code>

  497. instance must be initialized with the following function:</p>

  498. <dl class="c function">

  499. <dt class="sig sig-object c" id="c.PyModuleDef_Init">

  500. <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="#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>

  501. <dd><em class="refcount">Return value: Borrowed reference.</em><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>Ensures a module definition is a properly initialized Python object that

  502. correctly reports its type and reference count.</p>

  503. <p>Returns <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>

  504. <div class="versionadded">

  505. <p><span class="versionmodified added">New in version 3.5.</span></p>

  506. </div>

  507. </dd></dl>

  508. 

  509. <p>The <em>m_slots</em> member of the module definition must point to an array of

  510. <code class="docutils literal notranslate"><span class="pre">PyModuleDef_Slot</span></code> structures:</p>

  511. <dl class="c type">

  512. <dt class="sig sig-object c" id="c.PyModuleDef_Slot">

  513. <span class="k"><span class="pre">type</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyModuleDef_Slot</span></span></span><a class="headerlink" href="#c.PyModuleDef_Slot" title="Link to this definition">¶</a><br /></dt>

  514. <dd><dl class="c member">

  515. <dt class="sig sig-object c" id="c.PyModuleDef_Slot.slot">

  516. <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">slot</span></span></span><a class="headerlink" href="#c.PyModuleDef_Slot.slot" title="Link to this definition">¶</a><br /></dt>

  517. <dd><p>A slot ID, chosen from the available values explained below.</p>

  518. </dd></dl>

  519. 

  520. <dl class="c member">

  521. <dt class="sig sig-object c" id="c.PyModuleDef_Slot.value">

  522. <span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">value</span></span></span><a class="headerlink" href="#c.PyModuleDef_Slot.value" title="Link to this definition">¶</a><br /></dt>

  523. <dd><p>Value of the slot, whose meaning depends on the slot ID.</p>

  524. </dd></dl>

  525. 

  526. <div class="versionadded">

  527. <p><span class="versionmodified added">New in version 3.5.</span></p>

  528. </div>

  529. </dd></dl>

  530. 

  531. <p>The <em>m_slots</em> array must be terminated by a slot with id 0.</p>

  532. <p>The available slot types are:</p>

  533. <dl class="c macro">

  534. <dt class="sig sig-object c" id="c.Py_mod_create">

  535. <span class="sig-name descname"><span class="n"><span class="pre">Py_mod_create</span></span></span><a class="headerlink" href="#c.Py_mod_create" title="Link to this definition">¶</a><br /></dt>

  536. <dd><p>Specifies a function that is called to create the module object itself.

  537. The <em>value</em> pointer of this slot must point to a function of the signature:</p>

  538. <dl class="c function">

  539. <dt class="sig sig-object c">

  540. <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">create_module</span></span></span><span class="sig-paren">(</span><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="n"><span class="pre">spec</span></span>, <a class="reference internal" href="#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><br /></dt>

  541. <dd></dd></dl>

  542. 

  543. <p>The function receives a <a class="reference internal" href="../library/importlib.html#importlib.machinery.ModuleSpec" title="importlib.machinery.ModuleSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ModuleSpec</span></code></a>

  544. instance, as defined in <span class="target" id="index-7"></span><a class="pep reference external" href="https://peps.python.org/pep-0451/"><strong>PEP 451</strong></a>, and the module definition.

  545. It should return a new module object, or set an error

  546. and return <code class="docutils literal notranslate"><span class="pre">NULL</span></code>.</p>

  547. <p>This function should be kept minimal. In particular, it should not

  548. call arbitrary Python code, as trying to import the same module again may

  549. result in an infinite loop.</p>

  550. <p>Multiple <code class="docutils literal notranslate"><span class="pre">Py_mod_create</span></code> slots may not be specified in one module

  551. definition.</p>

  552. <p>If <code class="docutils literal notranslate"><span class="pre">Py_mod_create</span></code> is not specified, the import machinery will create

  553. a normal module object using <a class="reference internal" href="#c.PyModule_New" title="PyModule_New"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyModule_New()</span></code></a>. The name is taken from

  554. <em>spec</em>, not the definition, to allow extension modules to dynamically adjust

  555. to their place in the module hierarchy and be imported under different

  556. names through symlinks, all while sharing a single module definition.</p>

  557. <p>There is no requirement for the returned object to be an instance of

  558. <a class="reference internal" href="#c.PyModule_Type" title="PyModule_Type"><code class="xref c c-type docutils literal notranslate"><span class="pre">PyModule_Type</span></code></a>. Any type can be used, as long as it supports

  559. setting and getting import-related attributes.

  560. However, only <code class="docutils literal notranslate"><span class="pre">PyModule_Type</span></code> instances may be returned if the

  561. <code class="docutils literal notranslate"><span class="pre">PyModuleDef</span></code> has non-<code class="docutils literal notranslate"><span class="pre">NULL</span></code> <code class="docutils literal notranslate"><span class="pre">m_traverse</span></code>, <code class="docutils literal notranslate"><span class="pre">m_clear</span></code>,

  562. <code class="docutils literal notranslate"><span class="pre">m_free</span></code>; non-zero <code class="docutils literal notranslate"><span class="pre">m_size</span></code>; or slots other than <code class="docutils literal notranslate"><span class="pre">Py_mod_create</span></code>.</p>

  563. </dd></dl>

  564. 

  565. <dl class="c macro">

  566. <dt class="sig sig-object c" id="c.Py_mod_exec">

  567. <span class="sig-name descname"><span class="n"><span class="pre">Py_mod_exec</span></span></span><a class="headerlink" href="#c.Py_mod_exec" title="Link to this definition">¶</a><br /></dt>

  568. <dd><p>Specifies a function that is called to <em>execute</em> the module.

  569. This is equivalent to executing the code of a Python module: typically,

  570. this function adds classes and constants to the module.

  571. The signature of the function is:</p>

  572. <dl class="c function">

  573. <dt class="sig sig-object c">

  574. <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">exec_module</span></span></span><span class="sig-paren">(</span><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="n"><span class="pre">module</span></span><span class="sig-paren">)</span><br /></dt>

  575. <dd></dd></dl>

  576. 

  577. <p>If multiple <code class="docutils literal notranslate"><span class="pre">Py_mod_exec</span></code> slots are specified, they are processed in the

  578. order they appear in the <em>m_slots</em> array.</p>

  579. </dd></dl>

  580. 

  581. <dl class="c macro">

  582. <dt class="sig sig-object c" id="c.Py_mod_multiple_interpreters">

  583. <span class="sig-name descname"><span class="n"><span class="pre">Py_mod_multiple_interpreters</span></span></span><a class="headerlink" href="#c.Py_mod_multiple_interpreters" title="Link to this definition">¶</a><br /></dt>

  584. <dd><p>Specifies one of the following values:</p>

  585. <dl class="c macro">

  586. <dt class="sig sig-object c" id="c.Py_MOD_MULTIPLE_INTERPRETERS_NOT_SUPPORTED">

  587. <span class="sig-name descname"><span class="n"><span class="pre">Py_MOD_MULTIPLE_INTERPRETERS_NOT_SUPPORTED</span></span></span><a class="headerlink" href="#c.Py_MOD_MULTIPLE_INTERPRETERS_NOT_SUPPORTED" title="Link to this definition">¶</a><br /></dt>

  588. <dd><p>The module does not support being imported in subinterpreters.</p>

  589. </dd></dl>

  590. 

  591. <dl class="c macro">

  592. <dt class="sig sig-object c" id="c.Py_MOD_MULTIPLE_INTERPRETERS_SUPPORTED">

  593. <span class="sig-name descname"><span class="n"><span class="pre">Py_MOD_MULTIPLE_INTERPRETERS_SUPPORTED</span></span></span><a class="headerlink" href="#c.Py_MOD_MULTIPLE_INTERPRETERS_SUPPORTED" title="Link to this definition">¶</a><br /></dt>

  594. <dd><p>The module supports being imported in subinterpreters,

  595. but only when they share the main interpreter’s GIL.

  596. (See <a class="reference internal" href="../howto/isolating-extensions.html#isolating-extensions-howto"><span class="std std-ref">Isolating Extension Modules</span></a>.)</p>

  597. </dd></dl>

  598. 

  599. <dl class="c macro">

  600. <dt class="sig sig-object c" id="c.Py_MOD_PER_INTERPRETER_GIL_SUPPORTED">

  601. <span class="sig-name descname"><span class="n"><span class="pre">Py_MOD_PER_INTERPRETER_GIL_SUPPORTED</span></span></span><a class="headerlink" href="#c.Py_MOD_PER_INTERPRETER_GIL_SUPPORTED" title="Link to this definition">¶</a><br /></dt>

  602. <dd><p>The module supports being imported in subinterpreters,

  603. even when they have their own GIL.

  604. (See <a class="reference internal" href="../howto/isolating-extensions.html#isolating-extensions-howto"><span class="std std-ref">Isolating Extension Modules</span></a>.)</p>

  605. </dd></dl>

  606. 

  607. <p>This slot determines whether or not importing this module

  608. in a subinterpreter will fail.</p>

  609. <p>Multiple <code class="docutils literal notranslate"><span class="pre">Py_mod_multiple_interpreters</span></code> slots may not be specified

  610. in one module definition.</p>

  611. <p>If <code class="docutils literal notranslate"><span class="pre">Py_mod_multiple_interpreters</span></code> is not specified, the import

  612. machinery defaults to <code class="docutils literal notranslate"><span class="pre">Py_MOD_MULTIPLE_INTERPRETERS_NOT_SUPPORTED</span></code>.</p>

  613. <div class="versionadded">

  614. <p><span class="versionmodified added">New in version 3.12.</span></p>

  615. </div>

  616. </dd></dl>

  617. 

  618. <p>See <span class="target" id="index-8"></span><a class="pep reference external" href="https://peps.python.org/pep-0489/"><strong>PEP 489</strong></a> for more details on multi-phase initialization.</p>

  619. </section>

  620. <section id="low-level-module-creation-functions">

  621. <h3>Low-level module creation functions<a class="headerlink" href="#low-level-module-creation-functions" title="Link to this heading">¶</a></h3>

  622. <p>The following functions are called under the hood when using multi-phase

  623. initialization. They can be used directly, for example when creating module

  624. objects dynamically. Note that both <code class="docutils literal notranslate"><span class="pre">PyModule_FromDefAndSpec</span></code> and

  625. <code class="docutils literal notranslate"><span class="pre">PyModule_ExecDef</span></code> must be called to fully initialize a module.</p>

  626. <dl class="c function">

  627. <dt class="sig sig-object c" id="c.PyModule_FromDefAndSpec">

  628. <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">PyModule_FromDefAndSpec</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#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>, <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="n"><span class="pre">spec</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyModule_FromDefAndSpec" title="Link to this definition">¶</a><br /></dt>

  629. <dd><em class="refcount">Return value: New reference.</em><p>Create a new module object, given the definition in <em>def</em> and the

  630. ModuleSpec <em>spec</em>.  This behaves like <a class="reference internal" href="#c.PyModule_FromDefAndSpec2" title="PyModule_FromDefAndSpec2"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyModule_FromDefAndSpec2()</span></code></a>

  631. with <em>module_api_version</em> set to <code class="xref c c-macro docutils literal notranslate"><span class="pre">PYTHON_API_VERSION</span></code>.</p>

  632. <div class="versionadded">

  633. <p><span class="versionmodified added">New in version 3.5.</span></p>

  634. </div>

  635. </dd></dl>

  636. 

  637. <dl class="c function">

  638. <dt class="sig sig-object c" id="c.PyModule_FromDefAndSpec2">

  639. <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">PyModule_FromDefAndSpec2</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#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>, <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="n"><span class="pre">spec</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">module_api_version</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyModule_FromDefAndSpec2" title="Link to this definition">¶</a><br /></dt>

  640. <dd><em class="refcount">Return value: New reference.</em><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.7.</em><p>Create a new module object, given the definition in <em>def</em> and the

  641. ModuleSpec <em>spec</em>, assuming the API version <em>module_api_version</em>.

  642. If that version does not match the version of the running interpreter,

  643. a <a class="reference internal" href="../library/exceptions.html#RuntimeWarning" title="RuntimeWarning"><code class="xref py py-exc docutils literal notranslate"><span class="pre">RuntimeWarning</span></code></a> is emitted.</p>

  644. <div class="admonition note">

  645. <p class="admonition-title">Note</p>

  646. <p>Most uses of this function should be using <a class="reference internal" href="#c.PyModule_FromDefAndSpec" title="PyModule_FromDefAndSpec"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyModule_FromDefAndSpec()</span></code></a>

  647. instead; only use this if you are sure you need it.</p>

  648. </div>

  649. <div class="versionadded">

  650. <p><span class="versionmodified added">New in version 3.5.</span></p>

  651. </div>

  652. </dd></dl>

  653. 

  654. <dl class="c function">

  655. <dt class="sig sig-object c" id="c.PyModule_ExecDef">

  656. <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyModule_ExecDef</span></span></span><span class="sig-paren">(</span><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="n"><span class="pre">module</span></span>, <a class="reference internal" href="#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.PyModule_ExecDef" title="Link to this definition">¶</a><br /></dt>

  657. <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.7.</em><p>Process any execution slots (<a class="reference internal" href="#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>) given in <em>def</em>.</p>

  658. <div class="versionadded">

  659. <p><span class="versionmodified added">New in version 3.5.</span></p>

  660. </div>

  661. </dd></dl>

  662. 

  663. <dl class="c function">

  664. <dt class="sig sig-object c" id="c.PyModule_SetDocString">

  665. <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyModule_SetDocString</span></span></span><span class="sig-paren">(</span><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="n"><span class="pre">module</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">docstring</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyModule_SetDocString" title="Link to this definition">¶</a><br /></dt>

  666. <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.7.</em><p>Set the docstring for <em>module</em> to <em>docstring</em>.

  667. This function is called automatically when creating a module from

  668. <code class="docutils literal notranslate"><span class="pre">PyModuleDef</span></code>, using either <code class="docutils literal notranslate"><span class="pre">PyModule_Create</span></code> or

  669. <code class="docutils literal notranslate"><span class="pre">PyModule_FromDefAndSpec</span></code>.</p>

  670. <div class="versionadded">

  671. <p><span class="versionmodified added">New in version 3.5.</span></p>

  672. </div>

  673. </dd></dl>

  674. 

  675. <dl class="c function">

  676. <dt class="sig sig-object c" id="c.PyModule_AddFunctions">

  677. <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyModule_AddFunctions</span></span></span><span class="sig-paren">(</span><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="n"><span class="pre">module</span></span>, <a class="reference internal" href="structures.html#c.PyMethodDef" title="PyMethodDef"><span class="n"><span class="pre">PyMethodDef</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">functions</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyModule_AddFunctions" title="Link to this definition">¶</a><br /></dt>

  678. <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.7.</em><p>Add the functions from the <code class="docutils literal notranslate"><span class="pre">NULL</span></code> terminated <em>functions</em> array to <em>module</em>.

  679. Refer to the <a class="reference internal" href="structures.html#c.PyMethodDef" title="PyMethodDef"><code class="xref c c-type docutils literal notranslate"><span class="pre">PyMethodDef</span></code></a> documentation for details on individual

  680. entries (due to the lack of a shared module namespace, module level

  681. “functions” implemented in C typically receive the module as their first

  682. parameter, making them similar to instance methods on Python classes).

  683. This function is called automatically when creating a module from

  684. <code class="docutils literal notranslate"><span class="pre">PyModuleDef</span></code>, using either <code class="docutils literal notranslate"><span class="pre">PyModule_Create</span></code> or

  685. <code class="docutils literal notranslate"><span class="pre">PyModule_FromDefAndSpec</span></code>.</p>

  686. <div class="versionadded">

  687. <p><span class="versionmodified added">New in version 3.5.</span></p>

  688. </div>

  689. </dd></dl>

  690. 

  691. </section>

  692. <section id="support-functions">

  693. <h3>Support functions<a class="headerlink" href="#support-functions" title="Link to this heading">¶</a></h3>

  694. <p>The module initialization function (if using single phase initialization) or

  695. a function called from a module execution slot (if using multi-phase

  696. initialization), can use the following functions to help initialize the module

  697. state:</p>

  698. <dl class="c function">

  699. <dt class="sig sig-object c" id="c.PyModule_AddObjectRef">

  700. <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyModule_AddObjectRef</span></span></span><span class="sig-paren">(</span><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="n"><span class="pre">module</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">name</span></span>, <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="n"><span class="pre">value</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyModule_AddObjectRef" title="Link to this definition">¶</a><br /></dt>

  701. <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.10.</em><p>Add an object to <em>module</em> as <em>name</em>.  This is a convenience function which

  702. can be used from the module’s initialization function.</p>

  703. <p>On success, return <code class="docutils literal notranslate"><span class="pre">0</span></code>. On error, raise an exception and return <code class="docutils literal notranslate"><span class="pre">-1</span></code>.</p>

  704. <p>Return <code class="docutils literal notranslate"><span class="pre">NULL</span></code> if <em>value</em> is <code class="docutils literal notranslate"><span class="pre">NULL</span></code>. It must be called with an exception

  705. raised in this case.</p>

  706. <p>Example usage:</p>

  707. <div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="k">static</span><span class="w"> </span><span class="kt">int</span>

  708. <span class="nf">add_spam</span><span class="p">(</span><span class="n">PyObject</span><span class="w"> </span><span class="o">*</span><span class="n">module</span><span class="p">,</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">value</span><span class="p">)</span>

  709. <span class="p">{</span>

  710. <span class="w">    </span><span class="n">PyObject</span><span class="w"> </span><span class="o">*</span><span class="n">obj</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">PyLong_FromLong</span><span class="p">(</span><span class="n">value</span><span class="p">);</span>

  711. <span class="w">    </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">obj</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="nb">NULL</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>

  712. <span class="w">        </span><span class="k">return</span><span class="w"> </span><span class="mi">-1</span><span class="p">;</span>

  713. <span class="w">    </span><span class="p">}</span>

  714. <span class="w">    </span><span class="kt">int</span><span class="w"> </span><span class="n">res</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">PyModule_AddObjectRef</span><span class="p">(</span><span class="n">module</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;spam&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">obj</span><span class="p">);</span>

  715. <span class="w">    </span><span class="n">Py_DECREF</span><span class="p">(</span><span class="n">obj</span><span class="p">);</span>

  716. <span class="w">    </span><span class="k">return</span><span class="w"> </span><span class="n">res</span><span class="p">;</span>

  717. <span class="w"> </span><span class="p">}</span>

  718. </pre></div>

  719. </div>

  720. <p>The example can also be written without checking explicitly if <em>obj</em> is

  721. <code class="docutils literal notranslate"><span class="pre">NULL</span></code>:</p>

  722. <div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="k">static</span><span class="w"> </span><span class="kt">int</span>

  723. <span class="nf">add_spam</span><span class="p">(</span><span class="n">PyObject</span><span class="w"> </span><span class="o">*</span><span class="n">module</span><span class="p">,</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">value</span><span class="p">)</span>

  724. <span class="p">{</span>

  725. <span class="w">    </span><span class="n">PyObject</span><span class="w"> </span><span class="o">*</span><span class="n">obj</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">PyLong_FromLong</span><span class="p">(</span><span class="n">value</span><span class="p">);</span>

  726. <span class="w">    </span><span class="kt">int</span><span class="w"> </span><span class="n">res</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">PyModule_AddObjectRef</span><span class="p">(</span><span class="n">module</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;spam&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">obj</span><span class="p">);</span>

  727. <span class="w">    </span><span class="n">Py_XDECREF</span><span class="p">(</span><span class="n">obj</span><span class="p">);</span>

  728. <span class="w">    </span><span class="k">return</span><span class="w"> </span><span class="n">res</span><span class="p">;</span>

  729. <span class="w"> </span><span class="p">}</span>

  730. </pre></div>

  731. </div>

  732. <p>Note that <code class="docutils literal notranslate"><span class="pre">Py_XDECREF()</span></code> should be used instead of <code class="docutils literal notranslate"><span class="pre">Py_DECREF()</span></code> in

  733. this case, since <em>obj</em> can be <code class="docutils literal notranslate"><span class="pre">NULL</span></code>.</p>

  734. <div class="versionadded">

  735. <p><span class="versionmodified added">New in version 3.10.</span></p>

  736. </div>

  737. </dd></dl>

  738. 

  739. <dl class="c function">

  740. <dt class="sig sig-object c" id="c.PyModule_AddObject">

  741. <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyModule_AddObject</span></span></span><span class="sig-paren">(</span><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="n"><span class="pre">module</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">name</span></span>, <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="n"><span class="pre">value</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyModule_AddObject" title="Link to this definition">¶</a><br /></dt>

  742. <dd><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a>.</em><p>Similar to <a class="reference internal" href="#c.PyModule_AddObjectRef" title="PyModule_AddObjectRef"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyModule_AddObjectRef()</span></code></a>, but steals a reference to

  743. <em>value</em> on success (if it returns <code class="docutils literal notranslate"><span class="pre">0</span></code>).</p>

  744. <p>The new <a class="reference internal" href="#c.PyModule_AddObjectRef" title="PyModule_AddObjectRef"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyModule_AddObjectRef()</span></code></a> function is recommended, since it is

  745. easy to introduce reference leaks by misusing the

  746. <a class="reference internal" href="#c.PyModule_AddObject" title="PyModule_AddObject"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyModule_AddObject()</span></code></a> function.</p>

  747. <div class="admonition note">

  748. <p class="admonition-title">Note</p>

  749. <p>Unlike other functions that steal references, <code class="docutils literal notranslate"><span class="pre">PyModule_AddObject()</span></code>

  750. only releases the reference to <em>value</em> <strong>on success</strong>.</p>

  751. <p>This means that its return value must be checked, and calling code must

  752. <a class="reference internal" href="refcounting.html#c.Py_DECREF" title="Py_DECREF"><code class="xref c c-func docutils literal notranslate"><span class="pre">Py_DECREF()</span></code></a> <em>value</em> manually on error.</p>

  753. </div>

  754. <p>Example usage:</p>

  755. <div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="k">static</span><span class="w"> </span><span class="kt">int</span>

  756. <span class="nf">add_spam</span><span class="p">(</span><span class="n">PyObject</span><span class="w"> </span><span class="o">*</span><span class="n">module</span><span class="p">,</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">value</span><span class="p">)</span>

  757. <span class="p">{</span>

  758. <span class="w">    </span><span class="n">PyObject</span><span class="w"> </span><span class="o">*</span><span class="n">obj</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">PyLong_FromLong</span><span class="p">(</span><span class="n">value</span><span class="p">);</span>

  759. <span class="w">    </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">obj</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="nb">NULL</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>

  760. <span class="w">        </span><span class="k">return</span><span class="w"> </span><span class="mi">-1</span><span class="p">;</span>

  761. <span class="w">    </span><span class="p">}</span>

  762. <span class="w">    </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">PyModule_AddObject</span><span class="p">(</span><span class="n">module</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;spam&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">obj</span><span class="p">)</span><span class="w"> </span><span class="o">&lt;</span><span class="w"> </span><span class="mi">0</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>

  763. <span class="w">        </span><span class="n">Py_DECREF</span><span class="p">(</span><span class="n">obj</span><span class="p">);</span>

  764. <span class="w">        </span><span class="k">return</span><span class="w"> </span><span class="mi">-1</span><span class="p">;</span>

  765. <span class="w">    </span><span class="p">}</span>

  766. <span class="w">    </span><span class="c1">// PyModule_AddObject() stole a reference to obj:</span>

  767. <span class="w">    </span><span class="c1">// Py_DECREF(obj) is not needed here</span>

  768. <span class="w">    </span><span class="k">return</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span>

  769. <span class="p">}</span>

  770. </pre></div>

  771. </div>

  772. <p>The example can also be written without checking explicitly if <em>obj</em> is

  773. <code class="docutils literal notranslate"><span class="pre">NULL</span></code>:</p>

  774. <div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="k">static</span><span class="w"> </span><span class="kt">int</span>

  775. <span class="nf">add_spam</span><span class="p">(</span><span class="n">PyObject</span><span class="w"> </span><span class="o">*</span><span class="n">module</span><span class="p">,</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">value</span><span class="p">)</span>

  776. <span class="p">{</span>

  777. <span class="w">    </span><span class="n">PyObject</span><span class="w"> </span><span class="o">*</span><span class="n">obj</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">PyLong_FromLong</span><span class="p">(</span><span class="n">value</span><span class="p">);</span>

  778. <span class="w">    </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">PyModule_AddObject</span><span class="p">(</span><span class="n">module</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;spam&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">obj</span><span class="p">)</span><span class="w"> </span><span class="o">&lt;</span><span class="w"> </span><span class="mi">0</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>

  779. <span class="w">        </span><span class="n">Py_XDECREF</span><span class="p">(</span><span class="n">obj</span><span class="p">);</span>

  780. <span class="w">        </span><span class="k">return</span><span class="w"> </span><span class="mi">-1</span><span class="p">;</span>

  781. <span class="w">    </span><span class="p">}</span>

  782. <span class="w">    </span><span class="c1">// PyModule_AddObject() stole a reference to obj:</span>

  783. <span class="w">    </span><span class="c1">// Py_DECREF(obj) is not needed here</span>

  784. <span class="w">    </span><span class="k">return</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span>

  785. <span class="p">}</span>

  786. </pre></div>

  787. </div>

  788. <p>Note that <code class="docutils literal notranslate"><span class="pre">Py_XDECREF()</span></code> should be used instead of <code class="docutils literal notranslate"><span class="pre">Py_DECREF()</span></code> in

  789. this case, since <em>obj</em> can be <code class="docutils literal notranslate"><span class="pre">NULL</span></code>.</p>

  790. </dd></dl>

  791. 

  792. <dl class="c function">

  793. <dt class="sig sig-object c" id="c.PyModule_AddIntConstant">

  794. <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyModule_AddIntConstant</span></span></span><span class="sig-paren">(</span><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="n"><span class="pre">module</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">name</span></span>, <span class="kt"><span class="pre">long</span></span><span class="w"> </span><span class="n"><span class="pre">value</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyModule_AddIntConstant" title="Link to this definition">¶</a><br /></dt>

  795. <dd><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a>.</em><p>Add an integer constant to <em>module</em> as <em>name</em>.  This convenience function can be

  796. used from the module’s initialization function. Return <code class="docutils literal notranslate"><span class="pre">-1</span></code> on error, <code class="docutils literal notranslate"><span class="pre">0</span></code> on

  797. success.</p>

  798. </dd></dl>

  799. 

  800. <dl class="c function">

  801. <dt class="sig sig-object c" id="c.PyModule_AddStringConstant">

  802. <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyModule_AddStringConstant</span></span></span><span class="sig-paren">(</span><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="n"><span class="pre">module</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">name</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">value</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyModule_AddStringConstant" title="Link to this definition">¶</a><br /></dt>

  803. <dd><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a>.</em><p>Add a string constant to <em>module</em> as <em>name</em>.  This convenience function can be

  804. used from the module’s initialization function.  The string <em>value</em> must be

  805. <code class="docutils literal notranslate"><span class="pre">NULL</span></code>-terminated.  Return <code class="docutils literal notranslate"><span class="pre">-1</span></code> on error, <code class="docutils literal notranslate"><span class="pre">0</span></code> on success.</p>

  806. </dd></dl>

  807. 

  808. <dl class="c macro">

  809. <dt class="sig sig-object c" id="c.PyModule_AddIntMacro">

  810. <span class="sig-name descname"><span class="n"><span class="pre">PyModule_AddIntMacro</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">module</span></span>, <span class="n"><span class="pre">macro</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyModule_AddIntMacro" title="Link to this definition">¶</a><br /></dt>

  811. <dd><p>Add an int constant to <em>module</em>. The name and the value are taken from

  812. <em>macro</em>. For example <code class="docutils literal notranslate"><span class="pre">PyModule_AddIntMacro(module,</span> <span class="pre">AF_INET)</span></code> adds the int

  813. constant <em>AF_INET</em> with the value of <em>AF_INET</em> to <em>module</em>.

  814. Return <code class="docutils literal notranslate"><span class="pre">-1</span></code> on error, <code class="docutils literal notranslate"><span class="pre">0</span></code> on success.</p>

  815. </dd></dl>

  816. 

  817. <dl class="c macro">

  818. <dt class="sig sig-object c" id="c.PyModule_AddStringMacro">

  819. <span class="sig-name descname"><span class="n"><span class="pre">PyModule_AddStringMacro</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">module</span></span>, <span class="n"><span class="pre">macro</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyModule_AddStringMacro" title="Link to this definition">¶</a><br /></dt>

  820. <dd><p>Add a string constant to <em>module</em>.</p>

  821. </dd></dl>

  822. 

  823. <dl class="c function">

  824. <dt class="sig sig-object c" id="c.PyModule_AddType">

  825. <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyModule_AddType</span></span></span><span class="sig-paren">(</span><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="n"><span class="pre">module</span></span>, <a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject"><span class="n"><span class="pre">PyTypeObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">type</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyModule_AddType" title="Link to this definition">¶</a><br /></dt>

  826. <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.10.</em><p>Add a type object to <em>module</em>.

  827. The type object is finalized by calling internally <a class="reference internal" href="type.html#c.PyType_Ready" title="PyType_Ready"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyType_Ready()</span></code></a>.

  828. The name of the type object is taken from the last component of

  829. <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_name" title="PyTypeObject.tp_name"><code class="xref c c-member docutils literal notranslate"><span class="pre">tp_name</span></code></a> after dot.

  830. Return <code class="docutils literal notranslate"><span class="pre">-1</span></code> on error, <code class="docutils literal notranslate"><span class="pre">0</span></code> on success.</p>

  831. <div class="versionadded">

  832. <p><span class="versionmodified added">New in version 3.9.</span></p>

  833. </div>

  834. </dd></dl>

  835. 

  836. </section>

  837. </section>

  838. <section id="module-lookup">

  839. <h2>Module lookup<a class="headerlink" href="#module-lookup" title="Link to this heading">¶</a></h2>

  840. <p>Single-phase initialization creates singleton modules that can be looked up

  841. in the context of the current interpreter. This allows the module object to be

  842. retrieved later with only a reference to the module definition.</p>

  843. <p>These functions will not work on modules created using multi-phase initialization,

  844. since multiple such modules can be created from a single definition.</p>

  845. <dl class="c function">

  846. <dt class="sig sig-object c" id="c.PyState_FindModule">

  847. <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">PyState_FindModule</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#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.PyState_FindModule" title="Link to this definition">¶</a><br /></dt>

  848. <dd><em class="refcount">Return value: Borrowed reference.</em><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a>.</em><p>Returns the module object that was created from <em>def</em> for the current interpreter.

  849. This method requires that the module object has been attached to the interpreter state with

  850. <a class="reference internal" href="#c.PyState_AddModule" title="PyState_AddModule"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyState_AddModule()</span></code></a> beforehand. In case the corresponding module object is not

  851. found or has not been attached to the interpreter state yet, it returns <code class="docutils literal notranslate"><span class="pre">NULL</span></code>.</p>

  852. </dd></dl>

  853. 

  854. <dl class="c function">

  855. <dt class="sig sig-object c" id="c.PyState_AddModule">

  856. <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyState_AddModule</span></span></span><span class="sig-paren">(</span><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="n"><span class="pre">module</span></span>, <a class="reference internal" href="#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.PyState_AddModule" title="Link to this definition">¶</a><br /></dt>

  857. <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.3.</em><p>Attaches the module object passed to the function to the interpreter state. This allows

  858. the module object to be accessible via <a class="reference internal" href="#c.PyState_FindModule" title="PyState_FindModule"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyState_FindModule()</span></code></a>.</p>

  859. <p>Only effective on modules created using single-phase initialization.</p>

  860. <p>Python calls <code class="docutils literal notranslate"><span class="pre">PyState_AddModule</span></code> automatically after importing a module,

  861. so it is unnecessary (but harmless) to call it from module initialization

  862. code. An explicit call is needed only if the module’s own init code

  863. subsequently calls <code class="docutils literal notranslate"><span class="pre">PyState_FindModule</span></code>.

  864. The function is mainly intended for implementing alternative import

  865. mechanisms (either by calling it directly, or by referring to its

  866. implementation for details of the required state updates).</p>

  867. <p>The caller must hold the GIL.</p>

  868. <p>Return 0 on success or -1 on failure.</p>

  869. <div class="versionadded">

  870. <p><span class="versionmodified added">New in version 3.3.</span></p>

  871. </div>

  872. </dd></dl>

  873. 

  874. <dl class="c function">

  875. <dt class="sig sig-object c" id="c.PyState_RemoveModule">

  876. <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyState_RemoveModule</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#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.PyState_RemoveModule" title="Link to this definition">¶</a><br /></dt>

  877. <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.3.</em><p>Removes the module object created from <em>def</em> from the interpreter state.

  878. Return 0 on success or -1 on failure.</p>

  879. <p>The caller must hold the GIL.</p>

  880. <div class="versionadded">

  881. <p><span class="versionmodified added">New in version 3.3.</span></p>

  882. </div>

  883. </dd></dl>

  884. 

  885. </section>

  886. </section>

  887. 

  888. 

  889.             <div class="clearer"></div>

  890.           </div>

  891.         </div>

  892.       </div>

  893.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">

  894.         <div class="sphinxsidebarwrapper">

  895.   <div>

  896.     <h3><a href="../contents.html">Table of Contents</a></h3>

  897.     <ul>

  898. <li><a class="reference internal" href="#">Module Objects</a><ul>

  899. <li><a class="reference internal" href="#initializing-c-modules">Initializing C modules</a><ul>

  900. <li><a class="reference internal" href="#single-phase-initialization">Single-phase initialization</a></li>

  901. <li><a class="reference internal" href="#multi-phase-initialization">Multi-phase initialization</a></li>

  902. <li><a class="reference internal" href="#low-level-module-creation-functions">Low-level module creation functions</a></li>

  903. <li><a class="reference internal" href="#support-functions">Support functions</a></li>

  904. </ul>

  905. </li>

  906. <li><a class="reference internal" href="#module-lookup">Module lookup</a></li>

  907. </ul>

  908. </li>

  909. </ul>

  910. 

  911.   </div>

  912.   <div>

  913.     <h4>Previous topic</h4>

  914.     <p class="topless"><a href="file.html"

  915.                           title="previous chapter">File Objects</a></p>

  916.   </div>

  917.   <div>

  918.     <h4>Next topic</h4>

  919.     <p class="topless"><a href="iterator.html"

  920.                           title="next chapter">Iterator Objects</a></p>

  921.   </div>

  922.   <div role="note" aria-label="source link">

  923.     <h3>This Page</h3>

  924.     <ul class="this-page-menu">

  925.       <li><a href="../bugs.html">Report a Bug</a></li>

  926.       <li>

  927.         <a href="https://github.com/python/cpython/blob/main/Doc/c-api/module.rst"

  928.             rel="nofollow">Show Source

  929.         </a>

  930.       </li>

  931.     </ul>

  932.   </div>

  933.         </div>

  934. <div id="sidebarbutton" title="Collapse sidebar">

  935. <span>«</span>

  936. </div>

  937. 

  938.       </div>

  939.       <div class="clearer"></div>

  940.     </div>  

  941.     <div class="related" role="navigation" aria-label="related navigation">

  942.       <h3>Navigation</h3>

  943.       <ul>

  944.         <li class="right" style="margin-right: 10px">

  945.           <a href="../genindex.html" title="General Index"

  946.              >index</a></li>

  947.         <li class="right" >

  948.           <a href="../py-modindex.html" title="Python Module Index"

  949.              >modules</a> |</li>

  950.         <li class="right" >

  951.           <a href="iterator.html" title="Iterator Objects"

  952.              >next</a> |</li>

  953.         <li class="right" >

  954.           <a href="file.html" title="File Objects"

  955.              >previous</a> |</li>

  956. 

  957.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  958.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  959.           <li class="switchers">

  960.             <div class="language_switcher_placeholder"></div>

  961.             <div class="version_switcher_placeholder"></div>

  962.           </li>

  963.           <li>

  964.               

  965.           </li>

  966.     <li id="cpython-language-and-version">

  967.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  968.     </li>

  969. 

  970.           <li class="nav-item nav-item-1"><a href="index.html" >Python/C API Reference Manual</a> &#187;</li>

  971.           <li class="nav-item nav-item-2"><a href="concrete.html" >Concrete Objects Layer</a> &#187;</li>

  972.         <li class="nav-item nav-item-this"><a href="">Module Objects</a></li>

  973.                 <li class="right">

  974.                     

  975. 

  976.     <div class="inline-search" role="search">

  977.         <form class="inline-search" action="../search.html" method="get">

  978.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  979.           <input type="submit" value="Go" />

  980.         </form>

  981.     </div>

  982.                      |

  983.                 </li>

  984.             <li class="right">

  985. <label class="theme-selector-label">

  986.     Theme

  987.     <select class="theme-selector" oninput="activateTheme(this.value)">

  988.         <option value="auto" selected>Auto</option>

  989.         <option value="light">Light</option>

  990.         <option value="dark">Dark</option>

  991.     </select>

  992. </label> |</li>

  993.             

  994.       </ul>

  995.     </div>  

  996.     <div class="footer">

  997.     &copy; 

  998.       <a href="../copyright.html">

  999.     

  1000.     Copyright

  1001.     

  1002.       </a>

  1003.      2001-2024, Python Software Foundation.

  1004.     <br />

  1005.     This page is licensed under the Python Software Foundation License Version 2.

  1006.     <br />

  1007.     Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.

  1008.     <br />

  1009.     

  1010.       See <a href="/license.html">History and License</a> for more information.<br />

  1011.     

  1012.     

  1013.     <br />

  1014. 

  1015.     The Python Software Foundation is a non-profit corporation.

  1016. <a href="https://www.python.org/psf/donations/">Please donate.</a>

  1017. <br />

  1018.     <br />

  1019.       Last updated on Apr 09, 2024 (13:47 UTC).

  1020.     

  1021.       <a href="/bugs.html">Found a bug</a>?

  1022.     

  1023.     <br />

  1024. 

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

  1026.     </div>

  1027. 

  1028.   </body>

  1029. </html>
上海开阖软件有限公司 沪ICP备12045867号-1