Baoding-FenShuaJiang
/
Green_GoodERP18_FSJ_Standard
Watch 1
Star 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.
Branch: master
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'master'
${ noResults }
Green_GoodERP18_FSJ_Standard/python/Doc/html/c-api/import.html

636 lines
65KB
Raw Permalink Blame History 

  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="Importing Modules" />

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

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

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

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

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

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

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

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

  16. 

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

  18.     

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

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

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

  22.     

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

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

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

  26.     

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

  28.     

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

  30.           title="Search within Python 3.12.3 documentation"

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

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

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

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

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

  36.     <link rel="next" title="Data marshalling support" href="marshal.html" />

  37.     <link rel="prev" title="Operating System Utilities" href="sys.html" />

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

  39.     

  40.       

  41.     

  42. 

  43.     

  44.     <style>

  45.       @media only screen {

  46.         table.full-width-table {

  47.             width: 100%;

  48.         }

  49.       }

  50.     </style>

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

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

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

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

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

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

  57. 

  58.   </head>

  59. <body>

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

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

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

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

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

  65.             <span></span>

  66.         </label>

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

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

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

  70.             </a>

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

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

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

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

  75.                 </svg>

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

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

  78.             </form>

  79.         </span>

  80.     </nav>

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

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

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

  84.             

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

  86.     Theme

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

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

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

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

  91.     </select>

  92. </label>

  93.   <div>

  94.     <h4>Previous topic</h4>

  95.     <p class="topless"><a href="sys.html"

  96.                           title="previous chapter">Operating System Utilities</a></p>

  97.   </div>

  98.   <div>

  99.     <h4>Next topic</h4>

  100.     <p class="topless"><a href="marshal.html"

  101.                           title="next chapter">Data marshalling support</a></p>

  102.   </div>

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

  104.     <h3>This Page</h3>

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

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

  107.       <li>

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

  109.             rel="nofollow">Show Source

  110.         </a>

  111.       </li>

  112.     </ul>

  113.   </div>

  114.         </nav>

  115.     </div>

  116. </div>

  117. 

  118.   

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

  120.       <h3>Navigation</h3>

  121.       <ul>

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

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

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

  125.         <li class="right" >

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

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

  128.         <li class="right" >

  129.           <a href="marshal.html" title="Data marshalling support"

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

  131.         <li class="right" >

  132.           <a href="sys.html" title="Operating System Utilities"

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

  134. 

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

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

  137.           <li class="switchers">

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

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

  140.           </li>

  141.           <li>

  142.               

  143.           </li>

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

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

  146.     </li>

  147. 

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

  149.           <li class="nav-item nav-item-2"><a href="utilities.html" accesskey="U">Utilities</a> &#187;</li>

  150.         <li class="nav-item nav-item-this"><a href="">Importing Modules</a></li>

  151.                 <li class="right">

  152.                     

  153. 

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

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

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

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

  158.         </form>

  159.     </div>

  160.                      |

  161.                 </li>

  162.             <li class="right">

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

  164.     Theme

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

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

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

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

  169.     </select>

  170. </label> |</li>

  171.             

  172.       </ul>

  173.     </div>    

  174. 

  175.     <div class="document">

  176.       <div class="documentwrapper">

  177.         <div class="bodywrapper">

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

  179.             

  180.   <section id="importing-modules">

  181. <span id="importing"></span><h1>Importing Modules<a class="headerlink" href="#importing-modules" title="Link to this heading">¶</a></h1>

  182. <dl class="c function">

  183. <dt class="sig sig-object c" id="c.PyImport_ImportModule">

  184. <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">PyImport_ImportModule</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.PyImport_ImportModule" title="Link to this definition">¶</a><br /></dt>

  185. <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-0">This is a wrapper around <a class="reference internal" href="#c.PyImport_Import" title="PyImport_Import"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyImport_Import()</span></code></a> which takes a

  186. <span class="c-expr sig sig-inline c"><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="p">*</span></span> as an argument instead of a <span class="c-expr sig sig-inline c"><a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n">PyObject</span></a><span class="p">*</span></span>.</p>

  187. </dd></dl>

  188. 

  189. <dl class="c function">

  190. <dt class="sig sig-object c" id="c.PyImport_ImportModuleNoBlock">

  191. <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">PyImport_ImportModuleNoBlock</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.PyImport_ImportModuleNoBlock" title="Link to this definition">¶</a><br /></dt>

  192. <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>This function is a deprecated alias of <a class="reference internal" href="#c.PyImport_ImportModule" title="PyImport_ImportModule"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyImport_ImportModule()</span></code></a>.</p>

  193. <div class="versionchanged">

  194. <p><span class="versionmodified changed">Changed in version 3.3: </span>This function used to fail immediately when the import lock was held

  195. by another thread.  In Python 3.3 though, the locking scheme switched

  196. to per-module locks for most purposes, so this function’s special

  197. behaviour isn’t needed anymore.</p>

  198. </div>

  199. </dd></dl>

  200. 

  201. <dl class="c function">

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

  203. <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">PyImport_ImportModuleEx</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>, <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">globals</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">locals</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">fromlist</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyImport_ImportModuleEx" title="Link to this definition">¶</a><br /></dt>

  204. <dd><em class="refcount">Return value: New reference.</em><p id="index-1">Import a module.  This is best described by referring to the built-in Python

  205. function <a class="reference internal" href="../library/functions.html#import__" title="__import__"><code class="xref py py-func docutils literal notranslate"><span class="pre">__import__()</span></code></a>.</p>

  206. <p>The return value is a new reference to the imported module or top-level

  207. package, or <code class="docutils literal notranslate"><span class="pre">NULL</span></code> with an exception set on failure.  Like for

  208. <a class="reference internal" href="../library/functions.html#import__" title="__import__"><code class="xref py py-func docutils literal notranslate"><span class="pre">__import__()</span></code></a>, the return value when a submodule of a package was

  209. requested is normally the top-level package, unless a non-empty <em>fromlist</em>

  210. was given.</p>

  211. <p>Failing imports remove incomplete module objects, like with

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

  213. </dd></dl>

  214. 

  215. <dl class="c function">

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

  217. <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">PyImport_ImportModuleLevelObject</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>, <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">globals</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">locals</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">fromlist</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">level</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyImport_ImportModuleLevelObject" title="Link to this definition">¶</a><br /></dt>

  218. <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>Import a module.  This is best described by referring to the built-in Python

  219. function <a class="reference internal" href="../library/functions.html#import__" title="__import__"><code class="xref py py-func docutils literal notranslate"><span class="pre">__import__()</span></code></a>, as the standard <a class="reference internal" href="../library/functions.html#import__" title="__import__"><code class="xref py py-func docutils literal notranslate"><span class="pre">__import__()</span></code></a> function calls

  220. this function directly.</p>

  221. <p>The return value is a new reference to the imported module or top-level package,

  222. or <code class="docutils literal notranslate"><span class="pre">NULL</span></code> with an exception set on failure.  Like for <a class="reference internal" href="../library/functions.html#import__" title="__import__"><code class="xref py py-func docutils literal notranslate"><span class="pre">__import__()</span></code></a>,

  223. the return value when a submodule of a package was requested is normally the

  224. top-level package, unless a non-empty <em>fromlist</em> was given.</p>

  225. <div class="versionadded">

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

  227. </div>

  228. </dd></dl>

  229. 

  230. <dl class="c function">

  231. <dt class="sig sig-object c" id="c.PyImport_ImportModuleLevel">

  232. <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">PyImport_ImportModuleLevel</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>, <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">globals</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">locals</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">fromlist</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">level</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyImport_ImportModuleLevel" title="Link to this definition">¶</a><br /></dt>

  233. <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.PyImport_ImportModuleLevelObject" title="PyImport_ImportModuleLevelObject"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyImport_ImportModuleLevelObject()</span></code></a>, but the name is a

  234. UTF-8 encoded string instead of a Unicode object.</p>

  235. <div class="versionchanged">

  236. <p><span class="versionmodified changed">Changed in version 3.3: </span>Negative values for <em>level</em> are no longer accepted.</p>

  237. </div>

  238. </dd></dl>

  239. 

  240. <dl class="c function">

  241. <dt class="sig sig-object c" id="c.PyImport_Import">

  242. <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">PyImport_Import</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.PyImport_Import" title="Link to this definition">¶</a><br /></dt>

  243. <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>This is a higher-level interface that calls the current “import hook

  244. function” (with an explicit <em>level</em> of 0, meaning absolute import).  It

  245. invokes the <a class="reference internal" href="../library/functions.html#import__" title="__import__"><code class="xref py py-func docutils literal notranslate"><span class="pre">__import__()</span></code></a> function from the <code class="docutils literal notranslate"><span class="pre">__builtins__</span></code> of the

  246. current globals.  This means that the import is done using whatever import

  247. hooks are installed in the current environment.</p>

  248. <p>This function always uses absolute imports.</p>

  249. </dd></dl>

  250. 

  251. <dl class="c function">

  252. <dt class="sig sig-object c" id="c.PyImport_ReloadModule">

  253. <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">PyImport_ReloadModule</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">m</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyImport_ReloadModule" title="Link to this definition">¶</a><br /></dt>

  254. <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>Reload a module.  Return a new reference to the reloaded module, or <code class="docutils literal notranslate"><span class="pre">NULL</span></code> with

  255. an exception set on failure (the module still exists in this case).</p>

  256. </dd></dl>

  257. 

  258. <dl class="c function">

  259. <dt class="sig sig-object c" id="c.PyImport_AddModuleObject">

  260. <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">PyImport_AddModuleObject</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.PyImport_AddModuleObject" title="Link to this definition">¶</a><br /></dt>

  261. <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.7.</em><p>Return the module object corresponding to a module name.  The <em>name</em> argument

  262. may be of the form <code class="docutils literal notranslate"><span class="pre">package.module</span></code>. First check the modules dictionary if

  263. there’s one there, and if not, create a new one and insert it in the modules

  264. dictionary. Return <code class="docutils literal notranslate"><span class="pre">NULL</span></code> with an exception set on failure.</p>

  265. <div class="admonition note">

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

  267. <p>This function does not load or import the module; if the module wasn’t already

  268. loaded, you will get an empty module object. Use <a class="reference internal" href="#c.PyImport_ImportModule" title="PyImport_ImportModule"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyImport_ImportModule()</span></code></a>

  269. or one of its variants to import a module.  Package structures implied by a

  270. dotted name for <em>name</em> are not created if not already present.</p>

  271. </div>

  272. <div class="versionadded">

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

  274. </div>

  275. </dd></dl>

  276. 

  277. <dl class="c function">

  278. <dt class="sig sig-object c" id="c.PyImport_AddModule">

  279. <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">PyImport_AddModule</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.PyImport_AddModule" title="Link to this definition">¶</a><br /></dt>

  280. <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>Similar to <a class="reference internal" href="#c.PyImport_AddModuleObject" title="PyImport_AddModuleObject"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyImport_AddModuleObject()</span></code></a>, but the name is a UTF-8

  281. encoded string instead of a Unicode object.</p>

  282. </dd></dl>

  283. 

  284. <dl class="c function">

  285. <dt class="sig sig-object c" id="c.PyImport_ExecCodeModule">

  286. <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">PyImport_ExecCodeModule</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>, <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">co</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyImport_ExecCodeModule" title="Link to this definition">¶</a><br /></dt>

  287. <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-2">Given a module name (possibly of the form <code class="docutils literal notranslate"><span class="pre">package.module</span></code>) and a code object

  288. read from a Python bytecode file or obtained from the built-in function

  289. <a class="reference internal" href="../library/functions.html#compile" title="compile"><code class="xref py py-func docutils literal notranslate"><span class="pre">compile()</span></code></a>, load the module.  Return a new reference to the module object,

  290. or <code class="docutils literal notranslate"><span class="pre">NULL</span></code> with an exception set if an error occurred.  <em>name</em>

  291. is removed from <a class="reference internal" href="../library/sys.html#sys.modules" title="sys.modules"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.modules</span></code></a> in error cases, even if <em>name</em> was already

  292. in <a class="reference internal" href="../library/sys.html#sys.modules" title="sys.modules"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.modules</span></code></a> on entry to <a class="reference internal" href="#c.PyImport_ExecCodeModule" title="PyImport_ExecCodeModule"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyImport_ExecCodeModule()</span></code></a>.  Leaving

  293. incompletely initialized modules in <a class="reference internal" href="../library/sys.html#sys.modules" title="sys.modules"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.modules</span></code></a> is dangerous, as imports of

  294. such modules have no way to know that the module object is an unknown (and

  295. probably damaged with respect to the module author’s intents) state.</p>

  296. <p>The module’s <a class="reference internal" href="../reference/import.html#spec__" title="__spec__"><code class="xref py py-attr docutils literal notranslate"><span class="pre">__spec__</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> will be set, if

  297. not set already, with the appropriate values.  The spec’s loader will

  298. be set to the module’s <code class="docutils literal notranslate"><span class="pre">__loader__</span></code> (if set) and to an instance of

  299. <a class="reference internal" href="../library/importlib.html#importlib.machinery.SourceFileLoader" title="importlib.machinery.SourceFileLoader"><code class="xref py py-class docutils literal notranslate"><span class="pre">SourceFileLoader</span></code></a> otherwise.</p>

  300. <p>The module’s <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 will be set to the code object’s

  301. <a class="reference internal" href="../reference/datamodel.html#codeobject.co_filename" title="codeobject.co_filename"><code class="xref py py-attr docutils literal notranslate"><span class="pre">co_filename</span></code></a>.  If applicable, <a class="reference internal" href="../reference/import.html#cached__" title="__cached__"><code class="xref py py-attr docutils literal notranslate"><span class="pre">__cached__</span></code></a> will also

  302. be set.</p>

  303. <p>This function will reload the module if it was already imported.  See

  304. <a class="reference internal" href="#c.PyImport_ReloadModule" title="PyImport_ReloadModule"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyImport_ReloadModule()</span></code></a> for the intended way to reload a module.</p>

  305. <p>If <em>name</em> points to a dotted name of the form <code class="docutils literal notranslate"><span class="pre">package.module</span></code>, any package

  306. structures not already created will still not be created.</p>

  307. <p>See also <a class="reference internal" href="#c.PyImport_ExecCodeModuleEx" title="PyImport_ExecCodeModuleEx"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyImport_ExecCodeModuleEx()</span></code></a> and

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

  309. <div class="versionchanged">

  310. <p><span class="versionmodified changed">Changed in version 3.12: </span>The setting of <a class="reference internal" href="../reference/import.html#cached__" title="__cached__"><code class="xref py py-attr docutils literal notranslate"><span class="pre">__cached__</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> is

  311. deprecated. See <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> for

  312. alternatives.</p>

  313. </div>

  314. </dd></dl>

  315. 

  316. <dl class="c function">

  317. <dt class="sig sig-object c" id="c.PyImport_ExecCodeModuleEx">

  318. <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">PyImport_ExecCodeModuleEx</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>, <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">co</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">pathname</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyImport_ExecCodeModuleEx" title="Link to this definition">¶</a><br /></dt>

  319. <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>Like <a class="reference internal" href="#c.PyImport_ExecCodeModule" title="PyImport_ExecCodeModule"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyImport_ExecCodeModule()</span></code></a>, but the <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 of

  320. the module object is set to <em>pathname</em> if it is non-<code class="docutils literal notranslate"><span class="pre">NULL</span></code>.</p>

  321. <p>See also <a class="reference internal" href="#c.PyImport_ExecCodeModuleWithPathnames" title="PyImport_ExecCodeModuleWithPathnames"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyImport_ExecCodeModuleWithPathnames()</span></code></a>.</p>

  322. </dd></dl>

  323. 

  324. <dl class="c function">

  325. <dt class="sig sig-object c" id="c.PyImport_ExecCodeModuleObject">

  326. <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">PyImport_ExecCodeModuleObject</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>, <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">co</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">pathname</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">cpathname</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyImport_ExecCodeModuleObject" title="Link to this definition">¶</a><br /></dt>

  327. <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>Like <a class="reference internal" href="#c.PyImport_ExecCodeModuleEx" title="PyImport_ExecCodeModuleEx"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyImport_ExecCodeModuleEx()</span></code></a>, but the <a class="reference internal" href="../reference/import.html#cached__" title="__cached__"><code class="xref py py-attr docutils literal notranslate"><span class="pre">__cached__</span></code></a>

  328. attribute of the module object is set to <em>cpathname</em> if it is

  329. non-<code class="docutils literal notranslate"><span class="pre">NULL</span></code>.  Of the three functions, this is the preferred one to use.</p>

  330. <div class="versionadded">

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

  332. </div>

  333. <div class="versionchanged">

  334. <p><span class="versionmodified changed">Changed in version 3.12: </span>Setting <a class="reference internal" href="../reference/import.html#cached__" title="__cached__"><code class="xref py py-attr docutils literal notranslate"><span class="pre">__cached__</span></code></a> is deprecated. See

  335. <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> for alternatives.</p>

  336. </div>

  337. </dd></dl>

  338. 

  339. <dl class="c function">

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

  341. <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">PyImport_ExecCodeModuleWithPathnames</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>, <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">co</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">pathname</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">cpathname</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyImport_ExecCodeModuleWithPathnames" title="Link to this definition">¶</a><br /></dt>

  342. <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>Like <a class="reference internal" href="#c.PyImport_ExecCodeModuleObject" title="PyImport_ExecCodeModuleObject"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyImport_ExecCodeModuleObject()</span></code></a>, but <em>name</em>, <em>pathname</em> and

  343. <em>cpathname</em> are UTF-8 encoded strings. Attempts are also made to figure out

  344. what the value for <em>pathname</em> should be from <em>cpathname</em> if the former is

  345. set to <code class="docutils literal notranslate"><span class="pre">NULL</span></code>.</p>

  346. <div class="versionadded">

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

  348. </div>

  349. <div class="versionchanged">

  350. <p><span class="versionmodified changed">Changed in version 3.3: </span>Uses <code class="xref py py-func docutils literal notranslate"><span class="pre">imp.source_from_cache()</span></code> in calculating the source path if

  351. only the bytecode path is provided.</p>

  352. </div>

  353. <div class="versionchanged">

  354. <p><span class="versionmodified changed">Changed in version 3.12: </span>No longer uses the removed <code class="xref py py-mod docutils literal notranslate"><span class="pre">imp</span></code> module.</p>

  355. </div>

  356. </dd></dl>

  357. 

  358. <dl class="c function">

  359. <dt class="sig sig-object c" id="c.PyImport_GetMagicNumber">

  360. <span class="kt"><span class="pre">long</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyImport_GetMagicNumber</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyImport_GetMagicNumber" title="Link to this definition">¶</a><br /></dt>

  361. <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 magic number for Python bytecode files (a.k.a. <code class="file docutils literal notranslate"><span class="pre">.pyc</span></code> file).

  362. The magic number should be present in the first four bytes of the bytecode

  363. file, in little-endian byte order. Returns <code class="docutils literal notranslate"><span class="pre">-1</span></code> on error.</p>

  364. <div class="versionchanged">

  365. <p><span class="versionmodified changed">Changed in version 3.3: </span>Return value of <code class="docutils literal notranslate"><span class="pre">-1</span></code> upon failure.</p>

  366. </div>

  367. </dd></dl>

  368. 

  369. <dl class="c function">

  370. <dt class="sig sig-object c" id="c.PyImport_GetMagicTag">

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

  372. <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 magic tag string for <span class="target" id="index-3"></span><a class="pep reference external" href="https://peps.python.org/pep-3147/"><strong>PEP 3147</strong></a> format Python bytecode file

  373. names.  Keep in mind that the value at <code class="docutils literal notranslate"><span class="pre">sys.implementation.cache_tag</span></code> is

  374. authoritative and should be used instead of this function.</p>

  375. <div class="versionadded">

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

  377. </div>

  378. </dd></dl>

  379. 

  380. <dl class="c function">

  381. <dt class="sig sig-object c" id="c.PyImport_GetModuleDict">

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

  383. <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>Return the dictionary used for the module administration (a.k.a.

  384. <code class="docutils literal notranslate"><span class="pre">sys.modules</span></code>).  Note that this is a per-interpreter variable.</p>

  385. </dd></dl>

  386. 

  387. <dl class="c function">

  388. <dt class="sig sig-object c" id="c.PyImport_GetModule">

  389. <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">PyImport_GetModule</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.PyImport_GetModule" title="Link to this definition">¶</a><br /></dt>

  390. <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.8.</em><p>Return the already imported module with the given name.  If the

  391. module has not been imported yet then returns <code class="docutils literal notranslate"><span class="pre">NULL</span></code> but does not set

  392. an error.  Returns <code class="docutils literal notranslate"><span class="pre">NULL</span></code> and sets an error if the lookup failed.</p>

  393. <div class="versionadded">

  394. <p><span class="versionmodified added">New in version 3.7.</span></p>

  395. </div>

  396. </dd></dl>

  397. 

  398. <dl class="c function">

  399. <dt class="sig sig-object c" id="c.PyImport_GetImporter">

  400. <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">PyImport_GetImporter</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">path</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyImport_GetImporter" title="Link to this definition">¶</a><br /></dt>

  401. <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>Return a finder object for a <a class="reference internal" href="../library/sys.html#sys.path" title="sys.path"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.path</span></code></a>/<code class="xref py py-attr docutils literal notranslate"><span class="pre">pkg.__path__</span></code> item

  402. <em>path</em>, possibly by fetching it from the <a class="reference internal" href="../library/sys.html#sys.path_importer_cache" title="sys.path_importer_cache"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.path_importer_cache</span></code></a>

  403. dict.  If it wasn’t yet cached, traverse <a class="reference internal" href="../library/sys.html#sys.path_hooks" title="sys.path_hooks"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.path_hooks</span></code></a> until a hook

  404. is found that can handle the path item.  Return <code class="docutils literal notranslate"><span class="pre">None</span></code> if no hook could;

  405. this tells our caller that the <a class="reference internal" href="../glossary.html#term-path-based-finder"><span class="xref std std-term">path based finder</span></a> could not find a

  406. finder for this path item. Cache the result in <a class="reference internal" href="../library/sys.html#sys.path_importer_cache" title="sys.path_importer_cache"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.path_importer_cache</span></code></a>.

  407. Return a new reference to the finder object.</p>

  408. </dd></dl>

  409. 

  410. <dl class="c function">

  411. <dt class="sig sig-object c" id="c.PyImport_ImportFrozenModuleObject">

  412. <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyImport_ImportFrozenModuleObject</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.PyImport_ImportFrozenModuleObject" title="Link to this definition">¶</a><br /></dt>

  413. <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>Load a frozen module named <em>name</em>.  Return <code class="docutils literal notranslate"><span class="pre">1</span></code> for success, <code class="docutils literal notranslate"><span class="pre">0</span></code> if the

  414. module is not found, and <code class="docutils literal notranslate"><span class="pre">-1</span></code> with an exception set if the initialization

  415. failed.  To access the imported module on a successful load, use

  416. <a class="reference internal" href="#c.PyImport_ImportModule" title="PyImport_ImportModule"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyImport_ImportModule()</span></code></a>.  (Note the misnomer — this function would

  417. reload the module if it was already imported.)</p>

  418. <div class="versionadded">

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

  420. </div>

  421. <div class="versionchanged">

  422. <p><span class="versionmodified changed">Changed in version 3.4: </span>The <code class="docutils literal notranslate"><span class="pre">__file__</span></code> attribute is no longer set on the module.</p>

  423. </div>

  424. </dd></dl>

  425. 

  426. <dl class="c function">

  427. <dt class="sig sig-object c" id="c.PyImport_ImportFrozenModule">

  428. <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyImport_ImportFrozenModule</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.PyImport_ImportFrozenModule" title="Link to this definition">¶</a><br /></dt>

  429. <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.PyImport_ImportFrozenModuleObject" title="PyImport_ImportFrozenModuleObject"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyImport_ImportFrozenModuleObject()</span></code></a>, but the name is a

  430. UTF-8 encoded string instead of a Unicode object.</p>

  431. </dd></dl>

  432. 

  433. <dl class="c struct">

  434. <dt class="sig sig-object c" id="c._frozen">

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

  436. <dd><p id="index-4">This is the structure type definition for frozen module descriptors, as

  437. generated by the <strong class="program">freeze</strong> utility (see <code class="file docutils literal notranslate"><span class="pre">Tools/freeze/</span></code> in the

  438. Python source distribution).  Its definition, found in <code class="file docutils literal notranslate"><span class="pre">Include/import.h</span></code>,

  439. is:</p>

  440. <div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="k">struct</span><span class="w"> </span><span class="nc">_frozen</span><span class="w"> </span><span class="p">{</span>

  441. <span class="w">    </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="n">name</span><span class="p">;</span>

  442. <span class="w">    </span><span class="k">const</span><span class="w"> </span><span class="kt">unsigned</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="n">code</span><span class="p">;</span>

  443. <span class="w">    </span><span class="kt">int</span><span class="w"> </span><span class="n">size</span><span class="p">;</span>

  444. <span class="w">    </span><span class="kt">bool</span><span class="w"> </span><span class="n">is_package</span><span class="p">;</span>

  445. <span class="p">};</span>

  446. </pre></div>

  447. </div>

  448. <div class="versionchanged">

  449. <p><span class="versionmodified changed">Changed in version 3.11: </span>The new <code class="docutils literal notranslate"><span class="pre">is_package</span></code> field indicates whether the module is a package or not.

  450. This replaces setting the <code class="docutils literal notranslate"><span class="pre">size</span></code> field to a negative value.</p>

  451. </div>

  452. </dd></dl>

  453. 

  454. <dl class="c var">

  455. <dt class="sig sig-object c" id="c.PyImport_FrozenModules">

  456. <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><a class="reference internal" href="#c._frozen" title="_frozen"><span class="n"><span class="pre">_frozen</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">PyImport_FrozenModules</span></span></span><a class="headerlink" href="#c.PyImport_FrozenModules" title="Link to this definition">¶</a><br /></dt>

  457. <dd><p>This pointer is initialized to point to an array of <a class="reference internal" href="#c._frozen" title="_frozen"><code class="xref c c-struct docutils literal notranslate"><span class="pre">_frozen</span></code></a>

  458. records, terminated by one whose members are all <code class="docutils literal notranslate"><span class="pre">NULL</span></code> or zero.  When a frozen

  459. module is imported, it is searched in this table.  Third-party code could play

  460. tricks with this to provide a dynamically created collection of frozen modules.</p>

  461. </dd></dl>

  462. 

  463. <dl class="c function">

  464. <dt class="sig sig-object c" id="c.PyImport_AppendInittab">

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

  466. <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 single module to the existing table of built-in modules.  This is a

  467. convenience wrapper around <a class="reference internal" href="#c.PyImport_ExtendInittab" title="PyImport_ExtendInittab"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyImport_ExtendInittab()</span></code></a>, returning <code class="docutils literal notranslate"><span class="pre">-1</span></code> if

  468. the table could not be extended.  The new module can be imported by the name

  469. <em>name</em>, and uses the function <em>initfunc</em> as the initialization function called

  470. on the first attempted import.  This should be called before

  471. <a class="reference internal" href="init.html#c.Py_Initialize" title="Py_Initialize"><code class="xref c c-func docutils literal notranslate"><span class="pre">Py_Initialize()</span></code></a>.</p>

  472. </dd></dl>

  473. 

  474. <dl class="c struct">

  475. <dt class="sig sig-object c" id="c._inittab">

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

  477. <dd><p>Structure describing a single entry in the list of built-in modules.

  478. Programs which

  479. embed Python may use an array of these structures in conjunction with

  480. <a class="reference internal" href="#c.PyImport_ExtendInittab" title="PyImport_ExtendInittab"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyImport_ExtendInittab()</span></code></a> to provide additional built-in modules.

  481. The structure consists of two members:</p>

  482. <dl class="c member">

  483. <dt class="sig sig-object c" id="c._inittab.name">

  484. <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">name</span></span></span><a class="headerlink" href="#c._inittab.name" title="Link to this definition">¶</a><br /></dt>

  485. <dd><p>The module name, as an ASCII encoded string.</p>

  486. </dd></dl>

  487. 

  488. <dl class="c member">

  489. <dt class="sig sig-object c" id="c._inittab.initfunc">

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

  491. <dd><p>Initialization function for a module built into the interpreter.</p>

  492. </dd></dl>

  493. 

  494. </dd></dl>

  495. 

  496. <dl class="c function">

  497. <dt class="sig sig-object c" id="c.PyImport_ExtendInittab">

  498. <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyImport_ExtendInittab</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><a class="reference internal" href="#c._inittab" title="_inittab"><span class="n"><span class="pre">_inittab</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">newtab</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyImport_ExtendInittab" title="Link to this definition">¶</a><br /></dt>

  499. <dd><p>Add a collection of modules to the table of built-in modules.  The <em>newtab</em>

  500. array must end with a sentinel entry which contains <code class="docutils literal notranslate"><span class="pre">NULL</span></code> for the <a class="reference internal" href="#c._inittab.name" title="_inittab.name"><code class="xref c c-member docutils literal notranslate"><span class="pre">name</span></code></a>

  501. field; failure to provide the sentinel value can result in a memory fault.

  502. Returns <code class="docutils literal notranslate"><span class="pre">0</span></code> on success or <code class="docutils literal notranslate"><span class="pre">-1</span></code> if insufficient memory could be allocated to

  503. extend the internal table.  In the event of failure, no modules are added to the

  504. internal table.  This must be called before <a class="reference internal" href="init.html#c.Py_Initialize" title="Py_Initialize"><code class="xref c c-func docutils literal notranslate"><span class="pre">Py_Initialize()</span></code></a>.</p>

  505. <p>If Python is initialized multiple times, <a class="reference internal" href="#c.PyImport_AppendInittab" title="PyImport_AppendInittab"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyImport_AppendInittab()</span></code></a> or

  506. <a class="reference internal" href="#c.PyImport_ExtendInittab" title="PyImport_ExtendInittab"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyImport_ExtendInittab()</span></code></a> must be called before each Python

  507. initialization.</p>

  508. </dd></dl>

  509. 

  510. </section>

  511. 

  512. 

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

  514.           </div>

  515.         </div>

  516.       </div>

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

  518.         <div class="sphinxsidebarwrapper">

  519.   <div>

  520.     <h4>Previous topic</h4>

  521.     <p class="topless"><a href="sys.html"

  522.                           title="previous chapter">Operating System Utilities</a></p>

  523.   </div>

  524.   <div>

  525.     <h4>Next topic</h4>

  526.     <p class="topless"><a href="marshal.html"

  527.                           title="next chapter">Data marshalling support</a></p>

  528.   </div>

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

  530.     <h3>This Page</h3>

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

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

  533.       <li>

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

  535.             rel="nofollow">Show Source

  536.         </a>

  537.       </li>

  538.     </ul>

  539.   </div>

  540.         </div>

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

  542. <span>«</span>

  543. </div>

  544. 

  545.       </div>

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

  547.     </div>  

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

  549.       <h3>Navigation</h3>

  550.       <ul>

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

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

  553.              >index</a></li>

  554.         <li class="right" >

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

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

  557.         <li class="right" >

  558.           <a href="marshal.html" title="Data marshalling support"

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

  560.         <li class="right" >

  561.           <a href="sys.html" title="Operating System Utilities"

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

  563. 

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

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

  566.           <li class="switchers">

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

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

  569.           </li>

  570.           <li>

  571.               

  572.           </li>

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

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

  575.     </li>

  576. 

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

  578.           <li class="nav-item nav-item-2"><a href="utilities.html" >Utilities</a> &#187;</li>

  579.         <li class="nav-item nav-item-this"><a href="">Importing Modules</a></li>

  580.                 <li class="right">

  581.                     

  582. 

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

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

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

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

  587.         </form>

  588.     </div>

  589.                      |

  590.                 </li>

  591.             <li class="right">

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

  593.     Theme

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

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

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

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

  598.     </select>

  599. </label> |</li>

  600.             

  601.       </ul>

  602.     </div>  

  603.     <div class="footer">

  604.     &copy; 

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

  606.     

  607.     Copyright

  608.     

  609.       </a>

  610.      2001-2024, Python Software Foundation.

  611.     <br />

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

  613.     <br />

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

  615.     <br />

  616.     

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

  618.     

  619.     

  620.     <br />

  621. 

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

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

  624. <br />

  625.     <br />

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

  627.     

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

  629.     

  630.     <br />

  631. 

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

  633.     </div>

  634. 

  635.   </body>

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