Baoding-FenShuaJiang
/
Green_GoodERP18_FSJ_Standard
Vērot 1
Pievienot zvaigznīti 0
Vikivietne 捐赠
gooderp18绿色标准版
Nevar pievienot vairāk kā 25 tēmas Tēmai ir jāsākas ar burtu vai ciparu, tā var saturēt domu zīmes ('-') un var būt līdz 35 simboliem gara.
Koks: 0f75e31513
Atzari Tagi
${ item.name }
Izveidot atzaru ${ searchTerm }
no '0f75e31513'
${ noResults }
Green_GoodERP18_FSJ_Standard/python/Doc/html/c-api/init_config.html

1945 rindas
221KB
Neapstrādāts Vainot Vēsture 

  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="Python Initialization Configuration" />

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

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

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

  11. <meta property="og:description" content="Python can be initialized with Py_InitializeFromConfig() and the PyConfig structure. It can be preinitialized with Py_PreInitialize() and the PyPreConfig structure. There are two kinds of configura..." />

  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="Python can be initialized with Py_InitializeFromConfig() and the PyConfig structure. It can be preinitialized with Py_PreInitialize() and the PyPreConfig structure. There are two kinds of configura..." />

  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>Python Initialization Configuration &#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="Memory Management" href="memory.html" />

  39.     <link rel="prev" title="Initialization, Finalization, and Threads" href="init.html" />

  40.     <link rel="canonical" href="https://docs.python.org/3/c-api/init_config.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="#">Python Initialization Configuration</a><ul>

  99. <li><a class="reference internal" href="#example">Example</a></li>

  100. <li><a class="reference internal" href="#pywidestringlist">PyWideStringList</a></li>

  101. <li><a class="reference internal" href="#pystatus">PyStatus</a></li>

  102. <li><a class="reference internal" href="#pypreconfig">PyPreConfig</a></li>

  103. <li><a class="reference internal" href="#preinitialize-python-with-pypreconfig">Preinitialize Python with PyPreConfig</a></li>

  104. <li><a class="reference internal" href="#pyconfig">PyConfig</a></li>

  105. <li><a class="reference internal" href="#initialization-with-pyconfig">Initialization with PyConfig</a></li>

  106. <li><a class="reference internal" href="#isolated-configuration">Isolated Configuration</a></li>

  107. <li><a class="reference internal" href="#python-configuration">Python Configuration</a></li>

  108. <li><a class="reference internal" href="#python-path-configuration">Python Path Configuration</a></li>

  109. <li><a class="reference internal" href="#py-runmain">Py_RunMain()</a></li>

  110. <li><a class="reference internal" href="#py-getargcargv">Py_GetArgcArgv()</a></li>

  111. <li><a class="reference internal" href="#multi-phase-initialization-private-provisional-api">Multi-Phase Initialization Private Provisional API</a></li>

  112. </ul>

  113. </li>

  114. </ul>

  115. 

  116.   </div>

  117.   <div>

  118.     <h4>Previous topic</h4>

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

  120.                           title="previous chapter">Initialization, Finalization, and Threads</a></p>

  121.   </div>

  122.   <div>

  123.     <h4>Next topic</h4>

  124.     <p class="topless"><a href="memory.html"

  125.                           title="next chapter">Memory Management</a></p>

  126.   </div>

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

  128.     <h3>This Page</h3>

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

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

  131.       <li>

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

  133.             rel="nofollow">Show Source

  134.         </a>

  135.       </li>

  136.     </ul>

  137.   </div>

  138.         </nav>

  139.     </div>

  140. </div>

  141. 

  142.   

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

  144.       <h3>Navigation</h3>

  145.       <ul>

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

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

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

  149.         <li class="right" >

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

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

  152.         <li class="right" >

  153.           <a href="memory.html" title="Memory Management"

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

  155.         <li class="right" >

  156.           <a href="init.html" title="Initialization, Finalization, and Threads"

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

  158. 

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

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

  161.           <li class="switchers">

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

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

  164.           </li>

  165.           <li>

  166.               

  167.           </li>

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

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

  170.     </li>

  171. 

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

  173.         <li class="nav-item nav-item-this"><a href="">Python Initialization Configuration</a></li>

  174.                 <li class="right">

  175.                     

  176. 

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

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

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

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

  181.         </form>

  182.     </div>

  183.                      |

  184.                 </li>

  185.             <li class="right">

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

  187.     Theme

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

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

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

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

  192.     </select>

  193. </label> |</li>

  194.             

  195.       </ul>

  196.     </div>    

  197. 

  198.     <div class="document">

  199.       <div class="documentwrapper">

  200.         <div class="bodywrapper">

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

  202.             

  203.   <section id="python-initialization-configuration">

  204. <span id="init-config"></span><h1>Python Initialization Configuration<a class="headerlink" href="#python-initialization-configuration" title="Link to this heading">¶</a></h1>

  205. <div class="versionadded">

  206. <p><span class="versionmodified added">New in version 3.8.</span></p>

  207. </div>

  208. <p>Python can be initialized with <a class="reference internal" href="#c.Py_InitializeFromConfig" title="Py_InitializeFromConfig"><code class="xref c c-func docutils literal notranslate"><span class="pre">Py_InitializeFromConfig()</span></code></a> and the

  209. <a class="reference internal" href="#c.PyConfig" title="PyConfig"><code class="xref c c-type docutils literal notranslate"><span class="pre">PyConfig</span></code></a> structure. It can be preinitialized with

  210. <a class="reference internal" href="#c.Py_PreInitialize" title="Py_PreInitialize"><code class="xref c c-func docutils literal notranslate"><span class="pre">Py_PreInitialize()</span></code></a> and the <a class="reference internal" href="#c.PyPreConfig" title="PyPreConfig"><code class="xref c c-type docutils literal notranslate"><span class="pre">PyPreConfig</span></code></a> structure.</p>

  211. <p>There are two kinds of configuration:</p>

  212. <ul class="simple">

  213. <li><p>The <a class="reference internal" href="#init-python-config"><span class="std std-ref">Python Configuration</span></a> can be used to build a

  214. customized Python which behaves as the regular Python. For example,

  215. environment variables and command line arguments are used to configure

  216. Python.</p></li>

  217. <li><p>The <a class="reference internal" href="#init-isolated-conf"><span class="std std-ref">Isolated Configuration</span></a> can be used to embed

  218. Python into an application. It isolates Python from the system. For example,

  219. environment variables are ignored, the LC_CTYPE locale is left unchanged and

  220. no signal handler is registered.</p></li>

  221. </ul>

  222. <p>The <a class="reference internal" href="#c.Py_RunMain" title="Py_RunMain"><code class="xref c c-func docutils literal notranslate"><span class="pre">Py_RunMain()</span></code></a> function can be used to write a customized Python

  223. program.</p>

  224. <p>See also <a class="reference internal" href="init.html#initialization"><span class="std std-ref">Initialization, Finalization, and Threads</span></a>.</p>

  225. <div class="admonition seealso">

  226. <p class="admonition-title">See also</p>

  227. <p><span class="target" id="index-0"></span><a class="pep reference external" href="https://peps.python.org/pep-0587/"><strong>PEP 587</strong></a> “Python Initialization Configuration”.</p>

  228. </div>

  229. <section id="example">

  230. <h2>Example<a class="headerlink" href="#example" title="Link to this heading">¶</a></h2>

  231. <p>Example of customized Python always running in isolated mode:</p>

  232. <div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="kt">int</span><span class="w"> </span><span class="nf">main</span><span class="p">(</span><span class="kt">int</span><span class="w"> </span><span class="n">argc</span><span class="p">,</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">**</span><span class="n">argv</span><span class="p">)</span>

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

  234. <span class="w">    </span><span class="n">PyStatus</span><span class="w"> </span><span class="n">status</span><span class="p">;</span>

  235. 

  236. <span class="w">    </span><span class="n">PyConfig</span><span class="w"> </span><span class="n">config</span><span class="p">;</span>

  237. <span class="w">    </span><span class="n">PyConfig_InitPythonConfig</span><span class="p">(</span><span class="o">&amp;</span><span class="n">config</span><span class="p">);</span>

  238. <span class="w">    </span><span class="n">config</span><span class="p">.</span><span class="n">isolated</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span>

  239. 

  240. <span class="w">    </span><span class="cm">/* Decode command line arguments.</span>

  241. <span class="cm">       Implicitly preinitialize Python (in isolated mode). */</span>

  242. <span class="w">    </span><span class="n">status</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">PyConfig_SetBytesArgv</span><span class="p">(</span><span class="o">&amp;</span><span class="n">config</span><span class="p">,</span><span class="w"> </span><span class="n">argc</span><span class="p">,</span><span class="w"> </span><span class="n">argv</span><span class="p">);</span>

  243. <span class="w">    </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">PyStatus_Exception</span><span class="p">(</span><span class="n">status</span><span class="p">))</span><span class="w"> </span><span class="p">{</span>

  244. <span class="w">        </span><span class="k">goto</span><span class="w"> </span><span class="n">exception</span><span class="p">;</span>

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

  246. 

  247. <span class="w">    </span><span class="n">status</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Py_InitializeFromConfig</span><span class="p">(</span><span class="o">&amp;</span><span class="n">config</span><span class="p">);</span>

  248. <span class="w">    </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">PyStatus_Exception</span><span class="p">(</span><span class="n">status</span><span class="p">))</span><span class="w"> </span><span class="p">{</span>

  249. <span class="w">        </span><span class="k">goto</span><span class="w"> </span><span class="n">exception</span><span class="p">;</span>

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

  251. <span class="w">    </span><span class="n">PyConfig_Clear</span><span class="p">(</span><span class="o">&amp;</span><span class="n">config</span><span class="p">);</span>

  252. 

  253. <span class="w">    </span><span class="k">return</span><span class="w"> </span><span class="n">Py_RunMain</span><span class="p">();</span>

  254. 

  255. <span class="nl">exception</span><span class="p">:</span>

  256. <span class="w">    </span><span class="n">PyConfig_Clear</span><span class="p">(</span><span class="o">&amp;</span><span class="n">config</span><span class="p">);</span>

  257. <span class="w">    </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">PyStatus_IsExit</span><span class="p">(</span><span class="n">status</span><span class="p">))</span><span class="w"> </span><span class="p">{</span>

  258. <span class="w">        </span><span class="k">return</span><span class="w"> </span><span class="n">status</span><span class="p">.</span><span class="n">exitcode</span><span class="p">;</span>

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

  260. <span class="w">    </span><span class="cm">/* Display the error message and exit the process with</span>

  261. <span class="cm">       non-zero exit code */</span>

  262. <span class="w">    </span><span class="n">Py_ExitStatusException</span><span class="p">(</span><span class="n">status</span><span class="p">);</span>

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

  264. </pre></div>

  265. </div>

  266. </section>

  267. <section id="pywidestringlist">

  268. <h2>PyWideStringList<a class="headerlink" href="#pywidestringlist" title="Link to this heading">¶</a></h2>

  269. <dl class="c type">

  270. <dt class="sig sig-object c" id="c.PyWideStringList">

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

  272. <dd><p>List of <code class="docutils literal notranslate"><span class="pre">wchar_t*</span></code> strings.</p>

  273. <p>If <em>length</em> is non-zero, <em>items</em> must be non-<code class="docutils literal notranslate"><span class="pre">NULL</span></code> and all strings must be

  274. non-<code class="docutils literal notranslate"><span class="pre">NULL</span></code>.</p>

  275. <p>Methods:</p>

  276. <dl class="c function">

  277. <dt class="sig sig-object c" id="c.PyWideStringList_Append">

  278. <a class="reference internal" href="#c.PyStatus" title="PyStatus"><span class="n"><span class="pre">PyStatus</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyWideStringList_Append</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#c.PyWideStringList" title="PyWideStringList"><span class="n"><span class="pre">PyWideStringList</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">list</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">wchar_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">item</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyWideStringList_Append" title="Link to this definition">¶</a><br /></dt>

  279. <dd><p>Append <em>item</em> to <em>list</em>.</p>

  280. <p>Python must be preinitialized to call this function.</p>

  281. </dd></dl>

  282. 

  283. <dl class="c function">

  284. <dt class="sig sig-object c" id="c.PyWideStringList_Insert">

  285. <a class="reference internal" href="#c.PyStatus" title="PyStatus"><span class="n"><span class="pre">PyStatus</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyWideStringList_Insert</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#c.PyWideStringList" title="PyWideStringList"><span class="n"><span class="pre">PyWideStringList</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">list</span></span>, <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="n"><span class="pre">index</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">wchar_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">item</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyWideStringList_Insert" title="Link to this definition">¶</a><br /></dt>

  286. <dd><p>Insert <em>item</em> into <em>list</em> at <em>index</em>.</p>

  287. <p>If <em>index</em> is greater than or equal to <em>list</em> length, append <em>item</em> to

  288. <em>list</em>.</p>

  289. <p><em>index</em> must be greater than or equal to <code class="docutils literal notranslate"><span class="pre">0</span></code>.</p>

  290. <p>Python must be preinitialized to call this function.</p>

  291. </dd></dl>

  292. 

  293. <p>Structure fields:</p>

  294. <dl class="c member">

  295. <dt class="sig sig-object c" id="c.PyWideStringList.length">

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

  297. <dd><p>List length.</p>

  298. </dd></dl>

  299. 

  300. <dl class="c member">

  301. <dt class="sig sig-object c" id="c.PyWideStringList.items">

  302. <span class="n"><span class="pre">wchar_t</span></span><span class="w"> </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">items</span></span></span><a class="headerlink" href="#c.PyWideStringList.items" title="Link to this definition">¶</a><br /></dt>

  303. <dd><p>List items.</p>

  304. </dd></dl>

  305. 

  306. </dd></dl>

  307. 

  308. </section>

  309. <section id="pystatus">

  310. <h2>PyStatus<a class="headerlink" href="#pystatus" title="Link to this heading">¶</a></h2>

  311. <dl class="c type">

  312. <dt class="sig sig-object c" id="c.PyStatus">

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

  314. <dd><p>Structure to store an initialization function status: success, error

  315. or exit.</p>

  316. <p>For an error, it can store the C function name which created the error.</p>

  317. <p>Structure fields:</p>

  318. <dl class="c member">

  319. <dt class="sig sig-object c" id="c.PyStatus.exitcode">

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

  321. <dd><p>Exit code. Argument passed to <code class="docutils literal notranslate"><span class="pre">exit()</span></code>.</p>

  322. </dd></dl>

  323. 

  324. <dl class="c member">

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

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

  327. <dd><p>Error message.</p>

  328. </dd></dl>

  329. 

  330. <dl class="c member">

  331. <dt class="sig sig-object c" id="c.PyStatus.func">

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

  333. <dd><p>Name of the function which created an error, can be <code class="docutils literal notranslate"><span class="pre">NULL</span></code>.</p>

  334. </dd></dl>

  335. 

  336. <p>Functions to create a status:</p>

  337. <dl class="c function">

  338. <dt class="sig sig-object c" id="c.PyStatus_Ok">

  339. <a class="reference internal" href="#c.PyStatus" title="PyStatus"><span class="n"><span class="pre">PyStatus</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyStatus_Ok</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">void</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyStatus_Ok" title="Link to this definition">¶</a><br /></dt>

  340. <dd><p>Success.</p>

  341. </dd></dl>

  342. 

  343. <dl class="c function">

  344. <dt class="sig sig-object c" id="c.PyStatus_Error">

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

  346. <dd><p>Initialization error with a message.</p>

  347. <p><em>err_msg</em> must not be <code class="docutils literal notranslate"><span class="pre">NULL</span></code>.</p>

  348. </dd></dl>

  349. 

  350. <dl class="c function">

  351. <dt class="sig sig-object c" id="c.PyStatus_NoMemory">

  352. <a class="reference internal" href="#c.PyStatus" title="PyStatus"><span class="n"><span class="pre">PyStatus</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyStatus_NoMemory</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">void</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyStatus_NoMemory" title="Link to this definition">¶</a><br /></dt>

  353. <dd><p>Memory allocation failure (out of memory).</p>

  354. </dd></dl>

  355. 

  356. <dl class="c function">

  357. <dt class="sig sig-object c" id="c.PyStatus_Exit">

  358. <a class="reference internal" href="#c.PyStatus" title="PyStatus"><span class="n"><span class="pre">PyStatus</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyStatus_Exit</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">exitcode</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyStatus_Exit" title="Link to this definition">¶</a><br /></dt>

  359. <dd><p>Exit Python with the specified exit code.</p>

  360. </dd></dl>

  361. 

  362. <p>Functions to handle a status:</p>

  363. <dl class="c function">

  364. <dt class="sig sig-object c" id="c.PyStatus_Exception">

  365. <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyStatus_Exception</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#c.PyStatus" title="PyStatus"><span class="n"><span class="pre">PyStatus</span></span></a><span class="w"> </span><span class="n"><span class="pre">status</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyStatus_Exception" title="Link to this definition">¶</a><br /></dt>

  366. <dd><p>Is the status an error or an exit? If true, the exception must be

  367. handled; by calling <a class="reference internal" href="#c.Py_ExitStatusException" title="Py_ExitStatusException"><code class="xref c c-func docutils literal notranslate"><span class="pre">Py_ExitStatusException()</span></code></a> for example.</p>

  368. </dd></dl>

  369. 

  370. <dl class="c function">

  371. <dt class="sig sig-object c" id="c.PyStatus_IsError">

  372. <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyStatus_IsError</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#c.PyStatus" title="PyStatus"><span class="n"><span class="pre">PyStatus</span></span></a><span class="w"> </span><span class="n"><span class="pre">status</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyStatus_IsError" title="Link to this definition">¶</a><br /></dt>

  373. <dd><p>Is the result an error?</p>

  374. </dd></dl>

  375. 

  376. <dl class="c function">

  377. <dt class="sig sig-object c" id="c.PyStatus_IsExit">

  378. <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyStatus_IsExit</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#c.PyStatus" title="PyStatus"><span class="n"><span class="pre">PyStatus</span></span></a><span class="w"> </span><span class="n"><span class="pre">status</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyStatus_IsExit" title="Link to this definition">¶</a><br /></dt>

  379. <dd><p>Is the result an exit?</p>

  380. </dd></dl>

  381. 

  382. <dl class="c function">

  383. <dt class="sig sig-object c" id="c.Py_ExitStatusException">

  384. <span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Py_ExitStatusException</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#c.PyStatus" title="PyStatus"><span class="n"><span class="pre">PyStatus</span></span></a><span class="w"> </span><span class="n"><span class="pre">status</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.Py_ExitStatusException" title="Link to this definition">¶</a><br /></dt>

  385. <dd><p>Call <code class="docutils literal notranslate"><span class="pre">exit(exitcode)</span></code> if <em>status</em> is an exit. Print the error

  386. message and exit with a non-zero exit code if <em>status</em> is an error.  Must

  387. only be called if <code class="docutils literal notranslate"><span class="pre">PyStatus_Exception(status)</span></code> is non-zero.</p>

  388. </dd></dl>

  389. 

  390. </dd></dl>

  391. 

  392. <div class="admonition note">

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

  394. <p>Internally, Python uses macros which set <code class="docutils literal notranslate"><span class="pre">PyStatus.func</span></code>,

  395. whereas functions to create a status set <code class="docutils literal notranslate"><span class="pre">func</span></code> to <code class="docutils literal notranslate"><span class="pre">NULL</span></code>.</p>

  396. </div>

  397. <p>Example:</p>

  398. <div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="n">PyStatus</span><span class="w"> </span><span class="nf">alloc</span><span class="p">(</span><span class="kt">void</span><span class="w"> </span><span class="o">**</span><span class="n">ptr</span><span class="p">,</span><span class="w"> </span><span class="kt">size_t</span><span class="w"> </span><span class="n">size</span><span class="p">)</span>

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

  400. <span class="w">    </span><span class="o">*</span><span class="n">ptr</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">PyMem_RawMalloc</span><span class="p">(</span><span class="n">size</span><span class="p">);</span>

  401. <span class="w">    </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="o">*</span><span class="n">ptr</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>

  402. <span class="w">        </span><span class="k">return</span><span class="w"> </span><span class="n">PyStatus_NoMemory</span><span class="p">();</span>

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

  404. <span class="w">    </span><span class="k">return</span><span class="w"> </span><span class="n">PyStatus_Ok</span><span class="p">();</span>

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

  406. 

  407. <span class="kt">int</span><span class="w"> </span><span class="nf">main</span><span class="p">(</span><span class="kt">int</span><span class="w"> </span><span class="n">argc</span><span class="p">,</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">**</span><span class="n">argv</span><span class="p">)</span>

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

  409. <span class="w">    </span><span class="kt">void</span><span class="w"> </span><span class="o">*</span><span class="n">ptr</span><span class="p">;</span>

  410. <span class="w">    </span><span class="n">PyStatus</span><span class="w"> </span><span class="n">status</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">alloc</span><span class="p">(</span><span class="o">&amp;</span><span class="n">ptr</span><span class="p">,</span><span class="w"> </span><span class="mi">16</span><span class="p">);</span>

  411. <span class="w">    </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">PyStatus_Exception</span><span class="p">(</span><span class="n">status</span><span class="p">))</span><span class="w"> </span><span class="p">{</span>

  412. <span class="w">        </span><span class="n">Py_ExitStatusException</span><span class="p">(</span><span class="n">status</span><span class="p">);</span>

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

  414. <span class="w">    </span><span class="n">PyMem_Free</span><span class="p">(</span><span class="n">ptr</span><span class="p">);</span>

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

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

  417. </pre></div>

  418. </div>

  419. </section>

  420. <section id="pypreconfig">

  421. <h2>PyPreConfig<a class="headerlink" href="#pypreconfig" title="Link to this heading">¶</a></h2>

  422. <dl class="c type">

  423. <dt class="sig sig-object c" id="c.PyPreConfig">

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

  425. <dd><p>Structure used to preinitialize Python.</p>

  426. <p>Function to initialize a preconfiguration:</p>

  427. <dl class="c function">

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

  429. <span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyPreConfig_InitPythonConfig</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#c.PyPreConfig" title="PyPreConfig"><span class="n"><span class="pre">PyPreConfig</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">preconfig</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyPreConfig_InitPythonConfig" title="Link to this definition">¶</a><br /></dt>

  430. <dd><p>Initialize the preconfiguration with <a class="reference internal" href="#init-python-config"><span class="std std-ref">Python Configuration</span></a>.</p>

  431. </dd></dl>

  432. 

  433. <dl class="c function">

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

  435. <span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyPreConfig_InitIsolatedConfig</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#c.PyPreConfig" title="PyPreConfig"><span class="n"><span class="pre">PyPreConfig</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">preconfig</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyPreConfig_InitIsolatedConfig" title="Link to this definition">¶</a><br /></dt>

  436. <dd><p>Initialize the preconfiguration with <a class="reference internal" href="#init-isolated-conf"><span class="std std-ref">Isolated Configuration</span></a>.</p>

  437. </dd></dl>

  438. 

  439. <p>Structure fields:</p>

  440. <dl class="c member">

  441. <dt class="sig sig-object c" id="c.PyPreConfig.allocator">

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

  443. <dd><p>Name of the Python memory allocators:</p>

  444. <ul class="simple">

  445. <li><p><code class="docutils literal notranslate"><span class="pre">PYMEM_ALLOCATOR_NOT_SET</span></code> (<code class="docutils literal notranslate"><span class="pre">0</span></code>): don’t change memory allocators

  446. (use defaults).</p></li>

  447. <li><p><code class="docutils literal notranslate"><span class="pre">PYMEM_ALLOCATOR_DEFAULT</span></code> (<code class="docutils literal notranslate"><span class="pre">1</span></code>): <a class="reference internal" href="memory.html#default-memory-allocators"><span class="std std-ref">default memory allocators</span></a>.</p></li>

  448. <li><p><code class="docutils literal notranslate"><span class="pre">PYMEM_ALLOCATOR_DEBUG</span></code> (<code class="docutils literal notranslate"><span class="pre">2</span></code>): <a class="reference internal" href="memory.html#default-memory-allocators"><span class="std std-ref">default memory allocators</span></a> with <a class="reference internal" href="memory.html#pymem-debug-hooks"><span class="std std-ref">debug hooks</span></a>.</p></li>

  449. <li><p><code class="docutils literal notranslate"><span class="pre">PYMEM_ALLOCATOR_MALLOC</span></code> (<code class="docutils literal notranslate"><span class="pre">3</span></code>): use <code class="docutils literal notranslate"><span class="pre">malloc()</span></code> of the C library.</p></li>

  450. <li><p><code class="docutils literal notranslate"><span class="pre">PYMEM_ALLOCATOR_MALLOC_DEBUG</span></code> (<code class="docutils literal notranslate"><span class="pre">4</span></code>): force usage of

  451. <code class="docutils literal notranslate"><span class="pre">malloc()</span></code> with <a class="reference internal" href="memory.html#pymem-debug-hooks"><span class="std std-ref">debug hooks</span></a>.</p></li>

  452. <li><p><code class="docutils literal notranslate"><span class="pre">PYMEM_ALLOCATOR_PYMALLOC</span></code> (<code class="docutils literal notranslate"><span class="pre">5</span></code>): <a class="reference internal" href="memory.html#pymalloc"><span class="std std-ref">Python pymalloc memory

  453. allocator</span></a>.</p></li>

  454. <li><p><code class="docutils literal notranslate"><span class="pre">PYMEM_ALLOCATOR_PYMALLOC_DEBUG</span></code> (<code class="docutils literal notranslate"><span class="pre">6</span></code>): <a class="reference internal" href="memory.html#pymalloc"><span class="std std-ref">Python pymalloc

  455. memory allocator</span></a> with <a class="reference internal" href="memory.html#pymem-debug-hooks"><span class="std std-ref">debug hooks</span></a>.</p></li>

  456. </ul>

  457. <p><code class="docutils literal notranslate"><span class="pre">PYMEM_ALLOCATOR_PYMALLOC</span></code> and <code class="docutils literal notranslate"><span class="pre">PYMEM_ALLOCATOR_PYMALLOC_DEBUG</span></code> are

  458. not supported if Python is <a class="reference internal" href="../using/configure.html#cmdoption-without-pymalloc"><code class="xref std std-option docutils literal notranslate"><span class="pre">configured</span> <span class="pre">using</span> <span class="pre">--without-pymalloc</span></code></a>.</p>

  459. <p>See <a class="reference internal" href="memory.html#memory"><span class="std std-ref">Memory Management</span></a>.</p>

  460. <p>Default: <code class="docutils literal notranslate"><span class="pre">PYMEM_ALLOCATOR_NOT_SET</span></code>.</p>

  461. </dd></dl>

  462. 

  463. <dl class="c member">

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

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

  466. <dd><p>Set the LC_CTYPE locale to the user preferred locale.</p>

  467. <p>If equals to <code class="docutils literal notranslate"><span class="pre">0</span></code>, set <a class="reference internal" href="#c.PyPreConfig.coerce_c_locale" title="PyPreConfig.coerce_c_locale"><code class="xref c c-member docutils literal notranslate"><span class="pre">coerce_c_locale</span></code></a> and

  468. <a class="reference internal" href="#c.PyPreConfig.coerce_c_locale_warn" title="PyPreConfig.coerce_c_locale_warn"><code class="xref c c-member docutils literal notranslate"><span class="pre">coerce_c_locale_warn</span></code></a> members to <code class="docutils literal notranslate"><span class="pre">0</span></code>.</p>

  469. <p>See the <a class="reference internal" href="../glossary.html#term-locale-encoding"><span class="xref std std-term">locale encoding</span></a>.</p>

  470. <p>Default: <code class="docutils literal notranslate"><span class="pre">1</span></code> in Python config, <code class="docutils literal notranslate"><span class="pre">0</span></code> in isolated config.</p>

  471. </dd></dl>

  472. 

  473. <dl class="c member">

  474. <dt class="sig sig-object c" id="c.PyPreConfig.coerce_c_locale">

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

  476. <dd><p>If equals to <code class="docutils literal notranslate"><span class="pre">2</span></code>, coerce the C locale.</p>

  477. <p>If equals to <code class="docutils literal notranslate"><span class="pre">1</span></code>, read the LC_CTYPE locale to decide if it should be

  478. coerced.</p>

  479. <p>See the <a class="reference internal" href="../glossary.html#term-locale-encoding"><span class="xref std std-term">locale encoding</span></a>.</p>

  480. <p>Default: <code class="docutils literal notranslate"><span class="pre">-1</span></code> in Python config, <code class="docutils literal notranslate"><span class="pre">0</span></code> in isolated config.</p>

  481. </dd></dl>

  482. 

  483. <dl class="c member">

  484. <dt class="sig sig-object c" id="c.PyPreConfig.coerce_c_locale_warn">

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

  486. <dd><p>If non-zero, emit a warning if the C locale is coerced.</p>

  487. <p>Default: <code class="docutils literal notranslate"><span class="pre">-1</span></code> in Python config, <code class="docutils literal notranslate"><span class="pre">0</span></code> in isolated config.</p>

  488. </dd></dl>

  489. 

  490. <dl class="c member">

  491. <dt class="sig sig-object c" id="c.PyPreConfig.dev_mode">

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

  493. <dd><p><a class="reference internal" href="../library/devmode.html#devmode"><span class="std std-ref">Python Development Mode</span></a>: see

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

  495. <p>Default: <code class="docutils literal notranslate"><span class="pre">-1</span></code> in Python mode, <code class="docutils literal notranslate"><span class="pre">0</span></code> in isolated mode.</p>

  496. </dd></dl>

  497. 

  498. <dl class="c member">

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

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

  501. <dd><p>Isolated mode: see <a class="reference internal" href="#c.PyConfig.isolated" title="PyConfig.isolated"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.isolated</span></code></a>.</p>

  502. <p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code> in Python mode, <code class="docutils literal notranslate"><span class="pre">1</span></code> in isolated mode.</p>

  503. </dd></dl>

  504. 

  505. <dl class="c member">

  506. <dt class="sig sig-object c" id="c.PyPreConfig.legacy_windows_fs_encoding">

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

  508. <dd><p>If non-zero:</p>

  509. <ul class="simple">

  510. <li><p>Set <a class="reference internal" href="#c.PyPreConfig.utf8_mode" title="PyPreConfig.utf8_mode"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyPreConfig.utf8_mode</span></code></a> to <code class="docutils literal notranslate"><span class="pre">0</span></code>,</p></li>

  511. <li><p>Set <a class="reference internal" href="#c.PyConfig.filesystem_encoding" title="PyConfig.filesystem_encoding"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.filesystem_encoding</span></code></a> to <code class="docutils literal notranslate"><span class="pre">&quot;mbcs&quot;</span></code>,</p></li>

  512. <li><p>Set <a class="reference internal" href="#c.PyConfig.filesystem_errors" title="PyConfig.filesystem_errors"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.filesystem_errors</span></code></a> to <code class="docutils literal notranslate"><span class="pre">&quot;replace&quot;</span></code>.</p></li>

  513. </ul>

  514. <p>Initialized the from <span class="target" id="index-1"></span><a class="reference internal" href="../using/cmdline.html#envvar-PYTHONLEGACYWINDOWSFSENCODING"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PYTHONLEGACYWINDOWSFSENCODING</span></code></a> environment

  515. variable value.</p>

  516. <p>Only available on Windows. <code class="docutils literal notranslate"><span class="pre">#ifdef</span> <span class="pre">MS_WINDOWS</span></code> macro can be used for

  517. Windows specific code.</p>

  518. <p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code>.</p>

  519. </dd></dl>

  520. 

  521. <dl class="c member">

  522. <dt class="sig sig-object c" id="c.PyPreConfig.parse_argv">

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

  524. <dd><p>If non-zero, <a class="reference internal" href="#c.Py_PreInitializeFromArgs" title="Py_PreInitializeFromArgs"><code class="xref c c-func docutils literal notranslate"><span class="pre">Py_PreInitializeFromArgs()</span></code></a> and

  525. <a class="reference internal" href="#c.Py_PreInitializeFromBytesArgs" title="Py_PreInitializeFromBytesArgs"><code class="xref c c-func docutils literal notranslate"><span class="pre">Py_PreInitializeFromBytesArgs()</span></code></a> parse their <code class="docutils literal notranslate"><span class="pre">argv</span></code> argument the

  526. same way the regular Python parses command line arguments: see

  527. <a class="reference internal" href="../using/cmdline.html#using-on-cmdline"><span class="std std-ref">Command Line Arguments</span></a>.</p>

  528. <p>Default: <code class="docutils literal notranslate"><span class="pre">1</span></code> in Python config, <code class="docutils literal notranslate"><span class="pre">0</span></code> in isolated config.</p>

  529. </dd></dl>

  530. 

  531. <dl class="c member">

  532. <dt class="sig sig-object c" id="c.PyPreConfig.use_environment">

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

  534. <dd><p>Use <a class="reference internal" href="../using/cmdline.html#using-on-envvars"><span class="std std-ref">environment variables</span></a>? See

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

  536. <p>Default: <code class="docutils literal notranslate"><span class="pre">1</span></code> in Python config and <code class="docutils literal notranslate"><span class="pre">0</span></code> in isolated config.</p>

  537. </dd></dl>

  538. 

  539. <dl class="c member">

  540. <dt class="sig sig-object c" id="c.PyPreConfig.utf8_mode">

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

  542. <dd><p>If non-zero, enable the <a class="reference internal" href="../library/os.html#utf8-mode"><span class="std std-ref">Python UTF-8 Mode</span></a>.</p>

  543. <p>Set to <code class="docutils literal notranslate"><span class="pre">0</span></code> or <code class="docutils literal notranslate"><span class="pre">1</span></code> by the <a class="reference internal" href="../using/cmdline.html#cmdoption-X"><code class="xref std std-option docutils literal notranslate"><span class="pre">-X</span> <span class="pre">utf8</span></code></a> command line option

  544. and the <span class="target" id="index-2"></span><a class="reference internal" href="../using/cmdline.html#envvar-PYTHONUTF8"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PYTHONUTF8</span></code></a> environment variable.</p>

  545. <p>Also set to <code class="docutils literal notranslate"><span class="pre">1</span></code> if the <code class="docutils literal notranslate"><span class="pre">LC_CTYPE</span></code> locale is <code class="docutils literal notranslate"><span class="pre">C</span></code> or <code class="docutils literal notranslate"><span class="pre">POSIX</span></code>.</p>

  546. <p>Default: <code class="docutils literal notranslate"><span class="pre">-1</span></code> in Python config and <code class="docutils literal notranslate"><span class="pre">0</span></code> in isolated config.</p>

  547. </dd></dl>

  548. 

  549. </dd></dl>

  550. 

  551. </section>

  552. <section id="preinitialize-python-with-pypreconfig">

  553. <span id="c-preinit"></span><h2>Preinitialize Python with PyPreConfig<a class="headerlink" href="#preinitialize-python-with-pypreconfig" title="Link to this heading">¶</a></h2>

  554. <p>The preinitialization of Python:</p>

  555. <ul class="simple">

  556. <li><p>Set the Python memory allocators (<a class="reference internal" href="#c.PyPreConfig.allocator" title="PyPreConfig.allocator"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyPreConfig.allocator</span></code></a>)</p></li>

  557. <li><p>Configure the LC_CTYPE locale (<a class="reference internal" href="../glossary.html#term-locale-encoding"><span class="xref std std-term">locale encoding</span></a>)</p></li>

  558. <li><p>Set the <a class="reference internal" href="../library/os.html#utf8-mode"><span class="std std-ref">Python UTF-8 Mode</span></a>

  559. (<a class="reference internal" href="#c.PyPreConfig.utf8_mode" title="PyPreConfig.utf8_mode"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyPreConfig.utf8_mode</span></code></a>)</p></li>

  560. </ul>

  561. <p>The current preconfiguration (<code class="docutils literal notranslate"><span class="pre">PyPreConfig</span></code> type) is stored in

  562. <code class="docutils literal notranslate"><span class="pre">_PyRuntime.preconfig</span></code>.</p>

  563. <p>Functions to preinitialize Python:</p>

  564. <dl class="c function">

  565. <dt class="sig sig-object c" id="c.Py_PreInitialize">

  566. <a class="reference internal" href="#c.PyStatus" title="PyStatus"><span class="n"><span class="pre">PyStatus</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Py_PreInitialize</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#c.PyPreConfig" title="PyPreConfig"><span class="n"><span class="pre">PyPreConfig</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">preconfig</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.Py_PreInitialize" title="Link to this definition">¶</a><br /></dt>

  567. <dd><p>Preinitialize Python from <em>preconfig</em> preconfiguration.</p>

  568. <p><em>preconfig</em> must not be <code class="docutils literal notranslate"><span class="pre">NULL</span></code>.</p>

  569. </dd></dl>

  570. 

  571. <dl class="c function">

  572. <dt class="sig sig-object c" id="c.Py_PreInitializeFromBytesArgs">

  573. <a class="reference internal" href="#c.PyStatus" title="PyStatus"><span class="n"><span class="pre">PyStatus</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Py_PreInitializeFromBytesArgs</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#c.PyPreConfig" title="PyPreConfig"><span class="n"><span class="pre">PyPreConfig</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">preconfig</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">argc</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">argv</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.Py_PreInitializeFromBytesArgs" title="Link to this definition">¶</a><br /></dt>

  574. <dd><p>Preinitialize Python from <em>preconfig</em> preconfiguration.</p>

  575. <p>Parse <em>argv</em> command line arguments (bytes strings) if

  576. <a class="reference internal" href="#c.PyPreConfig.parse_argv" title="PyPreConfig.parse_argv"><code class="xref c c-member docutils literal notranslate"><span class="pre">parse_argv</span></code></a> of <em>preconfig</em> is non-zero.</p>

  577. <p><em>preconfig</em> must not be <code class="docutils literal notranslate"><span class="pre">NULL</span></code>.</p>

  578. </dd></dl>

  579. 

  580. <dl class="c function">

  581. <dt class="sig sig-object c" id="c.Py_PreInitializeFromArgs">

  582. <a class="reference internal" href="#c.PyStatus" title="PyStatus"><span class="n"><span class="pre">PyStatus</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Py_PreInitializeFromArgs</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#c.PyPreConfig" title="PyPreConfig"><span class="n"><span class="pre">PyPreConfig</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">preconfig</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">argc</span></span>, <span class="n"><span class="pre">wchar_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">argv</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.Py_PreInitializeFromArgs" title="Link to this definition">¶</a><br /></dt>

  583. <dd><p>Preinitialize Python from <em>preconfig</em> preconfiguration.</p>

  584. <p>Parse <em>argv</em> command line arguments (wide strings) if

  585. <a class="reference internal" href="#c.PyPreConfig.parse_argv" title="PyPreConfig.parse_argv"><code class="xref c c-member docutils literal notranslate"><span class="pre">parse_argv</span></code></a> of <em>preconfig</em> is non-zero.</p>

  586. <p><em>preconfig</em> must not be <code class="docutils literal notranslate"><span class="pre">NULL</span></code>.</p>

  587. </dd></dl>

  588. 

  589. <p>The caller is responsible to handle exceptions (error or exit) using

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

  591. <p>For <a class="reference internal" href="#init-python-config"><span class="std std-ref">Python Configuration</span></a>

  592. (<a class="reference internal" href="#c.PyPreConfig_InitPythonConfig" title="PyPreConfig_InitPythonConfig"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyPreConfig_InitPythonConfig()</span></code></a>), if Python is initialized with

  593. command line arguments, the command line arguments must also be passed to

  594. preinitialize Python, since they have an effect on the pre-configuration

  595. like encodings. For example, the <a class="reference internal" href="../using/cmdline.html#cmdoption-X"><code class="xref std std-option docutils literal notranslate"><span class="pre">-X</span> <span class="pre">utf8</span></code></a> command line option

  596. enables the <a class="reference internal" href="../library/os.html#utf8-mode"><span class="std std-ref">Python UTF-8 Mode</span></a>.</p>

  597. <p><code class="docutils literal notranslate"><span class="pre">PyMem_SetAllocator()</span></code> can be called after <a class="reference internal" href="#c.Py_PreInitialize" title="Py_PreInitialize"><code class="xref c c-func docutils literal notranslate"><span class="pre">Py_PreInitialize()</span></code></a> and

  598. before <a class="reference internal" href="#c.Py_InitializeFromConfig" title="Py_InitializeFromConfig"><code class="xref c c-func docutils literal notranslate"><span class="pre">Py_InitializeFromConfig()</span></code></a> to install a custom memory allocator.

  599. It can be called before <a class="reference internal" href="#c.Py_PreInitialize" title="Py_PreInitialize"><code class="xref c c-func docutils literal notranslate"><span class="pre">Py_PreInitialize()</span></code></a> if

  600. <a class="reference internal" href="#c.PyPreConfig.allocator" title="PyPreConfig.allocator"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyPreConfig.allocator</span></code></a> is set to <code class="docutils literal notranslate"><span class="pre">PYMEM_ALLOCATOR_NOT_SET</span></code>.</p>

  601. <p>Python memory allocation functions like <a class="reference internal" href="memory.html#c.PyMem_RawMalloc" title="PyMem_RawMalloc"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyMem_RawMalloc()</span></code></a> must not be

  602. used before the Python preinitialization, whereas calling directly <code class="docutils literal notranslate"><span class="pre">malloc()</span></code>

  603. and <code class="docutils literal notranslate"><span class="pre">free()</span></code> is always safe. <a class="reference internal" href="sys.html#c.Py_DecodeLocale" title="Py_DecodeLocale"><code class="xref c c-func docutils literal notranslate"><span class="pre">Py_DecodeLocale()</span></code></a> must not be called

  604. before the Python preinitialization.</p>

  605. <p>Example using the preinitialization to enable

  606. the <a class="reference internal" href="../library/os.html#utf8-mode"><span class="std std-ref">Python UTF-8 Mode</span></a>:</p>

  607. <div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="n">PyStatus</span><span class="w"> </span><span class="n">status</span><span class="p">;</span>

  608. <span class="n">PyPreConfig</span><span class="w"> </span><span class="n">preconfig</span><span class="p">;</span>

  609. <span class="n">PyPreConfig_InitPythonConfig</span><span class="p">(</span><span class="o">&amp;</span><span class="n">preconfig</span><span class="p">);</span>

  610. 

  611. <span class="n">preconfig</span><span class="p">.</span><span class="n">utf8_mode</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span>

  612. 

  613. <span class="n">status</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Py_PreInitialize</span><span class="p">(</span><span class="o">&amp;</span><span class="n">preconfig</span><span class="p">);</span>

  614. <span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">PyStatus_Exception</span><span class="p">(</span><span class="n">status</span><span class="p">))</span><span class="w"> </span><span class="p">{</span>

  615. <span class="w">    </span><span class="n">Py_ExitStatusException</span><span class="p">(</span><span class="n">status</span><span class="p">);</span>

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

  617. 

  618. <span class="cm">/* at this point, Python speaks UTF-8 */</span>

  619. 

  620. <span class="n">Py_Initialize</span><span class="p">();</span>

  621. <span class="cm">/* ... use Python API here ... */</span>

  622. <span class="n">Py_Finalize</span><span class="p">();</span>

  623. </pre></div>

  624. </div>

  625. </section>

  626. <section id="pyconfig">

  627. <h2>PyConfig<a class="headerlink" href="#pyconfig" title="Link to this heading">¶</a></h2>

  628. <dl class="c type">

  629. <dt class="sig sig-object c" id="c.PyConfig">

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

  631. <dd><p>Structure containing most parameters to configure Python.</p>

  632. <p>When done, the <a class="reference internal" href="#c.PyConfig_Clear" title="PyConfig_Clear"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyConfig_Clear()</span></code></a> function must be used to release the

  633. configuration memory.</p>

  634. <p>Structure methods:</p>

  635. <dl class="c function">

  636. <dt class="sig sig-object c" id="c.PyConfig_InitPythonConfig">

  637. <span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyConfig_InitPythonConfig</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#c.PyConfig" title="PyConfig"><span class="n"><span class="pre">PyConfig</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">config</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyConfig_InitPythonConfig" title="Link to this definition">¶</a><br /></dt>

  638. <dd><p>Initialize configuration with the <a class="reference internal" href="#init-python-config"><span class="std std-ref">Python Configuration</span></a>.</p>

  639. </dd></dl>

  640. 

  641. <dl class="c function">

  642. <dt class="sig sig-object c" id="c.PyConfig_InitIsolatedConfig">

  643. <span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyConfig_InitIsolatedConfig</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#c.PyConfig" title="PyConfig"><span class="n"><span class="pre">PyConfig</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">config</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyConfig_InitIsolatedConfig" title="Link to this definition">¶</a><br /></dt>

  644. <dd><p>Initialize configuration with the <a class="reference internal" href="#init-isolated-conf"><span class="std std-ref">Isolated Configuration</span></a>.</p>

  645. </dd></dl>

  646. 

  647. <dl class="c function">

  648. <dt class="sig sig-object c" id="c.PyConfig_SetString">

  649. <a class="reference internal" href="#c.PyStatus" title="PyStatus"><span class="n"><span class="pre">PyStatus</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyConfig_SetString</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#c.PyConfig" title="PyConfig"><span class="n"><span class="pre">PyConfig</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">config</span></span>, <span class="n"><span class="pre">wchar_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">config_str</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">wchar_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">str</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyConfig_SetString" title="Link to this definition">¶</a><br /></dt>

  650. <dd><p>Copy the wide character string <em>str</em> into <code class="docutils literal notranslate"><span class="pre">*config_str</span></code>.</p>

  651. <p><a class="reference internal" href="#c-preinit"><span class="std std-ref">Preinitialize Python</span></a> if needed.</p>

  652. </dd></dl>

  653. 

  654. <dl class="c function">

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

  656. <a class="reference internal" href="#c.PyStatus" title="PyStatus"><span class="n"><span class="pre">PyStatus</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyConfig_SetBytesString</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#c.PyConfig" title="PyConfig"><span class="n"><span class="pre">PyConfig</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">config</span></span>, <span class="n"><span class="pre">wchar_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">config_str</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">str</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyConfig_SetBytesString" title="Link to this definition">¶</a><br /></dt>

  657. <dd><p>Decode <em>str</em> using <a class="reference internal" href="sys.html#c.Py_DecodeLocale" title="Py_DecodeLocale"><code class="xref c c-func docutils literal notranslate"><span class="pre">Py_DecodeLocale()</span></code></a> and set the result into

  658. <code class="docutils literal notranslate"><span class="pre">*config_str</span></code>.</p>

  659. <p><a class="reference internal" href="#c-preinit"><span class="std std-ref">Preinitialize Python</span></a> if needed.</p>

  660. </dd></dl>

  661. 

  662. <dl class="c function">

  663. <dt class="sig sig-object c" id="c.PyConfig_SetArgv">

  664. <a class="reference internal" href="#c.PyStatus" title="PyStatus"><span class="n"><span class="pre">PyStatus</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyConfig_SetArgv</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#c.PyConfig" title="PyConfig"><span class="n"><span class="pre">PyConfig</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">config</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">argc</span></span>, <span class="n"><span class="pre">wchar_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">argv</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyConfig_SetArgv" title="Link to this definition">¶</a><br /></dt>

  665. <dd><p>Set command line arguments (<a class="reference internal" href="#c.PyConfig.argv" title="PyConfig.argv"><code class="xref c c-member docutils literal notranslate"><span class="pre">argv</span></code></a> member of

  666. <em>config</em>) from the <em>argv</em> list of wide character strings.</p>

  667. <p><a class="reference internal" href="#c-preinit"><span class="std std-ref">Preinitialize Python</span></a> if needed.</p>

  668. </dd></dl>

  669. 

  670. <dl class="c function">

  671. <dt class="sig sig-object c" id="c.PyConfig_SetBytesArgv">

  672. <a class="reference internal" href="#c.PyStatus" title="PyStatus"><span class="n"><span class="pre">PyStatus</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyConfig_SetBytesArgv</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#c.PyConfig" title="PyConfig"><span class="n"><span class="pre">PyConfig</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">config</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">argc</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">argv</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyConfig_SetBytesArgv" title="Link to this definition">¶</a><br /></dt>

  673. <dd><p>Set command line arguments (<a class="reference internal" href="#c.PyConfig.argv" title="PyConfig.argv"><code class="xref c c-member docutils literal notranslate"><span class="pre">argv</span></code></a> member of

  674. <em>config</em>) from the <em>argv</em> list of bytes strings. Decode bytes using

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

  676. <p><a class="reference internal" href="#c-preinit"><span class="std std-ref">Preinitialize Python</span></a> if needed.</p>

  677. </dd></dl>

  678. 

  679. <dl class="c function">

  680. <dt class="sig sig-object c" id="c.PyConfig_SetWideStringList">

  681. <a class="reference internal" href="#c.PyStatus" title="PyStatus"><span class="n"><span class="pre">PyStatus</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyConfig_SetWideStringList</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#c.PyConfig" title="PyConfig"><span class="n"><span class="pre">PyConfig</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">config</span></span>, <a class="reference internal" href="#c.PyWideStringList" title="PyWideStringList"><span class="n"><span class="pre">PyWideStringList</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">list</span></span>, <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="n"><span class="pre">length</span></span>, <span class="n"><span class="pre">wchar_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">items</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyConfig_SetWideStringList" title="Link to this definition">¶</a><br /></dt>

  682. <dd><p>Set the list of wide strings <em>list</em> to <em>length</em> and <em>items</em>.</p>

  683. <p><a class="reference internal" href="#c-preinit"><span class="std std-ref">Preinitialize Python</span></a> if needed.</p>

  684. </dd></dl>

  685. 

  686. <dl class="c function">

  687. <dt class="sig sig-object c" id="c.PyConfig_Read">

  688. <a class="reference internal" href="#c.PyStatus" title="PyStatus"><span class="n"><span class="pre">PyStatus</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyConfig_Read</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#c.PyConfig" title="PyConfig"><span class="n"><span class="pre">PyConfig</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">config</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyConfig_Read" title="Link to this definition">¶</a><br /></dt>

  689. <dd><p>Read all Python configuration.</p>

  690. <p>Fields which are already initialized are left unchanged.</p>

  691. <p>Fields for <a class="reference internal" href="#init-path-config"><span class="std std-ref">path configuration</span></a> are no longer

  692. calculated or modified when calling this function, as of Python 3.11.</p>

  693. <p>The <a class="reference internal" href="#c.PyConfig_Read" title="PyConfig_Read"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyConfig_Read()</span></code></a> function only parses

  694. <a class="reference internal" href="#c.PyConfig.argv" title="PyConfig.argv"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.argv</span></code></a> arguments once: <a class="reference internal" href="#c.PyConfig.parse_argv" title="PyConfig.parse_argv"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.parse_argv</span></code></a>

  695. is set to <code class="docutils literal notranslate"><span class="pre">2</span></code> after arguments are parsed. Since Python arguments are

  696. strippped from <a class="reference internal" href="#c.PyConfig.argv" title="PyConfig.argv"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.argv</span></code></a>, parsing arguments twice would

  697. parse the application options as Python options.</p>

  698. <p><a class="reference internal" href="#c-preinit"><span class="std std-ref">Preinitialize Python</span></a> if needed.</p>

  699. <div class="versionchanged">

  700. <p><span class="versionmodified changed">Changed in version 3.10: </span>The <a class="reference internal" href="#c.PyConfig.argv" title="PyConfig.argv"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.argv</span></code></a> arguments are now only parsed once,

  701. <a class="reference internal" href="#c.PyConfig.parse_argv" title="PyConfig.parse_argv"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.parse_argv</span></code></a> is set to <code class="docutils literal notranslate"><span class="pre">2</span></code> after arguments are

  702. parsed, and arguments are only parsed if

  703. <a class="reference internal" href="#c.PyConfig.parse_argv" title="PyConfig.parse_argv"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.parse_argv</span></code></a> equals <code class="docutils literal notranslate"><span class="pre">1</span></code>.</p>

  704. </div>

  705. <div class="versionchanged">

  706. <p><span class="versionmodified changed">Changed in version 3.11: </span><a class="reference internal" href="#c.PyConfig_Read" title="PyConfig_Read"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyConfig_Read()</span></code></a> no longer calculates all paths, and so fields

  707. listed under <a class="reference internal" href="#init-path-config"><span class="std std-ref">Python Path Configuration</span></a> may

  708. no longer be updated until <a class="reference internal" href="#c.Py_InitializeFromConfig" title="Py_InitializeFromConfig"><code class="xref c c-func docutils literal notranslate"><span class="pre">Py_InitializeFromConfig()</span></code></a> is

  709. called.</p>

  710. </div>

  711. </dd></dl>

  712. 

  713. <dl class="c function">

  714. <dt class="sig sig-object c" id="c.PyConfig_Clear">

  715. <span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyConfig_Clear</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#c.PyConfig" title="PyConfig"><span class="n"><span class="pre">PyConfig</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">config</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyConfig_Clear" title="Link to this definition">¶</a><br /></dt>

  716. <dd><p>Release configuration memory.</p>

  717. </dd></dl>

  718. 

  719. <p>Most <code class="docutils literal notranslate"><span class="pre">PyConfig</span></code> methods <a class="reference internal" href="#c-preinit"><span class="std std-ref">preinitialize Python</span></a> if needed.

  720. In that case, the Python preinitialization configuration

  721. (<a class="reference internal" href="#c.PyPreConfig" title="PyPreConfig"><code class="xref c c-type docutils literal notranslate"><span class="pre">PyPreConfig</span></code></a>) in based on the <a class="reference internal" href="#c.PyConfig" title="PyConfig"><code class="xref c c-type docutils literal notranslate"><span class="pre">PyConfig</span></code></a>. If configuration

  722. fields which are in common with <a class="reference internal" href="#c.PyPreConfig" title="PyPreConfig"><code class="xref c c-type docutils literal notranslate"><span class="pre">PyPreConfig</span></code></a> are tuned, they must

  723. be set before calling a <a class="reference internal" href="#c.PyConfig" title="PyConfig"><code class="xref c c-type docutils literal notranslate"><span class="pre">PyConfig</span></code></a> method:</p>

  724. <ul class="simple">

  725. <li><p><a class="reference internal" href="#c.PyConfig.dev_mode" title="PyConfig.dev_mode"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.dev_mode</span></code></a></p></li>

  726. <li><p><a class="reference internal" href="#c.PyConfig.isolated" title="PyConfig.isolated"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.isolated</span></code></a></p></li>

  727. <li><p><a class="reference internal" href="#c.PyConfig.parse_argv" title="PyConfig.parse_argv"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.parse_argv</span></code></a></p></li>

  728. <li><p><a class="reference internal" href="#c.PyConfig.use_environment" title="PyConfig.use_environment"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.use_environment</span></code></a></p></li>

  729. </ul>

  730. <p>Moreover, if <a class="reference internal" href="#c.PyConfig_SetArgv" title="PyConfig_SetArgv"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyConfig_SetArgv()</span></code></a> or <a class="reference internal" href="#c.PyConfig_SetBytesArgv" title="PyConfig_SetBytesArgv"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyConfig_SetBytesArgv()</span></code></a>

  731. is used, this method must be called before other methods, since the

  732. preinitialization configuration depends on command line arguments (if

  733. <a class="reference internal" href="#c.PyConfig.parse_argv" title="PyConfig.parse_argv"><code class="xref c c-member docutils literal notranslate"><span class="pre">parse_argv</span></code></a> is non-zero).</p>

  734. <p>The caller of these methods is responsible to handle exceptions (error or

  735. exit) using <code class="docutils literal notranslate"><span class="pre">PyStatus_Exception()</span></code> and <code class="docutils literal notranslate"><span class="pre">Py_ExitStatusException()</span></code>.</p>

  736. <p>Structure fields:</p>

  737. <dl class="c member">

  738. <dt class="sig sig-object c" id="c.PyConfig.argv">

  739. <a class="reference internal" href="#c.PyWideStringList" title="PyWideStringList"><span class="n"><span class="pre">PyWideStringList</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">argv</span></span></span><a class="headerlink" href="#c.PyConfig.argv" title="Link to this definition">¶</a><br /></dt>

  740. <dd><p>Command line arguments: <a class="reference internal" href="../library/sys.html#sys.argv" title="sys.argv"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.argv</span></code></a>.</p>

  741. <p>Set <a class="reference internal" href="#c.PyConfig.parse_argv" title="PyConfig.parse_argv"><code class="xref c c-member docutils literal notranslate"><span class="pre">parse_argv</span></code></a> to <code class="docutils literal notranslate"><span class="pre">1</span></code> to parse

  742. <a class="reference internal" href="#c.PyConfig.argv" title="PyConfig.argv"><code class="xref c c-member docutils literal notranslate"><span class="pre">argv</span></code></a> the same way the regular Python parses Python

  743. command line arguments and then to strip Python arguments from

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

  745. <p>If <a class="reference internal" href="#c.PyConfig.argv" title="PyConfig.argv"><code class="xref c c-member docutils literal notranslate"><span class="pre">argv</span></code></a> is empty, an empty string is added to

  746. ensure that <a class="reference internal" href="../library/sys.html#sys.argv" title="sys.argv"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.argv</span></code></a> always exists and is never empty.</p>

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

  748. <p>See also the <a class="reference internal" href="#c.PyConfig.orig_argv" title="PyConfig.orig_argv"><code class="xref c c-member docutils literal notranslate"><span class="pre">orig_argv</span></code></a> member.</p>

  749. </dd></dl>

  750. 

  751. <dl class="c member">

  752. <dt class="sig sig-object c" id="c.PyConfig.safe_path">

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

  754. <dd><p>If equals to zero, <code class="docutils literal notranslate"><span class="pre">Py_RunMain()</span></code> prepends a potentially unsafe path to

  755. <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> at startup:</p>

  756. <ul class="simple">

  757. <li><p>If <a class="reference internal" href="#c.PyConfig.argv" title="PyConfig.argv"><code class="xref c c-member docutils literal notranslate"><span class="pre">argv[0]</span></code></a> is equal to <code class="docutils literal notranslate"><span class="pre">L&quot;-m&quot;</span></code>

  758. (<code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">-m</span> <span class="pre">module</span></code>), prepend the current working directory.</p></li>

  759. <li><p>If running a script (<code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">script.py</span></code>), prepend the script’s

  760. directory.  If it’s a symbolic link, resolve symbolic links.</p></li>

  761. <li><p>Otherwise (<code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">-c</span> <span class="pre">code</span></code> and <code class="docutils literal notranslate"><span class="pre">python</span></code>), prepend an empty string,

  762. which means the current working directory.</p></li>

  763. </ul>

  764. <p>Set to <code class="docutils literal notranslate"><span class="pre">1</span></code> by the <a class="reference internal" href="../using/cmdline.html#cmdoption-P"><code class="xref std std-option docutils literal notranslate"><span class="pre">-P</span></code></a> command line option and the

  765. <span class="target" id="index-3"></span><a class="reference internal" href="../using/cmdline.html#envvar-PYTHONSAFEPATH"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PYTHONSAFEPATH</span></code></a> environment variable.</p>

  766. <p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code> in Python config, <code class="docutils literal notranslate"><span class="pre">1</span></code> in isolated config.</p>

  767. <div class="versionadded">

  768. <p><span class="versionmodified added">New in version 3.11.</span></p>

  769. </div>

  770. </dd></dl>

  771. 

  772. <dl class="c member">

  773. <dt class="sig sig-object c" id="c.PyConfig.base_exec_prefix">

  774. <span class="n"><span class="pre">wchar_t</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">base_exec_prefix</span></span></span><a class="headerlink" href="#c.PyConfig.base_exec_prefix" title="Link to this definition">¶</a><br /></dt>

  775. <dd><p><a class="reference internal" href="../library/sys.html#sys.base_exec_prefix" title="sys.base_exec_prefix"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.base_exec_prefix</span></code></a>.</p>

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

  777. <p>Part of the <a class="reference internal" href="#init-path-config"><span class="std std-ref">Python Path Configuration</span></a> output.</p>

  778. </dd></dl>

  779. 

  780. <dl class="c member">

  781. <dt class="sig sig-object c" id="c.PyConfig.base_executable">

  782. <span class="n"><span class="pre">wchar_t</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">base_executable</span></span></span><a class="headerlink" href="#c.PyConfig.base_executable" title="Link to this definition">¶</a><br /></dt>

  783. <dd><p>Python base executable: <code class="xref py py-data docutils literal notranslate"><span class="pre">sys._base_executable</span></code>.</p>

  784. <p>Set by the <span class="target" id="index-4"></span><code class="xref std std-envvar docutils literal notranslate"><span class="pre">__PYVENV_LAUNCHER__</span></code> environment variable.</p>

  785. <p>Set from <a class="reference internal" href="#c.PyConfig.executable" title="PyConfig.executable"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.executable</span></code></a> if <code class="docutils literal notranslate"><span class="pre">NULL</span></code>.</p>

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

  787. <p>Part of the <a class="reference internal" href="#init-path-config"><span class="std std-ref">Python Path Configuration</span></a> output.</p>

  788. </dd></dl>

  789. 

  790. <dl class="c member">

  791. <dt class="sig sig-object c" id="c.PyConfig.base_prefix">

  792. <span class="n"><span class="pre">wchar_t</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">base_prefix</span></span></span><a class="headerlink" href="#c.PyConfig.base_prefix" title="Link to this definition">¶</a><br /></dt>

  793. <dd><p><a class="reference internal" href="../library/sys.html#sys.base_prefix" title="sys.base_prefix"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.base_prefix</span></code></a>.</p>

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

  795. <p>Part of the <a class="reference internal" href="#init-path-config"><span class="std std-ref">Python Path Configuration</span></a> output.</p>

  796. </dd></dl>

  797. 

  798. <dl class="c member">

  799. <dt class="sig sig-object c" id="c.PyConfig.buffered_stdio">

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

  801. <dd><p>If equals to <code class="docutils literal notranslate"><span class="pre">0</span></code> and <a class="reference internal" href="#c.PyConfig.configure_c_stdio" title="PyConfig.configure_c_stdio"><code class="xref c c-member docutils literal notranslate"><span class="pre">configure_c_stdio</span></code></a> is non-zero,

  802. disable buffering on the C streams stdout and stderr.</p>

  803. <p>Set to <code class="docutils literal notranslate"><span class="pre">0</span></code> by the <a class="reference internal" href="../using/cmdline.html#cmdoption-u"><code class="xref std std-option docutils literal notranslate"><span class="pre">-u</span></code></a> command line option and the

  804. <span class="target" id="index-5"></span><a class="reference internal" href="../using/cmdline.html#envvar-PYTHONUNBUFFERED"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PYTHONUNBUFFERED</span></code></a> environment variable.</p>

  805. <p>stdin is always opened in buffered mode.</p>

  806. <p>Default: <code class="docutils literal notranslate"><span class="pre">1</span></code>.</p>

  807. </dd></dl>

  808. 

  809. <dl class="c member">

  810. <dt class="sig sig-object c" id="c.PyConfig.bytes_warning">

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

  812. <dd><p>If equals to <code class="docutils literal notranslate"><span class="pre">1</span></code>, issue a warning when comparing <a class="reference internal" href="../library/stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a> or

  813. <a class="reference internal" href="../library/stdtypes.html#bytearray" title="bytearray"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytearray</span></code></a> with <a class="reference internal" href="../library/stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>, or comparing <a class="reference internal" href="../library/stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a> with

  814. <a class="reference internal" href="../library/functions.html#int" title="int"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>.</p>

  815. <p>If equal or greater to <code class="docutils literal notranslate"><span class="pre">2</span></code>, raise a <a class="reference internal" href="../library/exceptions.html#BytesWarning" title="BytesWarning"><code class="xref py py-exc docutils literal notranslate"><span class="pre">BytesWarning</span></code></a> exception in these

  816. cases.</p>

  817. <p>Incremented by the <a class="reference internal" href="../using/cmdline.html#cmdoption-b"><code class="xref std std-option docutils literal notranslate"><span class="pre">-b</span></code></a> command line option.</p>

  818. <p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code>.</p>

  819. </dd></dl>

  820. 

  821. <dl class="c member">

  822. <dt class="sig sig-object c" id="c.PyConfig.warn_default_encoding">

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

  824. <dd><p>If non-zero, emit a <a class="reference internal" href="../library/exceptions.html#EncodingWarning" title="EncodingWarning"><code class="xref py py-exc docutils literal notranslate"><span class="pre">EncodingWarning</span></code></a> warning when <a class="reference internal" href="../library/io.html#io.TextIOWrapper" title="io.TextIOWrapper"><code class="xref py py-class docutils literal notranslate"><span class="pre">io.TextIOWrapper</span></code></a>

  825. uses its default encoding. See <a class="reference internal" href="../library/io.html#io-encoding-warning"><span class="std std-ref">Opt-in EncodingWarning</span></a> for details.</p>

  826. <p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code>.</p>

  827. <div class="versionadded">

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

  829. </div>

  830. </dd></dl>

  831. 

  832. <dl class="c member">

  833. <dt class="sig sig-object c" id="c.PyConfig.code_debug_ranges">

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

  835. <dd><p>If equals to <code class="docutils literal notranslate"><span class="pre">0</span></code>, disables the inclusion of the end line and column

  836. mappings in code objects. Also disables traceback printing carets to

  837. specific error locations.</p>

  838. <p>Set to <code class="docutils literal notranslate"><span class="pre">0</span></code> by the <span class="target" id="index-6"></span><a class="reference internal" href="../using/cmdline.html#envvar-PYTHONNODEBUGRANGES"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PYTHONNODEBUGRANGES</span></code></a> environment variable

  839. and by the <a class="reference internal" href="../using/cmdline.html#cmdoption-X"><code class="xref std std-option docutils literal notranslate"><span class="pre">-X</span> <span class="pre">no_debug_ranges</span></code></a> command line option.</p>

  840. <p>Default: <code class="docutils literal notranslate"><span class="pre">1</span></code>.</p>

  841. <div class="versionadded">

  842. <p><span class="versionmodified added">New in version 3.11.</span></p>

  843. </div>

  844. </dd></dl>

  845. 

  846. <dl class="c member">

  847. <dt class="sig sig-object c" id="c.PyConfig.check_hash_pycs_mode">

  848. <span class="n"><span class="pre">wchar_t</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">check_hash_pycs_mode</span></span></span><a class="headerlink" href="#c.PyConfig.check_hash_pycs_mode" title="Link to this definition">¶</a><br /></dt>

  849. <dd><p>Control the validation behavior of hash-based <code class="docutils literal notranslate"><span class="pre">.pyc</span></code> files:

  850. value of the <a class="reference internal" href="../using/cmdline.html#cmdoption-check-hash-based-pycs"><code class="xref std std-option docutils literal notranslate"><span class="pre">--check-hash-based-pycs</span></code></a> command line option.</p>

  851. <p>Valid values:</p>

  852. <ul class="simple">

  853. <li><p><code class="docutils literal notranslate"><span class="pre">L&quot;always&quot;</span></code>: Hash the source file for invalidation regardless of

  854. value of the ‘check_source’ flag.</p></li>

  855. <li><p><code class="docutils literal notranslate"><span class="pre">L&quot;never&quot;</span></code>: Assume that hash-based pycs always are valid.</p></li>

  856. <li><p><code class="docutils literal notranslate"><span class="pre">L&quot;default&quot;</span></code>: The ‘check_source’ flag in hash-based pycs

  857. determines invalidation.</p></li>

  858. </ul>

  859. <p>Default: <code class="docutils literal notranslate"><span class="pre">L&quot;default&quot;</span></code>.</p>

  860. <p>See also <span class="target" id="index-7"></span><a class="pep reference external" href="https://peps.python.org/pep-0552/"><strong>PEP 552</strong></a> “Deterministic pycs”.</p>

  861. </dd></dl>

  862. 

  863. <dl class="c member">

  864. <dt class="sig sig-object c" id="c.PyConfig.configure_c_stdio">

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

  866. <dd><p>If non-zero, configure C standard streams:</p>

  867. <ul class="simple">

  868. <li><p>On Windows, set the binary mode (<code class="docutils literal notranslate"><span class="pre">O_BINARY</span></code>) on stdin, stdout and

  869. stderr.</p></li>

  870. <li><p>If <a class="reference internal" href="#c.PyConfig.buffered_stdio" title="PyConfig.buffered_stdio"><code class="xref c c-member docutils literal notranslate"><span class="pre">buffered_stdio</span></code></a> equals zero, disable buffering

  871. of stdin, stdout and stderr streams.</p></li>

  872. <li><p>If <a class="reference internal" href="#c.PyConfig.interactive" title="PyConfig.interactive"><code class="xref c c-member docutils literal notranslate"><span class="pre">interactive</span></code></a> is non-zero, enable stream

  873. buffering on stdin and stdout (only stdout on Windows).</p></li>

  874. </ul>

  875. <p>Default: <code class="docutils literal notranslate"><span class="pre">1</span></code> in Python config, <code class="docutils literal notranslate"><span class="pre">0</span></code> in isolated config.</p>

  876. </dd></dl>

  877. 

  878. <dl class="c member">

  879. <dt class="sig sig-object c" id="c.PyConfig.dev_mode">

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

  881. <dd><p>If non-zero, enable the <a class="reference internal" href="../library/devmode.html#devmode"><span class="std std-ref">Python Development Mode</span></a>.</p>

  882. <p>Set to <code class="docutils literal notranslate"><span class="pre">1</span></code> by the <a class="reference internal" href="../using/cmdline.html#cmdoption-X"><code class="xref std std-option docutils literal notranslate"><span class="pre">-X</span> <span class="pre">dev</span></code></a> option and the

  883. <span class="target" id="index-8"></span><a class="reference internal" href="../using/cmdline.html#envvar-PYTHONDEVMODE"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PYTHONDEVMODE</span></code></a> environment variable.</p>

  884. <p>Default: <code class="docutils literal notranslate"><span class="pre">-1</span></code> in Python mode, <code class="docutils literal notranslate"><span class="pre">0</span></code> in isolated mode.</p>

  885. </dd></dl>

  886. 

  887. <dl class="c member">

  888. <dt class="sig sig-object c" id="c.PyConfig.dump_refs">

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

  890. <dd><p>Dump Python references?</p>

  891. <p>If non-zero, dump all objects which are still alive at exit.</p>

  892. <p>Set to <code class="docutils literal notranslate"><span class="pre">1</span></code> by the <span class="target" id="index-9"></span><a class="reference internal" href="../using/cmdline.html#envvar-PYTHONDUMPREFS"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PYTHONDUMPREFS</span></code></a> environment variable.</p>

  893. <p>Need a special build of Python with the <code class="docutils literal notranslate"><span class="pre">Py_TRACE_REFS</span></code> macro defined:

  894. see the <a class="reference internal" href="../using/configure.html#cmdoption-with-trace-refs"><code class="xref std std-option docutils literal notranslate"><span class="pre">configure</span> <span class="pre">--with-trace-refs</span> <span class="pre">option</span></code></a>.</p>

  895. <p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code>.</p>

  896. </dd></dl>

  897. 

  898. <dl class="c member">

  899. <dt class="sig sig-object c" id="c.PyConfig.exec_prefix">

  900. <span class="n"><span class="pre">wchar_t</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">exec_prefix</span></span></span><a class="headerlink" href="#c.PyConfig.exec_prefix" title="Link to this definition">¶</a><br /></dt>

  901. <dd><p>The site-specific directory prefix where the platform-dependent Python

  902. files are installed: <a class="reference internal" href="../library/sys.html#sys.exec_prefix" title="sys.exec_prefix"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.exec_prefix</span></code></a>.</p>

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

  904. <p>Part of the <a class="reference internal" href="#init-path-config"><span class="std std-ref">Python Path Configuration</span></a> output.</p>

  905. </dd></dl>

  906. 

  907. <dl class="c member">

  908. <dt class="sig sig-object c" id="c.PyConfig.executable">

  909. <span class="n"><span class="pre">wchar_t</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">executable</span></span></span><a class="headerlink" href="#c.PyConfig.executable" title="Link to this definition">¶</a><br /></dt>

  910. <dd><p>The absolute path of the executable binary for the Python interpreter:

  911. <a class="reference internal" href="../library/sys.html#sys.executable" title="sys.executable"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.executable</span></code></a>.</p>

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

  913. <p>Part of the <a class="reference internal" href="#init-path-config"><span class="std std-ref">Python Path Configuration</span></a> output.</p>

  914. </dd></dl>

  915. 

  916. <dl class="c member">

  917. <dt class="sig sig-object c" id="c.PyConfig.faulthandler">

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

  919. <dd><p>Enable faulthandler?</p>

  920. <p>If non-zero, call <a class="reference internal" href="../library/faulthandler.html#faulthandler.enable" title="faulthandler.enable"><code class="xref py py-func docutils literal notranslate"><span class="pre">faulthandler.enable()</span></code></a> at startup.</p>

  921. <p>Set to <code class="docutils literal notranslate"><span class="pre">1</span></code> by <a class="reference internal" href="../using/cmdline.html#cmdoption-X"><code class="xref std std-option docutils literal notranslate"><span class="pre">-X</span> <span class="pre">faulthandler</span></code></a> and the

  922. <span class="target" id="index-10"></span><a class="reference internal" href="../using/cmdline.html#envvar-PYTHONFAULTHANDLER"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PYTHONFAULTHANDLER</span></code></a> environment variable.</p>

  923. <p>Default: <code class="docutils literal notranslate"><span class="pre">-1</span></code> in Python mode, <code class="docutils literal notranslate"><span class="pre">0</span></code> in isolated mode.</p>

  924. </dd></dl>

  925. 

  926. <dl class="c member">

  927. <dt class="sig sig-object c" id="c.PyConfig.filesystem_encoding">

  928. <span class="n"><span class="pre">wchar_t</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">filesystem_encoding</span></span></span><a class="headerlink" href="#c.PyConfig.filesystem_encoding" title="Link to this definition">¶</a><br /></dt>

  929. <dd><p><a class="reference internal" href="../glossary.html#term-filesystem-encoding-and-error-handler"><span class="xref std std-term">Filesystem encoding</span></a>:

  930. <a class="reference internal" href="../library/sys.html#sys.getfilesystemencoding" title="sys.getfilesystemencoding"><code class="xref py py-func docutils literal notranslate"><span class="pre">sys.getfilesystemencoding()</span></code></a>.</p>

  931. <p>On macOS, Android and VxWorks: use <code class="docutils literal notranslate"><span class="pre">&quot;utf-8&quot;</span></code> by default.</p>

  932. <p>On Windows: use <code class="docutils literal notranslate"><span class="pre">&quot;utf-8&quot;</span></code> by default, or <code class="docutils literal notranslate"><span class="pre">&quot;mbcs&quot;</span></code> if

  933. <a class="reference internal" href="#c.PyPreConfig.legacy_windows_fs_encoding" title="PyPreConfig.legacy_windows_fs_encoding"><code class="xref c c-member docutils literal notranslate"><span class="pre">legacy_windows_fs_encoding</span></code></a> of

  934. <a class="reference internal" href="#c.PyPreConfig" title="PyPreConfig"><code class="xref c c-type docutils literal notranslate"><span class="pre">PyPreConfig</span></code></a> is non-zero.</p>

  935. <p>Default encoding on other platforms:</p>

  936. <ul class="simple">

  937. <li><p><code class="docutils literal notranslate"><span class="pre">&quot;utf-8&quot;</span></code> if <a class="reference internal" href="#c.PyPreConfig.utf8_mode" title="PyPreConfig.utf8_mode"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyPreConfig.utf8_mode</span></code></a> is non-zero.</p></li>

  938. <li><p><code class="docutils literal notranslate"><span class="pre">&quot;ascii&quot;</span></code> if Python detects that <code class="docutils literal notranslate"><span class="pre">nl_langinfo(CODESET)</span></code> announces

  939. the ASCII encoding, whereas the <code class="docutils literal notranslate"><span class="pre">mbstowcs()</span></code> function

  940. decodes from a different encoding (usually Latin1).</p></li>

  941. <li><p><code class="docutils literal notranslate"><span class="pre">&quot;utf-8&quot;</span></code> if <code class="docutils literal notranslate"><span class="pre">nl_langinfo(CODESET)</span></code> returns an empty string.</p></li>

  942. <li><p>Otherwise, use the <a class="reference internal" href="../glossary.html#term-locale-encoding"><span class="xref std std-term">locale encoding</span></a>:

  943. <code class="docutils literal notranslate"><span class="pre">nl_langinfo(CODESET)</span></code> result.</p></li>

  944. </ul>

  945. <p>At Python startup, the encoding name is normalized to the Python codec

  946. name. For example, <code class="docutils literal notranslate"><span class="pre">&quot;ANSI_X3.4-1968&quot;</span></code> is replaced with <code class="docutils literal notranslate"><span class="pre">&quot;ascii&quot;</span></code>.</p>

  947. <p>See also the <a class="reference internal" href="#c.PyConfig.filesystem_errors" title="PyConfig.filesystem_errors"><code class="xref c c-member docutils literal notranslate"><span class="pre">filesystem_errors</span></code></a> member.</p>

  948. </dd></dl>

  949. 

  950. <dl class="c member">

  951. <dt class="sig sig-object c" id="c.PyConfig.filesystem_errors">

  952. <span class="n"><span class="pre">wchar_t</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">filesystem_errors</span></span></span><a class="headerlink" href="#c.PyConfig.filesystem_errors" title="Link to this definition">¶</a><br /></dt>

  953. <dd><p><a class="reference internal" href="../glossary.html#term-filesystem-encoding-and-error-handler"><span class="xref std std-term">Filesystem error handler</span></a>:

  954. <a class="reference internal" href="../library/sys.html#sys.getfilesystemencodeerrors" title="sys.getfilesystemencodeerrors"><code class="xref py py-func docutils literal notranslate"><span class="pre">sys.getfilesystemencodeerrors()</span></code></a>.</p>

  955. <p>On Windows: use <code class="docutils literal notranslate"><span class="pre">&quot;surrogatepass&quot;</span></code> by default, or <code class="docutils literal notranslate"><span class="pre">&quot;replace&quot;</span></code>  if

  956. <a class="reference internal" href="#c.PyPreConfig.legacy_windows_fs_encoding" title="PyPreConfig.legacy_windows_fs_encoding"><code class="xref c c-member docutils literal notranslate"><span class="pre">legacy_windows_fs_encoding</span></code></a> of

  957. <a class="reference internal" href="#c.PyPreConfig" title="PyPreConfig"><code class="xref c c-type docutils literal notranslate"><span class="pre">PyPreConfig</span></code></a> is non-zero.</p>

  958. <p>On other platforms: use <code class="docutils literal notranslate"><span class="pre">&quot;surrogateescape&quot;</span></code> by default.</p>

  959. <p>Supported error handlers:</p>

  960. <ul class="simple">

  961. <li><p><code class="docutils literal notranslate"><span class="pre">&quot;strict&quot;</span></code></p></li>

  962. <li><p><code class="docutils literal notranslate"><span class="pre">&quot;surrogateescape&quot;</span></code></p></li>

  963. <li><p><code class="docutils literal notranslate"><span class="pre">&quot;surrogatepass&quot;</span></code> (only supported with the UTF-8 encoding)</p></li>

  964. </ul>

  965. <p>See also the <a class="reference internal" href="#c.PyConfig.filesystem_encoding" title="PyConfig.filesystem_encoding"><code class="xref c c-member docutils literal notranslate"><span class="pre">filesystem_encoding</span></code></a> member.</p>

  966. </dd></dl>

  967. 

  968. <dl class="c member">

  969. <dt class="sig sig-object c" id="c.PyConfig.hash_seed">

  970. <span class="kt"><span class="pre">unsigned</span></span><span class="w"> </span><span class="kt"><span class="pre">long</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">hash_seed</span></span></span><a class="headerlink" href="#c.PyConfig.hash_seed" title="Link to this definition">¶</a><br /></dt>

  971. <dd></dd></dl>

  972. 

  973. <dl class="c member">

  974. <dt class="sig sig-object c" id="c.PyConfig.use_hash_seed">

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

  976. <dd><p>Randomized hash function seed.</p>

  977. <p>If <a class="reference internal" href="#c.PyConfig.use_hash_seed" title="PyConfig.use_hash_seed"><code class="xref c c-member docutils literal notranslate"><span class="pre">use_hash_seed</span></code></a> is zero, a seed is chosen randomly

  978. at Python startup, and <a class="reference internal" href="#c.PyConfig.hash_seed" title="PyConfig.hash_seed"><code class="xref c c-member docutils literal notranslate"><span class="pre">hash_seed</span></code></a> is ignored.</p>

  979. <p>Set by the <span class="target" id="index-11"></span><a class="reference internal" href="../using/cmdline.html#envvar-PYTHONHASHSEED"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PYTHONHASHSEED</span></code></a> environment variable.</p>

  980. <p>Default <em>use_hash_seed</em> value: <code class="docutils literal notranslate"><span class="pre">-1</span></code> in Python mode, <code class="docutils literal notranslate"><span class="pre">0</span></code> in isolated

  981. mode.</p>

  982. </dd></dl>

  983. 

  984. <dl class="c member">

  985. <dt class="sig sig-object c" id="c.PyConfig.home">

  986. <span class="n"><span class="pre">wchar_t</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">home</span></span></span><a class="headerlink" href="#c.PyConfig.home" title="Link to this definition">¶</a><br /></dt>

  987. <dd><p>Python home directory.</p>

  988. <p>If <a class="reference internal" href="init.html#c.Py_SetPythonHome" title="Py_SetPythonHome"><code class="xref c c-func docutils literal notranslate"><span class="pre">Py_SetPythonHome()</span></code></a> has been called, use its argument if it is

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

  990. <p>Set by the <span class="target" id="index-12"></span><a class="reference internal" href="../using/cmdline.html#envvar-PYTHONHOME"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PYTHONHOME</span></code></a> environment variable.</p>

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

  992. <p>Part of the <a class="reference internal" href="#init-path-config"><span class="std std-ref">Python Path Configuration</span></a> input.</p>

  993. </dd></dl>

  994. 

  995. <dl class="c member">

  996. <dt class="sig sig-object c" id="c.PyConfig.import_time">

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

  998. <dd><p>If non-zero, profile import time.</p>

  999. <p>Set the <code class="docutils literal notranslate"><span class="pre">1</span></code> by the <a class="reference internal" href="../using/cmdline.html#cmdoption-X"><code class="xref std std-option docutils literal notranslate"><span class="pre">-X</span> <span class="pre">importtime</span></code></a> option and the

  1000. <span class="target" id="index-13"></span><a class="reference internal" href="../using/cmdline.html#envvar-PYTHONPROFILEIMPORTTIME"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PYTHONPROFILEIMPORTTIME</span></code></a> environment variable.</p>

  1001. <p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code>.</p>

  1002. </dd></dl>

  1003. 

  1004. <dl class="c member">

  1005. <dt class="sig sig-object c" id="c.PyConfig.inspect">

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

  1007. <dd><p>Enter interactive mode after executing a script or a command.</p>

  1008. <p>If greater than <code class="docutils literal notranslate"><span class="pre">0</span></code>, enable inspect: when a script is passed as first

  1009. argument or the -c option is used, enter interactive mode after executing

  1010. the script or the command, even when <a class="reference internal" href="../library/sys.html#sys.stdin" title="sys.stdin"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.stdin</span></code></a> does not appear to

  1011. be a terminal.</p>

  1012. <p>Incremented by the <a class="reference internal" href="../using/cmdline.html#cmdoption-i"><code class="xref std std-option docutils literal notranslate"><span class="pre">-i</span></code></a> command line option. Set to <code class="docutils literal notranslate"><span class="pre">1</span></code> if the

  1013. <span class="target" id="index-14"></span><a class="reference internal" href="../using/cmdline.html#envvar-PYTHONINSPECT"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PYTHONINSPECT</span></code></a> environment variable is non-empty.</p>

  1014. <p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code>.</p>

  1015. </dd></dl>

  1016. 

  1017. <dl class="c member">

  1018. <dt class="sig sig-object c" id="c.PyConfig.install_signal_handlers">

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

  1020. <dd><p>Install Python signal handlers?</p>

  1021. <p>Default: <code class="docutils literal notranslate"><span class="pre">1</span></code> in Python mode, <code class="docutils literal notranslate"><span class="pre">0</span></code> in isolated mode.</p>

  1022. </dd></dl>

  1023. 

  1024. <dl class="c member">

  1025. <dt class="sig sig-object c" id="c.PyConfig.interactive">

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

  1027. <dd><p>If greater than <code class="docutils literal notranslate"><span class="pre">0</span></code>, enable the interactive mode (REPL).</p>

  1028. <p>Incremented by the <a class="reference internal" href="../using/cmdline.html#cmdoption-i"><code class="xref std std-option docutils literal notranslate"><span class="pre">-i</span></code></a> command line option.</p>

  1029. <p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code>.</p>

  1030. </dd></dl>

  1031. 

  1032. <dl class="c member">

  1033. <dt class="sig sig-object c" id="c.PyConfig.int_max_str_digits">

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

  1035. <dd><p>Configures the <a class="reference internal" href="../library/stdtypes.html#int-max-str-digits"><span class="std std-ref">integer string conversion length limitation</span></a>.  An initial value of <code class="docutils literal notranslate"><span class="pre">-1</span></code> means the value will

  1036. be taken from the command line or environment or otherwise default to

  1037. 4300 (<a class="reference internal" href="../library/sys.html#sys.int_info.default_max_str_digits" title="sys.int_info.default_max_str_digits"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.int_info.default_max_str_digits</span></code></a>).  A value of <code class="docutils literal notranslate"><span class="pre">0</span></code>

  1038. disables the limitation.  Values greater than zero but less than 640

  1039. (<a class="reference internal" href="../library/sys.html#sys.int_info.str_digits_check_threshold" title="sys.int_info.str_digits_check_threshold"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.int_info.str_digits_check_threshold</span></code></a>) are unsupported and

  1040. will produce an error.</p>

  1041. <p>Configured by the <a class="reference internal" href="../using/cmdline.html#cmdoption-X"><code class="xref std std-option docutils literal notranslate"><span class="pre">-X</span> <span class="pre">int_max_str_digits</span></code></a> command line

  1042. flag or the <span class="target" id="index-15"></span><a class="reference internal" href="../using/cmdline.html#envvar-PYTHONINTMAXSTRDIGITS"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PYTHONINTMAXSTRDIGITS</span></code></a> environment variable.</p>

  1043. <p>Default: <code class="docutils literal notranslate"><span class="pre">-1</span></code> in Python mode.  4300

  1044. (<a class="reference internal" href="../library/sys.html#sys.int_info.default_max_str_digits" title="sys.int_info.default_max_str_digits"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.int_info.default_max_str_digits</span></code></a>) in isolated mode.</p>

  1045. <div class="versionadded">

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

  1047. </div>

  1048. </dd></dl>

  1049. 

  1050. <dl class="c member">

  1051. <dt class="sig sig-object c" id="c.PyConfig.isolated">

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

  1053. <dd><p>If greater than <code class="docutils literal notranslate"><span class="pre">0</span></code>, enable isolated mode:</p>

  1054. <ul class="simple">

  1055. <li><p>Set <a class="reference internal" href="#c.PyConfig.safe_path" title="PyConfig.safe_path"><code class="xref c c-member docutils literal notranslate"><span class="pre">safe_path</span></code></a> to <code class="docutils literal notranslate"><span class="pre">1</span></code>:

  1056. don’t prepend a potentially unsafe path to <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> at Python

  1057. startup, such as the current directory, the script’s directory or an

  1058. empty string.</p></li>

  1059. <li><p>Set <a class="reference internal" href="#c.PyConfig.use_environment" title="PyConfig.use_environment"><code class="xref c c-member docutils literal notranslate"><span class="pre">use_environment</span></code></a> to <code class="docutils literal notranslate"><span class="pre">0</span></code>: ignore <code class="docutils literal notranslate"><span class="pre">PYTHON</span></code>

  1060. environment variables.</p></li>

  1061. <li><p>Set <a class="reference internal" href="#c.PyConfig.user_site_directory" title="PyConfig.user_site_directory"><code class="xref c c-member docutils literal notranslate"><span class="pre">user_site_directory</span></code></a> to <code class="docutils literal notranslate"><span class="pre">0</span></code>: don’t add the user

  1062. site directory to <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>.</p></li>

  1063. <li><p>Python REPL doesn’t import <a class="reference internal" href="../library/readline.html#module-readline" title="readline: GNU readline support for Python. (Unix)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">readline</span></code></a> nor enable default readline

  1064. configuration on interactive prompts.</p></li>

  1065. </ul>

  1066. <p>Set to <code class="docutils literal notranslate"><span class="pre">1</span></code> by the <a class="reference internal" href="../using/cmdline.html#cmdoption-I"><code class="xref std std-option docutils literal notranslate"><span class="pre">-I</span></code></a> command line option.</p>

  1067. <p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code> in Python mode, <code class="docutils literal notranslate"><span class="pre">1</span></code> in isolated mode.</p>

  1068. <p>See also the <a class="reference internal" href="#init-isolated-conf"><span class="std std-ref">Isolated Configuration</span></a> and

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

  1070. </dd></dl>

  1071. 

  1072. <dl class="c member">

  1073. <dt class="sig sig-object c" id="c.PyConfig.legacy_windows_stdio">

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

  1075. <dd><p>If non-zero, use <a class="reference internal" href="../library/io.html#io.FileIO" title="io.FileIO"><code class="xref py py-class docutils literal notranslate"><span class="pre">io.FileIO</span></code></a> instead of

  1076. <code class="xref py py-class docutils literal notranslate"><span class="pre">io._WindowsConsoleIO</span></code> for <a class="reference internal" href="../library/sys.html#sys.stdin" title="sys.stdin"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.stdin</span></code></a>, <a class="reference internal" href="../library/sys.html#sys.stdout" title="sys.stdout"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.stdout</span></code></a>

  1077. and <a class="reference internal" href="../library/sys.html#sys.stderr" title="sys.stderr"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.stderr</span></code></a>.</p>

  1078. <p>Set to <code class="docutils literal notranslate"><span class="pre">1</span></code> if the <span class="target" id="index-16"></span><a class="reference internal" href="../using/cmdline.html#envvar-PYTHONLEGACYWINDOWSSTDIO"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PYTHONLEGACYWINDOWSSTDIO</span></code></a> environment

  1079. variable is set to a non-empty string.</p>

  1080. <p>Only available on Windows. <code class="docutils literal notranslate"><span class="pre">#ifdef</span> <span class="pre">MS_WINDOWS</span></code> macro can be used for

  1081. Windows specific code.</p>

  1082. <p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code>.</p>

  1083. <p>See also the <span class="target" id="index-17"></span><a class="pep reference external" href="https://peps.python.org/pep-0528/"><strong>PEP 528</strong></a> (Change Windows console encoding to UTF-8).</p>

  1084. </dd></dl>

  1085. 

  1086. <dl class="c member">

  1087. <dt class="sig sig-object c" id="c.PyConfig.malloc_stats">

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

  1089. <dd><p>If non-zero, dump statistics on <a class="reference internal" href="memory.html#pymalloc"><span class="std std-ref">Python pymalloc memory allocator</span></a> at exit.</p>

  1090. <p>Set to <code class="docutils literal notranslate"><span class="pre">1</span></code> by the <span class="target" id="index-18"></span><a class="reference internal" href="../using/cmdline.html#envvar-PYTHONMALLOCSTATS"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PYTHONMALLOCSTATS</span></code></a> environment variable.</p>

  1091. <p>The option is ignored if Python is <a class="reference internal" href="../using/configure.html#cmdoption-without-pymalloc"><code class="xref std std-option docutils literal notranslate"><span class="pre">configured</span> <span class="pre">using</span>

  1092. <span class="pre">the</span> <span class="pre">--without-pymalloc</span> <span class="pre">option</span></code></a>.</p>

  1093. <p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code>.</p>

  1094. </dd></dl>

  1095. 

  1096. <dl class="c member">

  1097. <dt class="sig sig-object c" id="c.PyConfig.platlibdir">

  1098. <span class="n"><span class="pre">wchar_t</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">platlibdir</span></span></span><a class="headerlink" href="#c.PyConfig.platlibdir" title="Link to this definition">¶</a><br /></dt>

  1099. <dd><p>Platform library directory name: <a class="reference internal" href="../library/sys.html#sys.platlibdir" title="sys.platlibdir"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.platlibdir</span></code></a>.</p>

  1100. <p>Set by the <span class="target" id="index-19"></span><a class="reference internal" href="../using/cmdline.html#envvar-PYTHONPLATLIBDIR"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PYTHONPLATLIBDIR</span></code></a> environment variable.</p>

  1101. <p>Default: value of the <code class="docutils literal notranslate"><span class="pre">PLATLIBDIR</span></code> macro which is set by the

  1102. <a class="reference internal" href="../using/configure.html#cmdoption-with-platlibdir"><code class="xref std std-option docutils literal notranslate"><span class="pre">configure</span> <span class="pre">--with-platlibdir</span> <span class="pre">option</span></code></a>

  1103. (default: <code class="docutils literal notranslate"><span class="pre">&quot;lib&quot;</span></code>, or <code class="docutils literal notranslate"><span class="pre">&quot;DLLs&quot;</span></code> on Windows).</p>

  1104. <p>Part of the <a class="reference internal" href="#init-path-config"><span class="std std-ref">Python Path Configuration</span></a> input.</p>

  1105. <div class="versionadded">

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

  1107. </div>

  1108. <div class="versionchanged">

  1109. <p><span class="versionmodified changed">Changed in version 3.11: </span>This macro is now used on Windows to locate the standard

  1110. library extension modules, typically under <code class="docutils literal notranslate"><span class="pre">DLLs</span></code>. However,

  1111. for compatibility, note that this value is ignored for any

  1112. non-standard layouts, including in-tree builds and virtual

  1113. environments.</p>

  1114. </div>

  1115. </dd></dl>

  1116. 

  1117. <dl class="c member">

  1118. <dt class="sig sig-object c" id="c.PyConfig.pythonpath_env">

  1119. <span class="n"><span class="pre">wchar_t</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">pythonpath_env</span></span></span><a class="headerlink" href="#c.PyConfig.pythonpath_env" title="Link to this definition">¶</a><br /></dt>

  1120. <dd><p>Module search paths (<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>) as a string separated by <code class="docutils literal notranslate"><span class="pre">DELIM</span></code>

  1121. (<a class="reference internal" href="../library/os.html#os.pathsep" title="os.pathsep"><code class="xref py py-data docutils literal notranslate"><span class="pre">os.pathsep</span></code></a>).</p>

  1122. <p>Set by the <span class="target" id="index-20"></span><a class="reference internal" href="../using/cmdline.html#envvar-PYTHONPATH"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PYTHONPATH</span></code></a> environment variable.</p>

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

  1124. <p>Part of the <a class="reference internal" href="#init-path-config"><span class="std std-ref">Python Path Configuration</span></a> input.</p>

  1125. </dd></dl>

  1126. 

  1127. <dl class="c member">

  1128. <dt class="sig sig-object c" id="c.PyConfig.module_search_paths">

  1129. <a class="reference internal" href="#c.PyWideStringList" title="PyWideStringList"><span class="n"><span class="pre">PyWideStringList</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">module_search_paths</span></span></span><a class="headerlink" href="#c.PyConfig.module_search_paths" title="Link to this definition">¶</a><br /></dt>

  1130. <dd></dd></dl>

  1131. 

  1132. <dl class="c member">

  1133. <dt class="sig sig-object c" id="c.PyConfig.module_search_paths_set">

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

  1135. <dd><p>Module search paths: <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>.</p>

  1136. <p>If <a class="reference internal" href="#c.PyConfig.module_search_paths_set" title="PyConfig.module_search_paths_set"><code class="xref c c-member docutils literal notranslate"><span class="pre">module_search_paths_set</span></code></a> is equal to <code class="docutils literal notranslate"><span class="pre">0</span></code>,

  1137. <a class="reference internal" href="#c.Py_InitializeFromConfig" title="Py_InitializeFromConfig"><code class="xref c c-func docutils literal notranslate"><span class="pre">Py_InitializeFromConfig()</span></code></a> will replace

  1138. <a class="reference internal" href="#c.PyConfig.module_search_paths" title="PyConfig.module_search_paths"><code class="xref c c-member docutils literal notranslate"><span class="pre">module_search_paths</span></code></a> and sets

  1139. <a class="reference internal" href="#c.PyConfig.module_search_paths_set" title="PyConfig.module_search_paths_set"><code class="xref c c-member docutils literal notranslate"><span class="pre">module_search_paths_set</span></code></a> to <code class="docutils literal notranslate"><span class="pre">1</span></code>.</p>

  1140. <p>Default: empty list (<code class="docutils literal notranslate"><span class="pre">module_search_paths</span></code>) and <code class="docutils literal notranslate"><span class="pre">0</span></code>

  1141. (<code class="docutils literal notranslate"><span class="pre">module_search_paths_set</span></code>).</p>

  1142. <p>Part of the <a class="reference internal" href="#init-path-config"><span class="std std-ref">Python Path Configuration</span></a> output.</p>

  1143. </dd></dl>

  1144. 

  1145. <dl class="c member">

  1146. <dt class="sig sig-object c" id="c.PyConfig.optimization_level">

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

  1148. <dd><p>Compilation optimization level:</p>

  1149. <ul class="simple">

  1150. <li><p><code class="docutils literal notranslate"><span class="pre">0</span></code>: Peephole optimizer, set <code class="docutils literal notranslate"><span class="pre">__debug__</span></code> to <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p></li>

  1151. <li><p><code class="docutils literal notranslate"><span class="pre">1</span></code>: Level 0, remove assertions, set <code class="docutils literal notranslate"><span class="pre">__debug__</span></code> to <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p></li>

  1152. <li><p><code class="docutils literal notranslate"><span class="pre">2</span></code>: Level 1, strip docstrings.</p></li>

  1153. </ul>

  1154. <p>Incremented by the <a class="reference internal" href="../using/cmdline.html#cmdoption-O"><code class="xref std std-option docutils literal notranslate"><span class="pre">-O</span></code></a> command line option. Set to the

  1155. <span class="target" id="index-21"></span><a class="reference internal" href="../using/cmdline.html#envvar-PYTHONOPTIMIZE"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PYTHONOPTIMIZE</span></code></a> environment variable value.</p>

  1156. <p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code>.</p>

  1157. </dd></dl>

  1158. 

  1159. <dl class="c member">

  1160. <dt class="sig sig-object c" id="c.PyConfig.orig_argv">

  1161. <a class="reference internal" href="#c.PyWideStringList" title="PyWideStringList"><span class="n"><span class="pre">PyWideStringList</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">orig_argv</span></span></span><a class="headerlink" href="#c.PyConfig.orig_argv" title="Link to this definition">¶</a><br /></dt>

  1162. <dd><p>The list of the original command line arguments passed to the Python

  1163. executable: <a class="reference internal" href="../library/sys.html#sys.orig_argv" title="sys.orig_argv"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.orig_argv</span></code></a>.</p>

  1164. <p>If <a class="reference internal" href="#c.PyConfig.orig_argv" title="PyConfig.orig_argv"><code class="xref c c-member docutils literal notranslate"><span class="pre">orig_argv</span></code></a> list is empty and

  1165. <a class="reference internal" href="#c.PyConfig.argv" title="PyConfig.argv"><code class="xref c c-member docutils literal notranslate"><span class="pre">argv</span></code></a> is not a list only containing an empty

  1166. string, <a class="reference internal" href="#c.PyConfig_Read" title="PyConfig_Read"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyConfig_Read()</span></code></a> copies <a class="reference internal" href="#c.PyConfig.argv" title="PyConfig.argv"><code class="xref c c-member docutils literal notranslate"><span class="pre">argv</span></code></a> into

  1167. <a class="reference internal" href="#c.PyConfig.orig_argv" title="PyConfig.orig_argv"><code class="xref c c-member docutils literal notranslate"><span class="pre">orig_argv</span></code></a> before modifying

  1168. <a class="reference internal" href="#c.PyConfig.argv" title="PyConfig.argv"><code class="xref c c-member docutils literal notranslate"><span class="pre">argv</span></code></a> (if <a class="reference internal" href="#c.PyConfig.parse_argv" title="PyConfig.parse_argv"><code class="xref c c-member docutils literal notranslate"><span class="pre">parse_argv</span></code></a> is

  1169. non-zero).</p>

  1170. <p>See also the <a class="reference internal" href="#c.PyConfig.argv" title="PyConfig.argv"><code class="xref c c-member docutils literal notranslate"><span class="pre">argv</span></code></a> member and the

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

  1172. <p>Default: empty list.</p>

  1173. <div class="versionadded">

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

  1175. </div>

  1176. </dd></dl>

  1177. 

  1178. <dl class="c member">

  1179. <dt class="sig sig-object c" id="c.PyConfig.parse_argv">

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

  1181. <dd><p>Parse command line arguments?</p>

  1182. <p>If equals to <code class="docutils literal notranslate"><span class="pre">1</span></code>, parse <a class="reference internal" href="#c.PyConfig.argv" title="PyConfig.argv"><code class="xref c c-member docutils literal notranslate"><span class="pre">argv</span></code></a> the same way the regular

  1183. Python parses <a class="reference internal" href="../using/cmdline.html#using-on-cmdline"><span class="std std-ref">command line arguments</span></a>, and strip

  1184. Python arguments from <a class="reference internal" href="#c.PyConfig.argv" title="PyConfig.argv"><code class="xref c c-member docutils literal notranslate"><span class="pre">argv</span></code></a>.</p>

  1185. <p>The <a class="reference internal" href="#c.PyConfig_Read" title="PyConfig_Read"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyConfig_Read()</span></code></a> function only parses

  1186. <a class="reference internal" href="#c.PyConfig.argv" title="PyConfig.argv"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.argv</span></code></a> arguments once: <a class="reference internal" href="#c.PyConfig.parse_argv" title="PyConfig.parse_argv"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.parse_argv</span></code></a>

  1187. is set to <code class="docutils literal notranslate"><span class="pre">2</span></code> after arguments are parsed. Since Python arguments are

  1188. strippped from <a class="reference internal" href="#c.PyConfig.argv" title="PyConfig.argv"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.argv</span></code></a>, parsing arguments twice would

  1189. parse the application options as Python options.</p>

  1190. <p>Default: <code class="docutils literal notranslate"><span class="pre">1</span></code> in Python mode, <code class="docutils literal notranslate"><span class="pre">0</span></code> in isolated mode.</p>

  1191. <div class="versionchanged">

  1192. <p><span class="versionmodified changed">Changed in version 3.10: </span>The <a class="reference internal" href="#c.PyConfig.argv" title="PyConfig.argv"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.argv</span></code></a> arguments are now only parsed if

  1193. <a class="reference internal" href="#c.PyConfig.parse_argv" title="PyConfig.parse_argv"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.parse_argv</span></code></a> equals to <code class="docutils literal notranslate"><span class="pre">1</span></code>.</p>

  1194. </div>

  1195. </dd></dl>

  1196. 

  1197. <dl class="c member">

  1198. <dt class="sig sig-object c" id="c.PyConfig.parser_debug">

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

  1200. <dd><p>Parser debug mode. If greater than <code class="docutils literal notranslate"><span class="pre">0</span></code>, turn on parser debugging output (for expert only, depending

  1201. on compilation options).</p>

  1202. <p>Incremented by the <a class="reference internal" href="../using/cmdline.html#cmdoption-d"><code class="xref std std-option docutils literal notranslate"><span class="pre">-d</span></code></a> command line option. Set to the

  1203. <span class="target" id="index-22"></span><a class="reference internal" href="../using/cmdline.html#envvar-PYTHONDEBUG"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PYTHONDEBUG</span></code></a> environment variable value.</p>

  1204. <p>Need a <a class="reference internal" href="../using/configure.html#debug-build"><span class="std std-ref">debug build of Python</span></a> (the <code class="docutils literal notranslate"><span class="pre">Py_DEBUG</span></code> macro

  1205. must be defined).</p>

  1206. <p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code>.</p>

  1207. </dd></dl>

  1208. 

  1209. <dl class="c member">

  1210. <dt class="sig sig-object c" id="c.PyConfig.pathconfig_warnings">

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

  1212. <dd><p>If non-zero, calculation of path configuration is allowed to log

  1213. warnings into <code class="docutils literal notranslate"><span class="pre">stderr</span></code>. If equals to <code class="docutils literal notranslate"><span class="pre">0</span></code>, suppress these warnings.</p>

  1214. <p>Default: <code class="docutils literal notranslate"><span class="pre">1</span></code> in Python mode, <code class="docutils literal notranslate"><span class="pre">0</span></code> in isolated mode.</p>

  1215. <p>Part of the <a class="reference internal" href="#init-path-config"><span class="std std-ref">Python Path Configuration</span></a> input.</p>

  1216. <div class="versionchanged">

  1217. <p><span class="versionmodified changed">Changed in version 3.11: </span>Now also applies on Windows.</p>

  1218. </div>

  1219. </dd></dl>

  1220. 

  1221. <dl class="c member">

  1222. <dt class="sig sig-object c" id="c.PyConfig.prefix">

  1223. <span class="n"><span class="pre">wchar_t</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">prefix</span></span></span><a class="headerlink" href="#c.PyConfig.prefix" title="Link to this definition">¶</a><br /></dt>

  1224. <dd><p>The site-specific directory prefix where the platform independent Python

  1225. files are installed: <a class="reference internal" href="../library/sys.html#sys.prefix" title="sys.prefix"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.prefix</span></code></a>.</p>

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

  1227. <p>Part of the <a class="reference internal" href="#init-path-config"><span class="std std-ref">Python Path Configuration</span></a> output.</p>

  1228. </dd></dl>

  1229. 

  1230. <dl class="c member">

  1231. <dt class="sig sig-object c" id="c.PyConfig.program_name">

  1232. <span class="n"><span class="pre">wchar_t</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">program_name</span></span></span><a class="headerlink" href="#c.PyConfig.program_name" title="Link to this definition">¶</a><br /></dt>

  1233. <dd><p>Program name used to initialize <a class="reference internal" href="#c.PyConfig.executable" title="PyConfig.executable"><code class="xref c c-member docutils literal notranslate"><span class="pre">executable</span></code></a> and in

  1234. early error messages during Python initialization.</p>

  1235. <ul class="simple">

  1236. <li><p>If <code class="xref py py-func docutils literal notranslate"><span class="pre">Py_SetProgramName()</span></code> has been called, use its argument.</p></li>

  1237. <li><p>On macOS, use <span class="target" id="index-23"></span><a class="reference internal" href="../using/cmdline.html#envvar-PYTHONEXECUTABLE"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PYTHONEXECUTABLE</span></code></a> environment variable if set.</p></li>

  1238. <li><p>If the <code class="docutils literal notranslate"><span class="pre">WITH_NEXT_FRAMEWORK</span></code> macro is defined, use

  1239. <span class="target" id="index-24"></span><code class="xref std std-envvar docutils literal notranslate"><span class="pre">__PYVENV_LAUNCHER__</span></code> environment variable if set.</p></li>

  1240. <li><p>Use <code class="docutils literal notranslate"><span class="pre">argv[0]</span></code> of <a class="reference internal" href="#c.PyConfig.argv" title="PyConfig.argv"><code class="xref c c-member docutils literal notranslate"><span class="pre">argv</span></code></a> if available and

  1241. non-empty.</p></li>

  1242. <li><p>Otherwise, use <code class="docutils literal notranslate"><span class="pre">L&quot;python&quot;</span></code> on Windows, or <code class="docutils literal notranslate"><span class="pre">L&quot;python3&quot;</span></code> on other

  1243. platforms.</p></li>

  1244. </ul>

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

  1246. <p>Part of the <a class="reference internal" href="#init-path-config"><span class="std std-ref">Python Path Configuration</span></a> input.</p>

  1247. </dd></dl>

  1248. 

  1249. <dl class="c member">

  1250. <dt class="sig sig-object c" id="c.PyConfig.pycache_prefix">

  1251. <span class="n"><span class="pre">wchar_t</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">pycache_prefix</span></span></span><a class="headerlink" href="#c.PyConfig.pycache_prefix" title="Link to this definition">¶</a><br /></dt>

  1252. <dd><p>Directory where cached <code class="docutils literal notranslate"><span class="pre">.pyc</span></code> files are written:

  1253. <a class="reference internal" href="../library/sys.html#sys.pycache_prefix" title="sys.pycache_prefix"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.pycache_prefix</span></code></a>.</p>

  1254. <p>Set by the <a class="reference internal" href="../using/cmdline.html#cmdoption-X"><code class="xref std std-option docutils literal notranslate"><span class="pre">-X</span> <span class="pre">pycache_prefix=PATH</span></code></a> command line option and

  1255. the <span class="target" id="index-25"></span><a class="reference internal" href="../using/cmdline.html#envvar-PYTHONPYCACHEPREFIX"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PYTHONPYCACHEPREFIX</span></code></a> environment variable.</p>

  1256. <p>If <code class="docutils literal notranslate"><span class="pre">NULL</span></code>, <a class="reference internal" href="../library/sys.html#sys.pycache_prefix" title="sys.pycache_prefix"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.pycache_prefix</span></code></a> is set to <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>

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

  1258. </dd></dl>

  1259. 

  1260. <dl class="c member">

  1261. <dt class="sig sig-object c" id="c.PyConfig.quiet">

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

  1263. <dd><p>Quiet mode. If greater than <code class="docutils literal notranslate"><span class="pre">0</span></code>, don’t display the copyright and version at

  1264. Python startup in interactive mode.</p>

  1265. <p>Incremented by the <a class="reference internal" href="../using/cmdline.html#cmdoption-q"><code class="xref std std-option docutils literal notranslate"><span class="pre">-q</span></code></a> command line option.</p>

  1266. <p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code>.</p>

  1267. </dd></dl>

  1268. 

  1269. <dl class="c member">

  1270. <dt class="sig sig-object c" id="c.PyConfig.run_command">

  1271. <span class="n"><span class="pre">wchar_t</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">run_command</span></span></span><a class="headerlink" href="#c.PyConfig.run_command" title="Link to this definition">¶</a><br /></dt>

  1272. <dd><p>Value of the <a class="reference internal" href="../using/cmdline.html#cmdoption-c"><code class="xref std std-option docutils literal notranslate"><span class="pre">-c</span></code></a> command line option.</p>

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

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

  1275. </dd></dl>

  1276. 

  1277. <dl class="c member">

  1278. <dt class="sig sig-object c" id="c.PyConfig.run_filename">

  1279. <span class="n"><span class="pre">wchar_t</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">run_filename</span></span></span><a class="headerlink" href="#c.PyConfig.run_filename" title="Link to this definition">¶</a><br /></dt>

  1280. <dd><p>Filename passed on the command line: trailing command line argument

  1281. without <a class="reference internal" href="../using/cmdline.html#cmdoption-c"><code class="xref std std-option docutils literal notranslate"><span class="pre">-c</span></code></a> or <a class="reference internal" href="../using/cmdline.html#cmdoption-m"><code class="xref std std-option docutils literal notranslate"><span class="pre">-m</span></code></a>. It is used by the

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

  1283. <p>For example, it is set to <code class="docutils literal notranslate"><span class="pre">script.py</span></code> by the <code class="docutils literal notranslate"><span class="pre">python3</span> <span class="pre">script.py</span> <span class="pre">arg</span></code>

  1284. command line.</p>

  1285. <p>See also the <a class="reference internal" href="#c.PyConfig.skip_source_first_line" title="PyConfig.skip_source_first_line"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.skip_source_first_line</span></code></a> option.</p>

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

  1287. </dd></dl>

  1288. 

  1289. <dl class="c member">

  1290. <dt class="sig sig-object c" id="c.PyConfig.run_module">

  1291. <span class="n"><span class="pre">wchar_t</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">run_module</span></span></span><a class="headerlink" href="#c.PyConfig.run_module" title="Link to this definition">¶</a><br /></dt>

  1292. <dd><p>Value of the <a class="reference internal" href="../using/cmdline.html#cmdoption-m"><code class="xref std std-option docutils literal notranslate"><span class="pre">-m</span></code></a> command line option.</p>

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

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

  1295. </dd></dl>

  1296. 

  1297. <dl class="c member">

  1298. <dt class="sig sig-object c" id="c.PyConfig.show_ref_count">

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

  1300. <dd><p>Show total reference count at exit (excluding immortal objects)?</p>

  1301. <p>Set to <code class="docutils literal notranslate"><span class="pre">1</span></code> by <a class="reference internal" href="../using/cmdline.html#cmdoption-X"><code class="xref std std-option docutils literal notranslate"><span class="pre">-X</span> <span class="pre">showrefcount</span></code></a> command line option.</p>

  1302. <p>Need a <a class="reference internal" href="../using/configure.html#debug-build"><span class="std std-ref">debug build of Python</span></a> (the <code class="docutils literal notranslate"><span class="pre">Py_REF_DEBUG</span></code>

  1303. macro must be defined).</p>

  1304. <p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code>.</p>

  1305. </dd></dl>

  1306. 

  1307. <dl class="c member">

  1308. <dt class="sig sig-object c" id="c.PyConfig.site_import">

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

  1310. <dd><p>Import the <a class="reference internal" href="../library/site.html#module-site" title="site: Module responsible for site-specific configuration."><code class="xref py py-mod docutils literal notranslate"><span class="pre">site</span></code></a> module at startup?</p>

  1311. <p>If equal to zero, disable the import of the module site and the

  1312. site-dependent manipulations of <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> that it entails.</p>

  1313. <p>Also disable these manipulations if the <a class="reference internal" href="../library/site.html#module-site" title="site: Module responsible for site-specific configuration."><code class="xref py py-mod docutils literal notranslate"><span class="pre">site</span></code></a> module is explicitly

  1314. imported later (call <a class="reference internal" href="../library/site.html#site.main" title="site.main"><code class="xref py py-func docutils literal notranslate"><span class="pre">site.main()</span></code></a> if you want them to be triggered).</p>

  1315. <p>Set to <code class="docutils literal notranslate"><span class="pre">0</span></code> by the <a class="reference internal" href="../using/cmdline.html#cmdoption-S"><code class="xref std std-option docutils literal notranslate"><span class="pre">-S</span></code></a> command line option.</p>

  1316. <p><a class="reference internal" href="../library/sys.html#sys.flags" title="sys.flags"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.flags.no_site</span></code></a> is set to the inverted value of

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

  1318. <p>Default: <code class="docutils literal notranslate"><span class="pre">1</span></code>.</p>

  1319. </dd></dl>

  1320. 

  1321. <dl class="c member">

  1322. <dt class="sig sig-object c" id="c.PyConfig.skip_source_first_line">

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

  1324. <dd><p>If non-zero, skip the first line of the <a class="reference internal" href="#c.PyConfig.run_filename" title="PyConfig.run_filename"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.run_filename</span></code></a>

  1325. source.</p>

  1326. <p>It allows the usage of non-Unix forms of <code class="docutils literal notranslate"><span class="pre">#!cmd</span></code>. This is intended for

  1327. a DOS specific hack only.</p>

  1328. <p>Set to <code class="docutils literal notranslate"><span class="pre">1</span></code> by the <a class="reference internal" href="../using/cmdline.html#cmdoption-x"><code class="xref std std-option docutils literal notranslate"><span class="pre">-x</span></code></a> command line option.</p>

  1329. <p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code>.</p>

  1330. </dd></dl>

  1331. 

  1332. <dl class="c member">

  1333. <dt class="sig sig-object c" id="c.PyConfig.stdio_encoding">

  1334. <span class="n"><span class="pre">wchar_t</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">stdio_encoding</span></span></span><a class="headerlink" href="#c.PyConfig.stdio_encoding" title="Link to this definition">¶</a><br /></dt>

  1335. <dd></dd></dl>

  1336. 

  1337. <dl class="c member">

  1338. <dt class="sig sig-object c" id="c.PyConfig.stdio_errors">

  1339. <span class="n"><span class="pre">wchar_t</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">stdio_errors</span></span></span><a class="headerlink" href="#c.PyConfig.stdio_errors" title="Link to this definition">¶</a><br /></dt>

  1340. <dd><p>Encoding and encoding errors of <a class="reference internal" href="../library/sys.html#sys.stdin" title="sys.stdin"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.stdin</span></code></a>, <a class="reference internal" href="../library/sys.html#sys.stdout" title="sys.stdout"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.stdout</span></code></a> and

  1341. <a class="reference internal" href="../library/sys.html#sys.stderr" title="sys.stderr"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.stderr</span></code></a> (but <a class="reference internal" href="../library/sys.html#sys.stderr" title="sys.stderr"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.stderr</span></code></a> always uses

  1342. <code class="docutils literal notranslate"><span class="pre">&quot;backslashreplace&quot;</span></code> error handler).</p>

  1343. <p>If <a class="reference internal" href="init.html#c.Py_SetStandardStreamEncoding" title="Py_SetStandardStreamEncoding"><code class="xref c c-func docutils literal notranslate"><span class="pre">Py_SetStandardStreamEncoding()</span></code></a> has been called, use its

  1344. <em>error</em> and <em>errors</em> arguments if they are not <code class="docutils literal notranslate"><span class="pre">NULL</span></code>.</p>

  1345. <p>Use the <span class="target" id="index-26"></span><a class="reference internal" href="../using/cmdline.html#envvar-PYTHONIOENCODING"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PYTHONIOENCODING</span></code></a> environment variable if it is

  1346. non-empty.</p>

  1347. <p>Default encoding:</p>

  1348. <ul class="simple">

  1349. <li><p><code class="docutils literal notranslate"><span class="pre">&quot;UTF-8&quot;</span></code> if <a class="reference internal" href="#c.PyPreConfig.utf8_mode" title="PyPreConfig.utf8_mode"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyPreConfig.utf8_mode</span></code></a> is non-zero.</p></li>

  1350. <li><p>Otherwise, use the <a class="reference internal" href="../glossary.html#term-locale-encoding"><span class="xref std std-term">locale encoding</span></a>.</p></li>

  1351. </ul>

  1352. <p>Default error handler:</p>

  1353. <ul class="simple">

  1354. <li><p>On Windows: use <code class="docutils literal notranslate"><span class="pre">&quot;surrogateescape&quot;</span></code>.</p></li>

  1355. <li><p><code class="docutils literal notranslate"><span class="pre">&quot;surrogateescape&quot;</span></code> if <a class="reference internal" href="#c.PyPreConfig.utf8_mode" title="PyPreConfig.utf8_mode"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyPreConfig.utf8_mode</span></code></a> is non-zero,

  1356. or if the LC_CTYPE locale is “C” or “POSIX”.</p></li>

  1357. <li><p><code class="docutils literal notranslate"><span class="pre">&quot;strict&quot;</span></code> otherwise.</p></li>

  1358. </ul>

  1359. </dd></dl>

  1360. 

  1361. <dl class="c member">

  1362. <dt class="sig sig-object c" id="c.PyConfig.tracemalloc">

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

  1364. <dd><p>Enable tracemalloc?</p>

  1365. <p>If non-zero, call <a class="reference internal" href="../library/tracemalloc.html#tracemalloc.start" title="tracemalloc.start"><code class="xref py py-func docutils literal notranslate"><span class="pre">tracemalloc.start()</span></code></a> at startup.</p>

  1366. <p>Set by <a class="reference internal" href="../using/cmdline.html#cmdoption-X"><code class="xref std std-option docutils literal notranslate"><span class="pre">-X</span> <span class="pre">tracemalloc=N</span></code></a> command line option and by the

  1367. <span class="target" id="index-27"></span><a class="reference internal" href="../using/cmdline.html#envvar-PYTHONTRACEMALLOC"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PYTHONTRACEMALLOC</span></code></a> environment variable.</p>

  1368. <p>Default: <code class="docutils literal notranslate"><span class="pre">-1</span></code> in Python mode, <code class="docutils literal notranslate"><span class="pre">0</span></code> in isolated mode.</p>

  1369. </dd></dl>

  1370. 

  1371. <dl class="c member">

  1372. <dt class="sig sig-object c" id="c.PyConfig.perf_profiling">

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

  1374. <dd><p>Enable compatibility mode with the perf profiler?</p>

  1375. <p>If non-zero, initialize the perf trampoline. See <a class="reference internal" href="../howto/perf_profiling.html#perf-profiling"><span class="std std-ref">Python support for the Linux perf profiler</span></a>

  1376. for more information.</p>

  1377. <p>Set by <a class="reference internal" href="../using/cmdline.html#cmdoption-X"><code class="xref std std-option docutils literal notranslate"><span class="pre">-X</span> <span class="pre">perf</span></code></a> command line option and by the

  1378. <span class="target" id="index-28"></span><a class="reference internal" href="../using/cmdline.html#envvar-PYTHONPERFSUPPORT"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PYTHONPERFSUPPORT</span></code></a> environment variable.</p>

  1379. <p>Default: <code class="docutils literal notranslate"><span class="pre">-1</span></code>.</p>

  1380. <div class="versionadded">

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

  1382. </div>

  1383. </dd></dl>

  1384. 

  1385. <dl class="c member">

  1386. <dt class="sig sig-object c" id="c.PyConfig.use_environment">

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

  1388. <dd><p>Use <a class="reference internal" href="../using/cmdline.html#using-on-envvars"><span class="std std-ref">environment variables</span></a>?</p>

  1389. <p>If equals to zero, ignore the <a class="reference internal" href="../using/cmdline.html#using-on-envvars"><span class="std std-ref">environment variables</span></a>.</p>

  1390. <p>Set to <code class="docutils literal notranslate"><span class="pre">0</span></code> by the <a class="reference internal" href="../using/cmdline.html#cmdoption-E"><code class="xref std std-option docutils literal notranslate"><span class="pre">-E</span></code></a> environment variable.</p>

  1391. <p>Default: <code class="docutils literal notranslate"><span class="pre">1</span></code> in Python config and <code class="docutils literal notranslate"><span class="pre">0</span></code> in isolated config.</p>

  1392. </dd></dl>

  1393. 

  1394. <dl class="c member">

  1395. <dt class="sig sig-object c" id="c.PyConfig.user_site_directory">

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

  1397. <dd><p>If non-zero, add the user site directory to <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>.</p>

  1398. <p>Set to <code class="docutils literal notranslate"><span class="pre">0</span></code> by the <a class="reference internal" href="../using/cmdline.html#cmdoption-s"><code class="xref std std-option docutils literal notranslate"><span class="pre">-s</span></code></a> and <a class="reference internal" href="../using/cmdline.html#cmdoption-I"><code class="xref std std-option docutils literal notranslate"><span class="pre">-I</span></code></a> command line options.</p>

  1399. <p>Set to <code class="docutils literal notranslate"><span class="pre">0</span></code> by the <span class="target" id="index-29"></span><a class="reference internal" href="../using/cmdline.html#envvar-PYTHONNOUSERSITE"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PYTHONNOUSERSITE</span></code></a> environment variable.</p>

  1400. <p>Default: <code class="docutils literal notranslate"><span class="pre">1</span></code> in Python mode, <code class="docutils literal notranslate"><span class="pre">0</span></code> in isolated mode.</p>

  1401. </dd></dl>

  1402. 

  1403. <dl class="c member">

  1404. <dt class="sig sig-object c" id="c.PyConfig.verbose">

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

  1406. <dd><p>Verbose mode. If greater than <code class="docutils literal notranslate"><span class="pre">0</span></code>, print a message each time a module is

  1407. imported, showing the place (filename or built-in module) from which

  1408. it is loaded.</p>

  1409. <p>If greater than or equal to <code class="docutils literal notranslate"><span class="pre">2</span></code>, print a message for each file that is

  1410. checked for when searching for a module. Also provides information on

  1411. module cleanup at exit.</p>

  1412. <p>Incremented by the <a class="reference internal" href="../using/cmdline.html#cmdoption-v"><code class="xref std std-option docutils literal notranslate"><span class="pre">-v</span></code></a> command line option.</p>

  1413. <p>Set by the <span class="target" id="index-30"></span><a class="reference internal" href="../using/cmdline.html#envvar-PYTHONVERBOSE"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PYTHONVERBOSE</span></code></a> environment variable value.</p>

  1414. <p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code>.</p>

  1415. </dd></dl>

  1416. 

  1417. <dl class="c member">

  1418. <dt class="sig sig-object c" id="c.PyConfig.warnoptions">

  1419. <a class="reference internal" href="#c.PyWideStringList" title="PyWideStringList"><span class="n"><span class="pre">PyWideStringList</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">warnoptions</span></span></span><a class="headerlink" href="#c.PyConfig.warnoptions" title="Link to this definition">¶</a><br /></dt>

  1420. <dd><p>Options of the <a class="reference internal" href="../library/warnings.html#module-warnings" title="warnings: Issue warning messages and control their disposition."><code class="xref py py-mod docutils literal notranslate"><span class="pre">warnings</span></code></a> module to build warnings filters, lowest

  1421. to highest priority: <a class="reference internal" href="../library/sys.html#sys.warnoptions" title="sys.warnoptions"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.warnoptions</span></code></a>.</p>

  1422. <p>The <a class="reference internal" href="../library/warnings.html#module-warnings" title="warnings: Issue warning messages and control their disposition."><code class="xref py py-mod docutils literal notranslate"><span class="pre">warnings</span></code></a> module adds <a class="reference internal" href="../library/sys.html#sys.warnoptions" title="sys.warnoptions"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.warnoptions</span></code></a> in the reverse

  1423. order: the last <a class="reference internal" href="#c.PyConfig.warnoptions" title="PyConfig.warnoptions"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.warnoptions</span></code></a> item becomes the first

  1424. item of <code class="xref py py-data docutils literal notranslate"><span class="pre">warnings.filters</span></code> which is checked first (highest

  1425. priority).</p>

  1426. <p>The <a class="reference internal" href="../using/cmdline.html#cmdoption-W"><code class="xref std std-option docutils literal notranslate"><span class="pre">-W</span></code></a> command line options adds its value to

  1427. <a class="reference internal" href="#c.PyConfig.warnoptions" title="PyConfig.warnoptions"><code class="xref c c-member docutils literal notranslate"><span class="pre">warnoptions</span></code></a>, it can be used multiple times.</p>

  1428. <p>The <span class="target" id="index-31"></span><a class="reference internal" href="../using/cmdline.html#envvar-PYTHONWARNINGS"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PYTHONWARNINGS</span></code></a> environment variable can also be used to add

  1429. warning options. Multiple options can be specified, separated by commas

  1430. (<code class="docutils literal notranslate"><span class="pre">,</span></code>).</p>

  1431. <p>Default: empty list.</p>

  1432. </dd></dl>

  1433. 

  1434. <dl class="c member">

  1435. <dt class="sig sig-object c" id="c.PyConfig.write_bytecode">

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

  1437. <dd><p>If equal to <code class="docutils literal notranslate"><span class="pre">0</span></code>, Python won’t try to write <code class="docutils literal notranslate"><span class="pre">.pyc</span></code> files on the import of

  1438. source modules.</p>

  1439. <p>Set to <code class="docutils literal notranslate"><span class="pre">0</span></code> by the <a class="reference internal" href="../using/cmdline.html#cmdoption-B"><code class="xref std std-option docutils literal notranslate"><span class="pre">-B</span></code></a> command line option and the

  1440. <span class="target" id="index-32"></span><a class="reference internal" href="../using/cmdline.html#envvar-PYTHONDONTWRITEBYTECODE"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PYTHONDONTWRITEBYTECODE</span></code></a> environment variable.</p>

  1441. <p><a class="reference internal" href="../library/sys.html#sys.dont_write_bytecode" title="sys.dont_write_bytecode"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.dont_write_bytecode</span></code></a> is initialized to the inverted value of

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

  1443. <p>Default: <code class="docutils literal notranslate"><span class="pre">1</span></code>.</p>

  1444. </dd></dl>

  1445. 

  1446. <dl class="c member">

  1447. <dt class="sig sig-object c" id="c.PyConfig.xoptions">

  1448. <a class="reference internal" href="#c.PyWideStringList" title="PyWideStringList"><span class="n"><span class="pre">PyWideStringList</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">xoptions</span></span></span><a class="headerlink" href="#c.PyConfig.xoptions" title="Link to this definition">¶</a><br /></dt>

  1449. <dd><p>Values of the <a class="reference internal" href="../using/cmdline.html#cmdoption-X"><code class="xref std std-option docutils literal notranslate"><span class="pre">-X</span></code></a> command line options: <a class="reference internal" href="../library/sys.html#sys._xoptions" title="sys._xoptions"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys._xoptions</span></code></a>.</p>

  1450. <p>Default: empty list.</p>

  1451. </dd></dl>

  1452. 

  1453. </dd></dl>

  1454. 

  1455. <p>If <a class="reference internal" href="#c.PyConfig.parse_argv" title="PyConfig.parse_argv"><code class="xref c c-member docutils literal notranslate"><span class="pre">parse_argv</span></code></a> is non-zero, <a class="reference internal" href="#c.PyConfig.argv" title="PyConfig.argv"><code class="xref c c-member docutils literal notranslate"><span class="pre">argv</span></code></a>

  1456. arguments are parsed the same way the regular Python parses <a class="reference internal" href="../using/cmdline.html#using-on-cmdline"><span class="std std-ref">command line

  1457. arguments</span></a>, and Python arguments are stripped from

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

  1459. <p>The <a class="reference internal" href="#c.PyConfig.xoptions" title="PyConfig.xoptions"><code class="xref c c-member docutils literal notranslate"><span class="pre">xoptions</span></code></a> options are parsed to set other options: see

  1460. the <a class="reference internal" href="../using/cmdline.html#cmdoption-X"><code class="xref std std-option docutils literal notranslate"><span class="pre">-X</span></code></a> command line option.</p>

  1461. <div class="versionchanged">

  1462. <p><span class="versionmodified changed">Changed in version 3.9: </span>The <code class="docutils literal notranslate"><span class="pre">show_alloc_count</span></code> field has been removed.</p>

  1463. </div>

  1464. </section>

  1465. <section id="initialization-with-pyconfig">

  1466. <h2>Initialization with PyConfig<a class="headerlink" href="#initialization-with-pyconfig" title="Link to this heading">¶</a></h2>

  1467. <p>Function to initialize Python:</p>

  1468. <dl class="c function">

  1469. <dt class="sig sig-object c" id="c.Py_InitializeFromConfig">

  1470. <a class="reference internal" href="#c.PyStatus" title="PyStatus"><span class="n"><span class="pre">PyStatus</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Py_InitializeFromConfig</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#c.PyConfig" title="PyConfig"><span class="n"><span class="pre">PyConfig</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">config</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.Py_InitializeFromConfig" title="Link to this definition">¶</a><br /></dt>

  1471. <dd><p>Initialize Python from <em>config</em> configuration.</p>

  1472. </dd></dl>

  1473. 

  1474. <p>The caller is responsible to handle exceptions (error or exit) using

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

  1476. <p>If <a class="reference internal" href="import.html#c.PyImport_FrozenModules" title="PyImport_FrozenModules"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyImport_FrozenModules()</span></code></a>, <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> or

  1477. <a class="reference internal" href="import.html#c.PyImport_ExtendInittab" title="PyImport_ExtendInittab"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyImport_ExtendInittab()</span></code></a> are used, they must be set or called after

  1478. Python preinitialization and before the Python initialization. If Python is

  1479. initialized multiple times, <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> or

  1480. <a class="reference internal" href="import.html#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

  1481. initialization.</p>

  1482. <p>The current configuration (<code class="docutils literal notranslate"><span class="pre">PyConfig</span></code> type) is stored in

  1483. <code class="docutils literal notranslate"><span class="pre">PyInterpreterState.config</span></code>.</p>

  1484. <p>Example setting the program name:</p>

  1485. <div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="kt">void</span><span class="w"> </span><span class="nf">init_python</span><span class="p">(</span><span class="kt">void</span><span class="p">)</span>

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

  1487. <span class="w">    </span><span class="n">PyStatus</span><span class="w"> </span><span class="n">status</span><span class="p">;</span>

  1488. 

  1489. <span class="w">    </span><span class="n">PyConfig</span><span class="w"> </span><span class="n">config</span><span class="p">;</span>

  1490. <span class="w">    </span><span class="n">PyConfig_InitPythonConfig</span><span class="p">(</span><span class="o">&amp;</span><span class="n">config</span><span class="p">);</span>

  1491. 

  1492. <span class="w">    </span><span class="cm">/* Set the program name. Implicitly preinitialize Python. */</span>

  1493. <span class="w">    </span><span class="n">status</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">PyConfig_SetString</span><span class="p">(</span><span class="o">&amp;</span><span class="n">config</span><span class="p">,</span><span class="w"> </span><span class="o">&amp;</span><span class="n">config</span><span class="p">.</span><span class="n">program_name</span><span class="p">,</span>

  1494. <span class="w">                                </span><span class="sa">L</span><span class="s">&quot;/path/to/my_program&quot;</span><span class="p">);</span>

  1495. <span class="w">    </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">PyStatus_Exception</span><span class="p">(</span><span class="n">status</span><span class="p">))</span><span class="w"> </span><span class="p">{</span>

  1496. <span class="w">        </span><span class="k">goto</span><span class="w"> </span><span class="n">exception</span><span class="p">;</span>

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

  1498. 

  1499. <span class="w">    </span><span class="n">status</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Py_InitializeFromConfig</span><span class="p">(</span><span class="o">&amp;</span><span class="n">config</span><span class="p">);</span>

  1500. <span class="w">    </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">PyStatus_Exception</span><span class="p">(</span><span class="n">status</span><span class="p">))</span><span class="w"> </span><span class="p">{</span>

  1501. <span class="w">        </span><span class="k">goto</span><span class="w"> </span><span class="n">exception</span><span class="p">;</span>

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

  1503. <span class="w">    </span><span class="n">PyConfig_Clear</span><span class="p">(</span><span class="o">&amp;</span><span class="n">config</span><span class="p">);</span>

  1504. <span class="w">    </span><span class="k">return</span><span class="p">;</span>

  1505. 

  1506. <span class="nl">exception</span><span class="p">:</span>

  1507. <span class="w">    </span><span class="n">PyConfig_Clear</span><span class="p">(</span><span class="o">&amp;</span><span class="n">config</span><span class="p">);</span>

  1508. <span class="w">    </span><span class="n">Py_ExitStatusException</span><span class="p">(</span><span class="n">status</span><span class="p">);</span>

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

  1510. </pre></div>

  1511. </div>

  1512. <p>More complete example modifying the default configuration, read the

  1513. configuration, and then override some parameters. Note that since

  1514. 3.11, many parameters are not calculated until initialization, and

  1515. so values cannot be read from the configuration structure. Any values

  1516. set before initialize is called will be left unchanged by

  1517. initialization:</p>

  1518. <div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="n">PyStatus</span><span class="w"> </span><span class="nf">init_python</span><span class="p">(</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">program_name</span><span class="p">)</span>

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

  1520. <span class="w">    </span><span class="n">PyStatus</span><span class="w"> </span><span class="n">status</span><span class="p">;</span>

  1521. 

  1522. <span class="w">    </span><span class="n">PyConfig</span><span class="w"> </span><span class="n">config</span><span class="p">;</span>

  1523. <span class="w">    </span><span class="n">PyConfig_InitPythonConfig</span><span class="p">(</span><span class="o">&amp;</span><span class="n">config</span><span class="p">);</span>

  1524. 

  1525. <span class="w">    </span><span class="cm">/* Set the program name before reading the configuration</span>

  1526. <span class="cm">       (decode byte string from the locale encoding).</span>

  1527. 

  1528. <span class="cm">       Implicitly preinitialize Python. */</span>

  1529. <span class="w">    </span><span class="n">status</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">PyConfig_SetBytesString</span><span class="p">(</span><span class="o">&amp;</span><span class="n">config</span><span class="p">,</span><span class="w"> </span><span class="o">&amp;</span><span class="n">config</span><span class="p">.</span><span class="n">program_name</span><span class="p">,</span>

  1530. <span class="w">                                     </span><span class="n">program_name</span><span class="p">);</span>

  1531. <span class="w">    </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">PyStatus_Exception</span><span class="p">(</span><span class="n">status</span><span class="p">))</span><span class="w"> </span><span class="p">{</span>

  1532. <span class="w">        </span><span class="k">goto</span><span class="w"> </span><span class="n">done</span><span class="p">;</span>

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

  1534. 

  1535. <span class="w">    </span><span class="cm">/* Read all configuration at once */</span>

  1536. <span class="w">    </span><span class="n">status</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">PyConfig_Read</span><span class="p">(</span><span class="o">&amp;</span><span class="n">config</span><span class="p">);</span>

  1537. <span class="w">    </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">PyStatus_Exception</span><span class="p">(</span><span class="n">status</span><span class="p">))</span><span class="w"> </span><span class="p">{</span>

  1538. <span class="w">        </span><span class="k">goto</span><span class="w"> </span><span class="n">done</span><span class="p">;</span>

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

  1540. 

  1541. <span class="w">    </span><span class="cm">/* Specify sys.path explicitly */</span>

  1542. <span class="w">    </span><span class="cm">/* If you want to modify the default set of paths, finish</span>

  1543. <span class="cm">       initialization first and then use PySys_GetObject(&quot;path&quot;) */</span>

  1544. <span class="w">    </span><span class="n">config</span><span class="p">.</span><span class="n">module_search_paths_set</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span>

  1545. <span class="w">    </span><span class="n">status</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">PyWideStringList_Append</span><span class="p">(</span><span class="o">&amp;</span><span class="n">config</span><span class="p">.</span><span class="n">module_search_paths</span><span class="p">,</span>

  1546. <span class="w">                                     </span><span class="sa">L</span><span class="s">&quot;/path/to/stdlib&quot;</span><span class="p">);</span>

  1547. <span class="w">    </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">PyStatus_Exception</span><span class="p">(</span><span class="n">status</span><span class="p">))</span><span class="w"> </span><span class="p">{</span>

  1548. <span class="w">        </span><span class="k">goto</span><span class="w"> </span><span class="n">done</span><span class="p">;</span>

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

  1550. <span class="w">    </span><span class="n">status</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">PyWideStringList_Append</span><span class="p">(</span><span class="o">&amp;</span><span class="n">config</span><span class="p">.</span><span class="n">module_search_paths</span><span class="p">,</span>

  1551. <span class="w">                                     </span><span class="sa">L</span><span class="s">&quot;/path/to/more/modules&quot;</span><span class="p">);</span>

  1552. <span class="w">    </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">PyStatus_Exception</span><span class="p">(</span><span class="n">status</span><span class="p">))</span><span class="w"> </span><span class="p">{</span>

  1553. <span class="w">        </span><span class="k">goto</span><span class="w"> </span><span class="n">done</span><span class="p">;</span>

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

  1555. 

  1556. <span class="w">    </span><span class="cm">/* Override executable computed by PyConfig_Read() */</span>

  1557. <span class="w">    </span><span class="n">status</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">PyConfig_SetString</span><span class="p">(</span><span class="o">&amp;</span><span class="n">config</span><span class="p">,</span><span class="w"> </span><span class="o">&amp;</span><span class="n">config</span><span class="p">.</span><span class="n">executable</span><span class="p">,</span>

  1558. <span class="w">                                </span><span class="sa">L</span><span class="s">&quot;/path/to/my_executable&quot;</span><span class="p">);</span>

  1559. <span class="w">    </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">PyStatus_Exception</span><span class="p">(</span><span class="n">status</span><span class="p">))</span><span class="w"> </span><span class="p">{</span>

  1560. <span class="w">        </span><span class="k">goto</span><span class="w"> </span><span class="n">done</span><span class="p">;</span>

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

  1562. 

  1563. <span class="w">    </span><span class="n">status</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Py_InitializeFromConfig</span><span class="p">(</span><span class="o">&amp;</span><span class="n">config</span><span class="p">);</span>

  1564. 

  1565. <span class="nl">done</span><span class="p">:</span>

  1566. <span class="w">    </span><span class="n">PyConfig_Clear</span><span class="p">(</span><span class="o">&amp;</span><span class="n">config</span><span class="p">);</span>

  1567. <span class="w">    </span><span class="k">return</span><span class="w"> </span><span class="n">status</span><span class="p">;</span>

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

  1569. </pre></div>

  1570. </div>

  1571. </section>

  1572. <section id="isolated-configuration">

  1573. <span id="init-isolated-conf"></span><h2>Isolated Configuration<a class="headerlink" href="#isolated-configuration" title="Link to this heading">¶</a></h2>

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

  1575. <a class="reference internal" href="#c.PyConfig_InitIsolatedConfig" title="PyConfig_InitIsolatedConfig"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyConfig_InitIsolatedConfig()</span></code></a> functions create a configuration to

  1576. isolate Python from the system. For example, to embed Python into an

  1577. application.</p>

  1578. <p>This configuration ignores global configuration variables, environment

  1579. variables, command line arguments (<a class="reference internal" href="#c.PyConfig.argv" title="PyConfig.argv"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.argv</span></code></a> is not parsed)

  1580. and user site directory. The C standard streams (ex: <code class="docutils literal notranslate"><span class="pre">stdout</span></code>) and the

  1581. LC_CTYPE locale are left unchanged. Signal handlers are not installed.</p>

  1582. <p>Configuration files are still used with this configuration to determine

  1583. paths that are unspecified. Ensure <a class="reference internal" href="#c.PyConfig.home" title="PyConfig.home"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.home</span></code></a> is specified

  1584. to avoid computing the default path configuration.</p>

  1585. </section>

  1586. <section id="python-configuration">

  1587. <span id="init-python-config"></span><h2>Python Configuration<a class="headerlink" href="#python-configuration" title="Link to this heading">¶</a></h2>

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

  1589. functions create a configuration to build a customized Python which behaves as

  1590. the regular Python.</p>

  1591. <p>Environments variables and command line arguments are used to configure

  1592. Python, whereas global configuration variables are ignored.</p>

  1593. <p>This function enables C locale coercion (<span class="target" id="index-33"></span><a class="pep reference external" href="https://peps.python.org/pep-0538/"><strong>PEP 538</strong></a>)

  1594. and <a class="reference internal" href="../library/os.html#utf8-mode"><span class="std std-ref">Python UTF-8 Mode</span></a>

  1595. (<span class="target" id="index-34"></span><a class="pep reference external" href="https://peps.python.org/pep-0540/"><strong>PEP 540</strong></a>) depending on the LC_CTYPE locale, <span class="target" id="index-35"></span><a class="reference internal" href="../using/cmdline.html#envvar-PYTHONUTF8"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PYTHONUTF8</span></code></a> and

  1596. <span class="target" id="index-36"></span><a class="reference internal" href="../using/cmdline.html#envvar-PYTHONCOERCECLOCALE"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PYTHONCOERCECLOCALE</span></code></a> environment variables.</p>

  1597. </section>

  1598. <section id="python-path-configuration">

  1599. <span id="init-path-config"></span><h2>Python Path Configuration<a class="headerlink" href="#python-path-configuration" title="Link to this heading">¶</a></h2>

  1600. <p><a class="reference internal" href="#c.PyConfig" title="PyConfig"><code class="xref c c-type docutils literal notranslate"><span class="pre">PyConfig</span></code></a> contains multiple fields for the path configuration:</p>

  1601. <ul class="simple">

  1602. <li><p>Path configuration inputs:</p>

  1603. <ul>

  1604. <li><p><a class="reference internal" href="#c.PyConfig.home" title="PyConfig.home"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.home</span></code></a></p></li>

  1605. <li><p><a class="reference internal" href="#c.PyConfig.platlibdir" title="PyConfig.platlibdir"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.platlibdir</span></code></a></p></li>

  1606. <li><p><a class="reference internal" href="#c.PyConfig.pathconfig_warnings" title="PyConfig.pathconfig_warnings"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.pathconfig_warnings</span></code></a></p></li>

  1607. <li><p><a class="reference internal" href="#c.PyConfig.program_name" title="PyConfig.program_name"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.program_name</span></code></a></p></li>

  1608. <li><p><a class="reference internal" href="#c.PyConfig.pythonpath_env" title="PyConfig.pythonpath_env"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.pythonpath_env</span></code></a></p></li>

  1609. <li><p>current working directory: to get absolute paths</p></li>

  1610. <li><p><code class="docutils literal notranslate"><span class="pre">PATH</span></code> environment variable to get the program full path

  1611. (from <a class="reference internal" href="#c.PyConfig.program_name" title="PyConfig.program_name"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.program_name</span></code></a>)</p></li>

  1612. <li><p><code class="docutils literal notranslate"><span class="pre">__PYVENV_LAUNCHER__</span></code> environment variable</p></li>

  1613. <li><p>(Windows only) Application paths in the registry under

  1614. “SoftwarePythonPythonCoreX.YPythonPath” of HKEY_CURRENT_USER and

  1615. HKEY_LOCAL_MACHINE (where X.Y is the Python version).</p></li>

  1616. </ul>

  1617. </li>

  1618. <li><p>Path configuration output fields:</p>

  1619. <ul>

  1620. <li><p><a class="reference internal" href="#c.PyConfig.base_exec_prefix" title="PyConfig.base_exec_prefix"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.base_exec_prefix</span></code></a></p></li>

  1621. <li><p><a class="reference internal" href="#c.PyConfig.base_executable" title="PyConfig.base_executable"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.base_executable</span></code></a></p></li>

  1622. <li><p><a class="reference internal" href="#c.PyConfig.base_prefix" title="PyConfig.base_prefix"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.base_prefix</span></code></a></p></li>

  1623. <li><p><a class="reference internal" href="#c.PyConfig.exec_prefix" title="PyConfig.exec_prefix"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.exec_prefix</span></code></a></p></li>

  1624. <li><p><a class="reference internal" href="#c.PyConfig.executable" title="PyConfig.executable"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.executable</span></code></a></p></li>

  1625. <li><p><a class="reference internal" href="#c.PyConfig.module_search_paths_set" title="PyConfig.module_search_paths_set"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.module_search_paths_set</span></code></a>,

  1626. <a class="reference internal" href="#c.PyConfig.module_search_paths" title="PyConfig.module_search_paths"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.module_search_paths</span></code></a></p></li>

  1627. <li><p><a class="reference internal" href="#c.PyConfig.prefix" title="PyConfig.prefix"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.prefix</span></code></a></p></li>

  1628. </ul>

  1629. </li>

  1630. </ul>

  1631. <p>If at least one “output field” is not set, Python calculates the path

  1632. configuration to fill unset fields. If

  1633. <a class="reference internal" href="#c.PyConfig.module_search_paths_set" title="PyConfig.module_search_paths_set"><code class="xref c c-member docutils literal notranslate"><span class="pre">module_search_paths_set</span></code></a> is equal to <code class="docutils literal notranslate"><span class="pre">0</span></code>,

  1634. <a class="reference internal" href="#c.PyConfig.module_search_paths" title="PyConfig.module_search_paths"><code class="xref c c-member docutils literal notranslate"><span class="pre">module_search_paths</span></code></a> is overridden and

  1635. <a class="reference internal" href="#c.PyConfig.module_search_paths_set" title="PyConfig.module_search_paths_set"><code class="xref c c-member docutils literal notranslate"><span class="pre">module_search_paths_set</span></code></a> is set to <code class="docutils literal notranslate"><span class="pre">1</span></code>.</p>

  1636. <p>It is possible to completely ignore the function calculating the default

  1637. path configuration by setting explicitly all path configuration output

  1638. fields listed above. A string is considered as set even if it is non-empty.

  1639. <code class="docutils literal notranslate"><span class="pre">module_search_paths</span></code> is considered as set if

  1640. <code class="docutils literal notranslate"><span class="pre">module_search_paths_set</span></code> is set to <code class="docutils literal notranslate"><span class="pre">1</span></code>. In this case,

  1641. <code class="docutils literal notranslate"><span class="pre">module_search_paths</span></code> will be used without modification.</p>

  1642. <p>Set <a class="reference internal" href="#c.PyConfig.pathconfig_warnings" title="PyConfig.pathconfig_warnings"><code class="xref c c-member docutils literal notranslate"><span class="pre">pathconfig_warnings</span></code></a> to <code class="docutils literal notranslate"><span class="pre">0</span></code> to suppress warnings when

  1643. calculating the path configuration (Unix only, Windows does not log any warning).</p>

  1644. <p>If <a class="reference internal" href="#c.PyConfig.base_prefix" title="PyConfig.base_prefix"><code class="xref c c-member docutils literal notranslate"><span class="pre">base_prefix</span></code></a> or <a class="reference internal" href="#c.PyConfig.base_exec_prefix" title="PyConfig.base_exec_prefix"><code class="xref c c-member docutils literal notranslate"><span class="pre">base_exec_prefix</span></code></a>

  1645. fields are not set, they inherit their value from <a class="reference internal" href="#c.PyConfig.prefix" title="PyConfig.prefix"><code class="xref c c-member docutils literal notranslate"><span class="pre">prefix</span></code></a>

  1646. and <a class="reference internal" href="#c.PyConfig.exec_prefix" title="PyConfig.exec_prefix"><code class="xref c c-member docutils literal notranslate"><span class="pre">exec_prefix</span></code></a> respectively.</p>

  1647. <p><a class="reference internal" href="#c.Py_RunMain" title="Py_RunMain"><code class="xref c c-func docutils literal notranslate"><span class="pre">Py_RunMain()</span></code></a> and <a class="reference internal" href="veryhigh.html#c.Py_Main" title="Py_Main"><code class="xref c c-func docutils literal notranslate"><span class="pre">Py_Main()</span></code></a> modify <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>:</p>

  1648. <ul class="simple">

  1649. <li><p>If <a class="reference internal" href="#c.PyConfig.run_filename" title="PyConfig.run_filename"><code class="xref c c-member docutils literal notranslate"><span class="pre">run_filename</span></code></a> is set and is a directory which contains a

  1650. <code class="docutils literal notranslate"><span class="pre">__main__.py</span></code> script, prepend <a class="reference internal" href="#c.PyConfig.run_filename" title="PyConfig.run_filename"><code class="xref c c-member docutils literal notranslate"><span class="pre">run_filename</span></code></a> to

  1651. <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>.</p></li>

  1652. <li><p>If <a class="reference internal" href="#c.PyConfig.isolated" title="PyConfig.isolated"><code class="xref c c-member docutils literal notranslate"><span class="pre">isolated</span></code></a> is zero:</p>

  1653. <ul>

  1654. <li><p>If <a class="reference internal" href="#c.PyConfig.run_module" title="PyConfig.run_module"><code class="xref c c-member docutils literal notranslate"><span class="pre">run_module</span></code></a> is set, prepend the current directory

  1655. to <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>. Do nothing if the current directory cannot be read.</p></li>

  1656. <li><p>If <a class="reference internal" href="#c.PyConfig.run_filename" title="PyConfig.run_filename"><code class="xref c c-member docutils literal notranslate"><span class="pre">run_filename</span></code></a> is set, prepend the directory of the

  1657. filename to <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>.</p></li>

  1658. <li><p>Otherwise, prepend an empty string to <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>.</p></li>

  1659. </ul>

  1660. </li>

  1661. </ul>

  1662. <p>If <a class="reference internal" href="#c.PyConfig.site_import" title="PyConfig.site_import"><code class="xref c c-member docutils literal notranslate"><span class="pre">site_import</span></code></a> is non-zero, <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> can be

  1663. modified by the <a class="reference internal" href="../library/site.html#module-site" title="site: Module responsible for site-specific configuration."><code class="xref py py-mod docutils literal notranslate"><span class="pre">site</span></code></a> module. If

  1664. <a class="reference internal" href="#c.PyConfig.user_site_directory" title="PyConfig.user_site_directory"><code class="xref c c-member docutils literal notranslate"><span class="pre">user_site_directory</span></code></a> is non-zero and the user’s

  1665. site-package directory exists, the <a class="reference internal" href="../library/site.html#module-site" title="site: Module responsible for site-specific configuration."><code class="xref py py-mod docutils literal notranslate"><span class="pre">site</span></code></a> module appends the user’s

  1666. site-package directory to <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>.</p>

  1667. <p>The following configuration files are used by the path configuration:</p>

  1668. <ul class="simple">

  1669. <li><p><code class="docutils literal notranslate"><span class="pre">pyvenv.cfg</span></code></p></li>

  1670. <li><p><code class="docutils literal notranslate"><span class="pre">._pth</span></code> file (ex: <code class="docutils literal notranslate"><span class="pre">python._pth</span></code>)</p></li>

  1671. <li><p><code class="docutils literal notranslate"><span class="pre">pybuilddir.txt</span></code> (Unix only)</p></li>

  1672. </ul>

  1673. <p>If a <code class="docutils literal notranslate"><span class="pre">._pth</span></code> file is present:</p>

  1674. <ul class="simple">

  1675. <li><p>Set <a class="reference internal" href="#c.PyConfig.isolated" title="PyConfig.isolated"><code class="xref c c-member docutils literal notranslate"><span class="pre">isolated</span></code></a> to <code class="docutils literal notranslate"><span class="pre">1</span></code>.</p></li>

  1676. <li><p>Set <a class="reference internal" href="#c.PyConfig.use_environment" title="PyConfig.use_environment"><code class="xref c c-member docutils literal notranslate"><span class="pre">use_environment</span></code></a> to <code class="docutils literal notranslate"><span class="pre">0</span></code>.</p></li>

  1677. <li><p>Set <a class="reference internal" href="#c.PyConfig.site_import" title="PyConfig.site_import"><code class="xref c c-member docutils literal notranslate"><span class="pre">site_import</span></code></a> to <code class="docutils literal notranslate"><span class="pre">0</span></code>.</p></li>

  1678. <li><p>Set <a class="reference internal" href="#c.PyConfig.safe_path" title="PyConfig.safe_path"><code class="xref c c-member docutils literal notranslate"><span class="pre">safe_path</span></code></a> to <code class="docutils literal notranslate"><span class="pre">1</span></code>.</p></li>

  1679. </ul>

  1680. <p>The <code class="docutils literal notranslate"><span class="pre">__PYVENV_LAUNCHER__</span></code> environment variable is used to set

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

  1682. </section>

  1683. <section id="py-runmain">

  1684. <h2>Py_RunMain()<a class="headerlink" href="#py-runmain" title="Link to this heading">¶</a></h2>

  1685. <dl class="c function">

  1686. <dt class="sig sig-object c" id="c.Py_RunMain">

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

  1688. <dd><p>Execute the command (<a class="reference internal" href="#c.PyConfig.run_command" title="PyConfig.run_command"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.run_command</span></code></a>), the script

  1689. (<a class="reference internal" href="#c.PyConfig.run_filename" title="PyConfig.run_filename"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.run_filename</span></code></a>) or the module

  1690. (<a class="reference internal" href="#c.PyConfig.run_module" title="PyConfig.run_module"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.run_module</span></code></a>) specified on the command line or in the

  1691. configuration.</p>

  1692. <p>By default and when if <a class="reference internal" href="../using/cmdline.html#cmdoption-i"><code class="xref std std-option docutils literal notranslate"><span class="pre">-i</span></code></a> option is used, run the REPL.</p>

  1693. <p>Finally, finalizes Python and returns an exit status that can be passed to

  1694. the <code class="docutils literal notranslate"><span class="pre">exit()</span></code> function.</p>

  1695. </dd></dl>

  1696. 

  1697. <p>See <a class="reference internal" href="#init-python-config"><span class="std std-ref">Python Configuration</span></a> for an example of

  1698. customized Python always running in isolated mode using

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

  1700. </section>

  1701. <section id="py-getargcargv">

  1702. <h2>Py_GetArgcArgv()<a class="headerlink" href="#py-getargcargv" title="Link to this heading">¶</a></h2>

  1703. <dl class="c function">

  1704. <dt class="sig sig-object c" id="c.Py_GetArgcArgv">

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

  1706. <dd><p>Get the original command line arguments, before Python modified them.</p>

  1707. <p>See also <a class="reference internal" href="#c.PyConfig.orig_argv" title="PyConfig.orig_argv"><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig.orig_argv</span></code></a> member.</p>

  1708. </dd></dl>

  1709. 

  1710. </section>

  1711. <section id="multi-phase-initialization-private-provisional-api">

  1712. <h2>Multi-Phase Initialization Private Provisional API<a class="headerlink" href="#multi-phase-initialization-private-provisional-api" title="Link to this heading">¶</a></h2>

  1713. <p>This section is a private provisional API introducing multi-phase

  1714. initialization, the core feature of <span class="target" id="index-37"></span><a class="pep reference external" href="https://peps.python.org/pep-0432/"><strong>PEP 432</strong></a>:</p>

  1715. <ul class="simple">

  1716. <li><p>“Core” initialization phase, “bare minimum Python”:</p>

  1717. <ul>

  1718. <li><p>Builtin types;</p></li>

  1719. <li><p>Builtin exceptions;</p></li>

  1720. <li><p>Builtin and frozen modules;</p></li>

  1721. <li><p>The <a class="reference internal" href="../library/sys.html#module-sys" title="sys: Access system-specific parameters and functions."><code class="xref py py-mod docutils literal notranslate"><span class="pre">sys</span></code></a> module is only partially initialized

  1722. (ex: <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> doesn’t exist yet).</p></li>

  1723. </ul>

  1724. </li>

  1725. <li><p>“Main” initialization phase, Python is fully initialized:</p>

  1726. <ul>

  1727. <li><p>Install and configure <a class="reference internal" href="../library/importlib.html#module-importlib" title="importlib: The implementation of the import machinery."><code class="xref py py-mod docutils literal notranslate"><span class="pre">importlib</span></code></a>;</p></li>

  1728. <li><p>Apply the <a class="reference internal" href="#init-path-config"><span class="std std-ref">Path Configuration</span></a>;</p></li>

  1729. <li><p>Install signal handlers;</p></li>

  1730. <li><p>Finish <a class="reference internal" href="../library/sys.html#module-sys" title="sys: Access system-specific parameters and functions."><code class="xref py py-mod docutils literal notranslate"><span class="pre">sys</span></code></a> module initialization (ex: create <a class="reference internal" href="../library/sys.html#sys.stdout" title="sys.stdout"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.stdout</span></code></a>

  1731. and <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>);</p></li>

  1732. <li><p>Enable optional features like <a class="reference internal" href="../library/faulthandler.html#module-faulthandler" title="faulthandler: Dump the Python traceback."><code class="xref py py-mod docutils literal notranslate"><span class="pre">faulthandler</span></code></a> and <a class="reference internal" href="../library/tracemalloc.html#module-tracemalloc" title="tracemalloc: Trace memory allocations."><code class="xref py py-mod docutils literal notranslate"><span class="pre">tracemalloc</span></code></a>;</p></li>

  1733. <li><p>Import the <a class="reference internal" href="../library/site.html#module-site" title="site: Module responsible for site-specific configuration."><code class="xref py py-mod docutils literal notranslate"><span class="pre">site</span></code></a> module;</p></li>

  1734. <li><p>etc.</p></li>

  1735. </ul>

  1736. </li>

  1737. </ul>

  1738. <p>Private provisional API:</p>

  1739. <ul class="simple">

  1740. <li><p><code class="xref c c-member docutils literal notranslate"><span class="pre">PyConfig._init_main</span></code>: if set to <code class="docutils literal notranslate"><span class="pre">0</span></code>,

  1741. <a class="reference internal" href="#c.Py_InitializeFromConfig" title="Py_InitializeFromConfig"><code class="xref c c-func docutils literal notranslate"><span class="pre">Py_InitializeFromConfig()</span></code></a> stops at the “Core” initialization phase.</p></li>

  1742. </ul>

  1743. <dl class="c function">

  1744. <dt class="sig sig-object c" id="c._Py_InitializeMain">

  1745. <a class="reference internal" href="#c.PyStatus" title="PyStatus"><span class="n"><span class="pre">PyStatus</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">_Py_InitializeMain</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">void</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c._Py_InitializeMain" title="Link to this definition">¶</a><br /></dt>

  1746. <dd><p>Move to the “Main” initialization phase, finish the Python initialization.</p>

  1747. </dd></dl>

  1748. 

  1749. <p>No module is imported during the “Core” phase and the <code class="docutils literal notranslate"><span class="pre">importlib</span></code> module is

  1750. not configured: the <a class="reference internal" href="#init-path-config"><span class="std std-ref">Path Configuration</span></a> is only

  1751. applied during the “Main” phase. It may allow to customize Python in Python to

  1752. override or tune the <a class="reference internal" href="#init-path-config"><span class="std std-ref">Path Configuration</span></a>, maybe

  1753. install a custom <a class="reference internal" href="../library/sys.html#sys.meta_path" title="sys.meta_path"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.meta_path</span></code></a> importer or an import hook, etc.</p>

  1754. <p>It may become possible to calculate the <a class="reference internal" href="#init-path-config"><span class="std std-ref">Path Configuration</span></a> in Python, after the Core phase and before the Main phase,

  1755. which is one of the <span class="target" id="index-38"></span><a class="pep reference external" href="https://peps.python.org/pep-0432/"><strong>PEP 432</strong></a> motivation.</p>

  1756. <p>The “Core” phase is not properly defined: what should be and what should

  1757. not be available at this phase is not specified yet. The API is marked

  1758. as private and provisional: the API can be modified or even be removed

  1759. anytime until a proper public API is designed.</p>

  1760. <p>Example running Python code between “Core” and “Main” initialization

  1761. phases:</p>

  1762. <div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="kt">void</span><span class="w"> </span><span class="nf">init_python</span><span class="p">(</span><span class="kt">void</span><span class="p">)</span>

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

  1764. <span class="w">    </span><span class="n">PyStatus</span><span class="w"> </span><span class="n">status</span><span class="p">;</span>

  1765. 

  1766. <span class="w">    </span><span class="n">PyConfig</span><span class="w"> </span><span class="n">config</span><span class="p">;</span>

  1767. <span class="w">    </span><span class="n">PyConfig_InitPythonConfig</span><span class="p">(</span><span class="o">&amp;</span><span class="n">config</span><span class="p">);</span>

  1768. <span class="w">    </span><span class="n">config</span><span class="p">.</span><span class="n">_init_main</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span>

  1769. 

  1770. <span class="w">    </span><span class="cm">/* ... customize &#39;config&#39; configuration ... */</span>

  1771. 

  1772. <span class="w">    </span><span class="n">status</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Py_InitializeFromConfig</span><span class="p">(</span><span class="o">&amp;</span><span class="n">config</span><span class="p">);</span>

  1773. <span class="w">    </span><span class="n">PyConfig_Clear</span><span class="p">(</span><span class="o">&amp;</span><span class="n">config</span><span class="p">);</span>

  1774. <span class="w">    </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">PyStatus_Exception</span><span class="p">(</span><span class="n">status</span><span class="p">))</span><span class="w"> </span><span class="p">{</span>

  1775. <span class="w">        </span><span class="n">Py_ExitStatusException</span><span class="p">(</span><span class="n">status</span><span class="p">);</span>

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

  1777. 

  1778. <span class="w">    </span><span class="cm">/* Use sys.stderr because sys.stdout is only created</span>

  1779. <span class="cm">       by _Py_InitializeMain() */</span>

  1780. <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">PyRun_SimpleString</span><span class="p">(</span>

  1781. <span class="w">        </span><span class="s">&quot;import sys; &quot;</span>

  1782. <span class="w">        </span><span class="s">&quot;print(&#39;Run Python code before _Py_InitializeMain&#39;, &quot;</span>

  1783. <span class="w">               </span><span class="s">&quot;file=sys.stderr)&quot;</span><span class="p">);</span>

  1784. <span class="w">    </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">res</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>

  1785. <span class="w">        </span><span class="n">exit</span><span class="p">(</span><span class="mi">1</span><span class="p">);</span>

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

  1787. 

  1788. <span class="w">    </span><span class="cm">/* ... put more configuration code here ... */</span>

  1789. 

  1790. <span class="w">    </span><span class="n">status</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">_Py_InitializeMain</span><span class="p">();</span>

  1791. <span class="w">    </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">PyStatus_Exception</span><span class="p">(</span><span class="n">status</span><span class="p">))</span><span class="w"> </span><span class="p">{</span>

  1792. <span class="w">        </span><span class="n">Py_ExitStatusException</span><span class="p">(</span><span class="n">status</span><span class="p">);</span>

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

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

  1795. </pre></div>

  1796. </div>

  1797. </section>

  1798. </section>

  1799. 

  1800. 

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

  1802.           </div>

  1803.         </div>

  1804.       </div>

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

  1806.         <div class="sphinxsidebarwrapper">

  1807.   <div>

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

  1809.     <ul>

  1810. <li><a class="reference internal" href="#">Python Initialization Configuration</a><ul>

  1811. <li><a class="reference internal" href="#example">Example</a></li>

  1812. <li><a class="reference internal" href="#pywidestringlist">PyWideStringList</a></li>

  1813. <li><a class="reference internal" href="#pystatus">PyStatus</a></li>

  1814. <li><a class="reference internal" href="#pypreconfig">PyPreConfig</a></li>

  1815. <li><a class="reference internal" href="#preinitialize-python-with-pypreconfig">Preinitialize Python with PyPreConfig</a></li>

  1816. <li><a class="reference internal" href="#pyconfig">PyConfig</a></li>

  1817. <li><a class="reference internal" href="#initialization-with-pyconfig">Initialization with PyConfig</a></li>

  1818. <li><a class="reference internal" href="#isolated-configuration">Isolated Configuration</a></li>

  1819. <li><a class="reference internal" href="#python-configuration">Python Configuration</a></li>

  1820. <li><a class="reference internal" href="#python-path-configuration">Python Path Configuration</a></li>

  1821. <li><a class="reference internal" href="#py-runmain">Py_RunMain()</a></li>

  1822. <li><a class="reference internal" href="#py-getargcargv">Py_GetArgcArgv()</a></li>

  1823. <li><a class="reference internal" href="#multi-phase-initialization-private-provisional-api">Multi-Phase Initialization Private Provisional API</a></li>

  1824. </ul>

  1825. </li>

  1826. </ul>

  1827. 

  1828.   </div>

  1829.   <div>

  1830.     <h4>Previous topic</h4>

  1831.     <p class="topless"><a href="init.html"

  1832.                           title="previous chapter">Initialization, Finalization, and Threads</a></p>

  1833.   </div>

  1834.   <div>

  1835.     <h4>Next topic</h4>

  1836.     <p class="topless"><a href="memory.html"

  1837.                           title="next chapter">Memory Management</a></p>

  1838.   </div>

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

  1840.     <h3>This Page</h3>

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

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

  1843.       <li>

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

  1845.             rel="nofollow">Show Source

  1846.         </a>

  1847.       </li>

  1848.     </ul>

  1849.   </div>

  1850.         </div>

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

  1852. <span>«</span>

  1853. </div>

  1854. 

  1855.       </div>

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

  1857.     </div>  

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

  1859.       <h3>Navigation</h3>

  1860.       <ul>

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

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

  1863.              >index</a></li>

  1864.         <li class="right" >

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

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

  1867.         <li class="right" >

  1868.           <a href="memory.html" title="Memory Management"

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

  1870.         <li class="right" >

  1871.           <a href="init.html" title="Initialization, Finalization, and Threads"

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

  1873. 

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

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

  1876.           <li class="switchers">

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

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

  1879.           </li>

  1880.           <li>

  1881.               

  1882.           </li>

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

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

  1885.     </li>

  1886. 

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

  1888.         <li class="nav-item nav-item-this"><a href="">Python Initialization Configuration</a></li>

  1889.                 <li class="right">

  1890.                     

  1891. 

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

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

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

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

  1896.         </form>

  1897.     </div>

  1898.                      |

  1899.                 </li>

  1900.             <li class="right">

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

  1902.     Theme

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

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

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

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

  1907.     </select>

  1908. </label> |</li>

  1909.             

  1910.       </ul>

  1911.     </div>  

  1912.     <div class="footer">

  1913.     &copy; 

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

  1915.     

  1916.     Copyright

  1917.     

  1918.       </a>

  1919.      2001-2024, Python Software Foundation.

  1920.     <br />

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

  1922.     <br />

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

  1924.     <br />

  1925.     

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

  1927.     

  1928.     

  1929.     <br />

  1930. 

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

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

  1933. <br />

  1934.     <br />

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

  1936.     

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

  1938.     

  1939.     <br />

  1940. 

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

  1942.     </div>

  1943. 

  1944.   </body>

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