Baoding-FenShuaJiang
/
Green_GoodERP18_FSJ_Standard
Watch 1
Star 0
Wiki 捐赠
gooderp18绿色标准版
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Tree: 0f75e31513
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '0f75e31513'
${ noResults }
Green_GoodERP18_FSJ_Standard/python/Doc/html/library/sysconfig.html

902 lines
62KB
Raw Blame History 

  1. <!DOCTYPE html>

  2. 

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

  4.   <head>

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

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

  7. <meta property="og:title" content="sysconfig — Provide access to Python’s configuration information" />

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

  9. <meta property="og:url" content="https://docs.python.org/3/library/sysconfig.html" />

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

  11. <meta property="og:description" content="Source code: Lib/sysconfig.py The sysconfig module provides access to Python’s configuration information like the list of installation paths and the configuration variables relevant for the current..." />

  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="Source code: Lib/sysconfig.py The sysconfig module provides access to Python’s configuration information like the list of installation paths and the configuration variables relevant for the current..." />

  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>sysconfig — Provide access to Python’s configuration information &#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="builtins — Built-in objects" href="builtins.html" />

  39.     <link rel="prev" title="sys.monitoring — Execution event monitoring" href="sys.monitoring.html" />

  40.     <link rel="canonical" href="https://docs.python.org/3/library/sysconfig.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="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">sysconfig</span></code> — Provide access to Python’s configuration information</a><ul>

  99. <li><a class="reference internal" href="#configuration-variables">Configuration variables</a></li>

  100. <li><a class="reference internal" href="#installation-paths">Installation paths</a></li>

  101. <li><a class="reference internal" href="#user-scheme">User scheme</a><ul>

  102. <li><a class="reference internal" href="#posix-user"><code class="docutils literal notranslate"><span class="pre">posix_user</span></code></a></li>

  103. <li><a class="reference internal" href="#nt-user"><code class="docutils literal notranslate"><span class="pre">nt_user</span></code></a></li>

  104. <li><a class="reference internal" href="#osx-framework-user"><code class="docutils literal notranslate"><span class="pre">osx_framework_user</span></code></a></li>

  105. </ul>

  106. </li>

  107. <li><a class="reference internal" href="#home-scheme">Home scheme</a><ul>

  108. <li><a class="reference internal" href="#posix-home"><code class="docutils literal notranslate"><span class="pre">posix_home</span></code></a></li>

  109. </ul>

  110. </li>

  111. <li><a class="reference internal" href="#prefix-scheme">Prefix scheme</a><ul>

  112. <li><a class="reference internal" href="#posix-prefix"><code class="docutils literal notranslate"><span class="pre">posix_prefix</span></code></a></li>

  113. <li><a class="reference internal" href="#nt"><code class="docutils literal notranslate"><span class="pre">nt</span></code></a></li>

  114. </ul>

  115. </li>

  116. <li><a class="reference internal" href="#installation-path-functions">Installation path functions</a></li>

  117. <li><a class="reference internal" href="#other-functions">Other functions</a></li>

  118. <li><a class="reference internal" href="#using-sysconfig-as-a-script">Using <code class="xref py py-mod docutils literal notranslate"><span class="pre">sysconfig</span></code> as a script</a></li>

  119. </ul>

  120. </li>

  121. </ul>

  122. 

  123.   </div>

  124.   <div>

  125.     <h4>Previous topic</h4>

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

  127.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">sys.monitoring</span></code> — Execution event monitoring</a></p>

  128.   </div>

  129.   <div>

  130.     <h4>Next topic</h4>

  131.     <p class="topless"><a href="builtins.html"

  132.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">builtins</span></code> — Built-in objects</a></p>

  133.   </div>

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

  135.     <h3>This Page</h3>

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

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

  138.       <li>

  139.         <a href="https://github.com/python/cpython/blob/main/Doc/library/sysconfig.rst"

  140.             rel="nofollow">Show Source

  141.         </a>

  142.       </li>

  143.     </ul>

  144.   </div>

  145.         </nav>

  146.     </div>

  147. </div>

  148. 

  149.   

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

  151.       <h3>Navigation</h3>

  152.       <ul>

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

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

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

  156.         <li class="right" >

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

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

  159.         <li class="right" >

  160.           <a href="builtins.html" title="builtins — Built-in objects"

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

  162.         <li class="right" >

  163.           <a href="sys.monitoring.html" title="sys.monitoring — Execution event monitoring"

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

  165. 

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

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

  168.           <li class="switchers">

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

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

  171.           </li>

  172.           <li>

  173.               

  174.           </li>

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

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

  177.     </li>

  178. 

  179.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  180.           <li class="nav-item nav-item-2"><a href="python.html" accesskey="U">Python Runtime Services</a> &#187;</li>

  181.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">sysconfig</span></code> — Provide access to Python’s configuration information</a></li>

  182.                 <li class="right">

  183.                     

  184. 

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

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

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

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

  189.         </form>

  190.     </div>

  191.                      |

  192.                 </li>

  193.             <li class="right">

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

  195.     Theme

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

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

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

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

  200.     </select>

  201. </label> |</li>

  202.             

  203.       </ul>

  204.     </div>    

  205. 

  206.     <div class="document">

  207.       <div class="documentwrapper">

  208.         <div class="bodywrapper">

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

  210.             

  211.   <section id="module-sysconfig">

  212. <span id="sysconfig-provide-access-to-python-s-configuration-information"></span><h1><a class="reference internal" href="#module-sysconfig" title="sysconfig: Python's configuration information"><code class="xref py py-mod docutils literal notranslate"><span class="pre">sysconfig</span></code></a> — Provide access to Python’s configuration information<a class="headerlink" href="#module-sysconfig" title="Link to this heading">¶</a></h1>

  213. <div class="versionadded">

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

  215. </div>

  216. <p><strong>Source code:</strong> <a class="reference external" href="https://github.com/python/cpython/tree/3.12/Lib/sysconfig.py">Lib/sysconfig.py</a></p>

  217. <hr class="docutils" id="index-0" />

  218. <p>The <a class="reference internal" href="#module-sysconfig" title="sysconfig: Python's configuration information"><code class="xref py py-mod docutils literal notranslate"><span class="pre">sysconfig</span></code></a> module provides access to Python’s configuration

  219. information like the list of installation paths and the configuration variables

  220. relevant for the current platform.</p>

  221. <section id="configuration-variables">

  222. <h2>Configuration variables<a class="headerlink" href="#configuration-variables" title="Link to this heading">¶</a></h2>

  223. <p>A Python distribution contains a <code class="file docutils literal notranslate"><span class="pre">Makefile</span></code> and a <code class="file docutils literal notranslate"><span class="pre">pyconfig.h</span></code>

  224. header file that are necessary to build both the Python binary itself and

  225. third-party C extensions compiled using <code class="docutils literal notranslate"><span class="pre">setuptools</span></code>.</p>

  226. <p><a class="reference internal" href="#module-sysconfig" title="sysconfig: Python's configuration information"><code class="xref py py-mod docutils literal notranslate"><span class="pre">sysconfig</span></code></a> puts all variables found in these files in a dictionary that

  227. can be accessed using <a class="reference internal" href="#sysconfig.get_config_vars" title="sysconfig.get_config_vars"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_config_vars()</span></code></a> or <a class="reference internal" href="#sysconfig.get_config_var" title="sysconfig.get_config_var"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_config_var()</span></code></a>.</p>

  228. <p>Notice that on Windows, it’s a much smaller set.</p>

  229. <dl class="py function">

  230. <dt class="sig sig-object py" id="sysconfig.get_config_vars">

  231. <span class="sig-prename descclassname"><span class="pre">sysconfig.</span></span><span class="sig-name descname"><span class="pre">get_config_vars</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sysconfig.get_config_vars" title="Link to this definition">¶</a></dt>

  232. <dd><p>With no arguments, return a dictionary of all configuration variables

  233. relevant for the current platform.</p>

  234. <p>With arguments, return a list of values that result from looking up each

  235. argument in the configuration variable dictionary.</p>

  236. <p>For each argument, if the value is not found, return <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>

  237. </dd></dl>

  238. 

  239. <dl class="py function">

  240. <dt class="sig sig-object py" id="sysconfig.get_config_var">

  241. <span class="sig-prename descclassname"><span class="pre">sysconfig.</span></span><span class="sig-name descname"><span class="pre">get_config_var</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sysconfig.get_config_var" title="Link to this definition">¶</a></dt>

  242. <dd><p>Return the value of a single variable <em>name</em>. Equivalent to

  243. <code class="docutils literal notranslate"><span class="pre">get_config_vars().get(name)</span></code>.</p>

  244. <p>If <em>name</em> is not found, return <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>

  245. </dd></dl>

  246. 

  247. <p>Example of usage:</p>

  248. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">sysconfig</span>

  249. <span class="gp">&gt;&gt;&gt; </span><span class="n">sysconfig</span><span class="o">.</span><span class="n">get_config_var</span><span class="p">(</span><span class="s1">&#39;Py_ENABLE_SHARED&#39;</span><span class="p">)</span>

  250. <span class="go">0</span>

  251. <span class="gp">&gt;&gt;&gt; </span><span class="n">sysconfig</span><span class="o">.</span><span class="n">get_config_var</span><span class="p">(</span><span class="s1">&#39;LIBDIR&#39;</span><span class="p">)</span>

  252. <span class="go">&#39;/usr/local/lib&#39;</span>

  253. <span class="gp">&gt;&gt;&gt; </span><span class="n">sysconfig</span><span class="o">.</span><span class="n">get_config_vars</span><span class="p">(</span><span class="s1">&#39;AR&#39;</span><span class="p">,</span> <span class="s1">&#39;CXX&#39;</span><span class="p">)</span>

  254. <span class="go">[&#39;ar&#39;, &#39;g++&#39;]</span>

  255. </pre></div>

  256. </div>

  257. </section>

  258. <section id="installation-paths">

  259. <span id="id1"></span><h2>Installation paths<a class="headerlink" href="#installation-paths" title="Link to this heading">¶</a></h2>

  260. <p>Python uses an installation scheme that differs depending on the platform and on

  261. the installation options.  These schemes are stored in <a class="reference internal" href="#module-sysconfig" title="sysconfig: Python's configuration information"><code class="xref py py-mod docutils literal notranslate"><span class="pre">sysconfig</span></code></a> under

  262. unique identifiers based on the value returned by <a class="reference internal" href="os.html#os.name" title="os.name"><code class="xref py py-const docutils literal notranslate"><span class="pre">os.name</span></code></a>.

  263. The schemes are used by package installers to determine where to copy files to.</p>

  264. <p>Python currently supports nine schemes:</p>

  265. <ul class="simple">

  266. <li><p><em>posix_prefix</em>: scheme for POSIX platforms like Linux or macOS.  This is

  267. the default scheme used when Python or a component is installed.</p></li>

  268. <li><p><em>posix_home</em>: scheme for POSIX platforms, when the <em>home</em> option is used.

  269. This scheme defines paths located under a specific home prefix.</p></li>

  270. <li><p><em>posix_user</em>: scheme for POSIX platforms, when the <em>user</em> option is used.

  271. This scheme defines paths located under the user’s home directory

  272. (<a class="reference internal" href="site.html#site.USER_BASE" title="site.USER_BASE"><code class="xref py py-const docutils literal notranslate"><span class="pre">site.USER_BASE</span></code></a>).</p></li>

  273. <li><p><em>posix_venv</em>: scheme for <a class="reference internal" href="venv.html#module-venv" title="venv: Creation of virtual environments."><code class="xref py py-mod docutils literal notranslate"><span class="pre">Python</span> <span class="pre">virtual</span> <span class="pre">environments</span></code></a> on POSIX

  274. platforms; by default it is the same as <em>posix_prefix</em>.</p></li>

  275. <li><p><em>nt</em>: scheme for Windows.

  276. This is the default scheme used when Python or a component is installed.</p></li>

  277. <li><p><em>nt_user</em>: scheme for Windows, when the <em>user</em> option is used.</p></li>

  278. <li><p><em>nt_venv</em>: scheme for <a class="reference internal" href="venv.html#module-venv" title="venv: Creation of virtual environments."><code class="xref py py-mod docutils literal notranslate"><span class="pre">Python</span> <span class="pre">virtual</span> <span class="pre">environments</span></code></a> on Windows;

  279. by default it is the same as <em>nt</em>.</p></li>

  280. <li><p><em>venv</em>: a scheme with values from either <em>posix_venv</em> or <em>nt_venv</em> depending

  281. on the platform Python runs on.</p></li>

  282. <li><p><em>osx_framework_user</em>: scheme for macOS, when the <em>user</em> option is used.</p></li>

  283. </ul>

  284. <p>Each scheme is itself composed of a series of paths and each path has a unique

  285. identifier.  Python currently uses eight paths:</p>

  286. <ul class="simple">

  287. <li><p><em>stdlib</em>: directory containing the standard Python library files that are not

  288. platform-specific.</p></li>

  289. <li><p><em>platstdlib</em>: directory containing the standard Python library files that are

  290. platform-specific.</p></li>

  291. <li><p><em>platlib</em>: directory for site-specific, platform-specific files.</p></li>

  292. <li><p><em>purelib</em>: directory for site-specific, non-platform-specific files (‘pure’ Python).</p></li>

  293. <li><p><em>include</em>: directory for non-platform-specific header files for

  294. the Python C-API.</p></li>

  295. <li><p><em>platinclude</em>: directory for platform-specific header files for

  296. the Python C-API.</p></li>

  297. <li><p><em>scripts</em>: directory for script files.</p></li>

  298. <li><p><em>data</em>: directory for data files.</p></li>

  299. </ul>

  300. </section>

  301. <section id="user-scheme">

  302. <span id="sysconfig-user-scheme"></span><h2>User scheme<a class="headerlink" href="#user-scheme" title="Link to this heading">¶</a></h2>

  303. <p>This scheme is designed to be the most convenient solution for users that don’t

  304. have write permission to the global site-packages directory or don’t want to

  305. install into it.</p>

  306. <p>Files will be installed into subdirectories of <a class="reference internal" href="site.html#site.USER_BASE" title="site.USER_BASE"><code class="xref py py-const docutils literal notranslate"><span class="pre">site.USER_BASE</span></code></a> (written

  307. as <code class="file docutils literal notranslate"><em><span class="pre">userbase</span></em></code> hereafter).  This scheme installs pure Python modules and

  308. extension modules in the same location (also known as <a class="reference internal" href="site.html#site.USER_SITE" title="site.USER_SITE"><code class="xref py py-const docutils literal notranslate"><span class="pre">site.USER_SITE</span></code></a>).</p>

  309. <section id="posix-user">

  310. <h3><code class="docutils literal notranslate"><span class="pre">posix_user</span></code><a class="headerlink" href="#posix-user" title="Link to this heading">¶</a></h3>

  311. <table class="docutils align-default">

  312. <thead>

  313. <tr class="row-odd"><th class="head"><p>Path</p></th>

  314. <th class="head"><p>Installation directory</p></th>

  315. </tr>

  316. </thead>

  317. <tbody>

  318. <tr class="row-even"><td><p><em>stdlib</em></p></td>

  319. <td><p><code class="file docutils literal notranslate"><em><span class="pre">userbase</span></em><span class="pre">/lib/python</span><em><span class="pre">X.Y</span></em></code></p></td>

  320. </tr>

  321. <tr class="row-odd"><td><p><em>platstdlib</em></p></td>

  322. <td><p><code class="file docutils literal notranslate"><em><span class="pre">userbase</span></em><span class="pre">/lib/python</span><em><span class="pre">X.Y</span></em></code></p></td>

  323. </tr>

  324. <tr class="row-even"><td><p><em>platlib</em></p></td>

  325. <td><p><code class="file docutils literal notranslate"><em><span class="pre">userbase</span></em><span class="pre">/lib/python</span><em><span class="pre">X.Y</span></em><span class="pre">/site-packages</span></code></p></td>

  326. </tr>

  327. <tr class="row-odd"><td><p><em>purelib</em></p></td>

  328. <td><p><code class="file docutils literal notranslate"><em><span class="pre">userbase</span></em><span class="pre">/lib/python</span><em><span class="pre">X.Y</span></em><span class="pre">/site-packages</span></code></p></td>

  329. </tr>

  330. <tr class="row-even"><td><p><em>include</em></p></td>

  331. <td><p><code class="file docutils literal notranslate"><em><span class="pre">userbase</span></em><span class="pre">/include/python</span><em><span class="pre">X.Y</span></em></code></p></td>

  332. </tr>

  333. <tr class="row-odd"><td><p><em>scripts</em></p></td>

  334. <td><p><code class="file docutils literal notranslate"><em><span class="pre">userbase</span></em><span class="pre">/bin</span></code></p></td>

  335. </tr>

  336. <tr class="row-even"><td><p><em>data</em></p></td>

  337. <td><p><code class="file docutils literal notranslate"><em><span class="pre">userbase</span></em></code></p></td>

  338. </tr>

  339. </tbody>

  340. </table>

  341. </section>

  342. <section id="nt-user">

  343. <h3><code class="docutils literal notranslate"><span class="pre">nt_user</span></code><a class="headerlink" href="#nt-user" title="Link to this heading">¶</a></h3>

  344. <table class="docutils align-default">

  345. <thead>

  346. <tr class="row-odd"><th class="head"><p>Path</p></th>

  347. <th class="head"><p>Installation directory</p></th>

  348. </tr>

  349. </thead>

  350. <tbody>

  351. <tr class="row-even"><td><p><em>stdlib</em></p></td>

  352. <td><p><code class="file docutils literal notranslate"><em><span class="pre">userbase</span></em><span class="pre">\Python</span><em><span class="pre">XY</span></em></code></p></td>

  353. </tr>

  354. <tr class="row-odd"><td><p><em>platstdlib</em></p></td>

  355. <td><p><code class="file docutils literal notranslate"><em><span class="pre">userbase</span></em><span class="pre">\Python</span><em><span class="pre">XY</span></em></code></p></td>

  356. </tr>

  357. <tr class="row-even"><td><p><em>platlib</em></p></td>

  358. <td><p><code class="file docutils literal notranslate"><em><span class="pre">userbase</span></em><span class="pre">\Python</span><em><span class="pre">XY</span></em><span class="pre">\site-packages</span></code></p></td>

  359. </tr>

  360. <tr class="row-odd"><td><p><em>purelib</em></p></td>

  361. <td><p><code class="file docutils literal notranslate"><em><span class="pre">userbase</span></em><span class="pre">\Python</span><em><span class="pre">XY</span></em><span class="pre">\site-packages</span></code></p></td>

  362. </tr>

  363. <tr class="row-even"><td><p><em>include</em></p></td>

  364. <td><p><code class="file docutils literal notranslate"><em><span class="pre">userbase</span></em><span class="pre">\Python</span><em><span class="pre">XY</span></em><span class="pre">\Include</span></code></p></td>

  365. </tr>

  366. <tr class="row-odd"><td><p><em>scripts</em></p></td>

  367. <td><p><code class="file docutils literal notranslate"><em><span class="pre">userbase</span></em><span class="pre">\Python</span><em><span class="pre">XY</span></em><span class="pre">\Scripts</span></code></p></td>

  368. </tr>

  369. <tr class="row-even"><td><p><em>data</em></p></td>

  370. <td><p><code class="file docutils literal notranslate"><em><span class="pre">userbase</span></em></code></p></td>

  371. </tr>

  372. </tbody>

  373. </table>

  374. </section>

  375. <section id="osx-framework-user">

  376. <h3><code class="docutils literal notranslate"><span class="pre">osx_framework_user</span></code><a class="headerlink" href="#osx-framework-user" title="Link to this heading">¶</a></h3>

  377. <table class="docutils align-default">

  378. <thead>

  379. <tr class="row-odd"><th class="head"><p>Path</p></th>

  380. <th class="head"><p>Installation directory</p></th>

  381. </tr>

  382. </thead>

  383. <tbody>

  384. <tr class="row-even"><td><p><em>stdlib</em></p></td>

  385. <td><p><code class="file docutils literal notranslate"><em><span class="pre">userbase</span></em><span class="pre">/lib/python</span></code></p></td>

  386. </tr>

  387. <tr class="row-odd"><td><p><em>platstdlib</em></p></td>

  388. <td><p><code class="file docutils literal notranslate"><em><span class="pre">userbase</span></em><span class="pre">/lib/python</span></code></p></td>

  389. </tr>

  390. <tr class="row-even"><td><p><em>platlib</em></p></td>

  391. <td><p><code class="file docutils literal notranslate"><em><span class="pre">userbase</span></em><span class="pre">/lib/python/site-packages</span></code></p></td>

  392. </tr>

  393. <tr class="row-odd"><td><p><em>purelib</em></p></td>

  394. <td><p><code class="file docutils literal notranslate"><em><span class="pre">userbase</span></em><span class="pre">/lib/python/site-packages</span></code></p></td>

  395. </tr>

  396. <tr class="row-even"><td><p><em>include</em></p></td>

  397. <td><p><code class="file docutils literal notranslate"><em><span class="pre">userbase</span></em><span class="pre">/include/python</span><em><span class="pre">X.Y</span></em></code></p></td>

  398. </tr>

  399. <tr class="row-odd"><td><p><em>scripts</em></p></td>

  400. <td><p><code class="file docutils literal notranslate"><em><span class="pre">userbase</span></em><span class="pre">/bin</span></code></p></td>

  401. </tr>

  402. <tr class="row-even"><td><p><em>data</em></p></td>

  403. <td><p><code class="file docutils literal notranslate"><em><span class="pre">userbase</span></em></code></p></td>

  404. </tr>

  405. </tbody>

  406. </table>

  407. </section>

  408. </section>

  409. <section id="home-scheme">

  410. <span id="sysconfig-home-scheme"></span><h2>Home scheme<a class="headerlink" href="#home-scheme" title="Link to this heading">¶</a></h2>

  411. <p>The idea behind the “home scheme” is that you build and maintain a personal

  412. stash of Python modules.  This scheme’s name is derived from the idea of a

  413. “home” directory on Unix, since it’s not unusual for a Unix user to make their

  414. home directory have a layout similar to <code class="file docutils literal notranslate"><span class="pre">/usr/</span></code> or <code class="file docutils literal notranslate"><span class="pre">/usr/local/</span></code>.

  415. This scheme can be used by anyone, regardless of the operating system they

  416. are installing for.</p>

  417. <section id="posix-home">

  418. <h3><code class="docutils literal notranslate"><span class="pre">posix_home</span></code><a class="headerlink" href="#posix-home" title="Link to this heading">¶</a></h3>

  419. <table class="docutils align-default">

  420. <thead>

  421. <tr class="row-odd"><th class="head"><p>Path</p></th>

  422. <th class="head"><p>Installation directory</p></th>

  423. </tr>

  424. </thead>

  425. <tbody>

  426. <tr class="row-even"><td><p><em>stdlib</em></p></td>

  427. <td><p><code class="file docutils literal notranslate"><em><span class="pre">home</span></em><span class="pre">/lib/python</span></code></p></td>

  428. </tr>

  429. <tr class="row-odd"><td><p><em>platstdlib</em></p></td>

  430. <td><p><code class="file docutils literal notranslate"><em><span class="pre">home</span></em><span class="pre">/lib/python</span></code></p></td>

  431. </tr>

  432. <tr class="row-even"><td><p><em>platlib</em></p></td>

  433. <td><p><code class="file docutils literal notranslate"><em><span class="pre">home</span></em><span class="pre">/lib/python</span></code></p></td>

  434. </tr>

  435. <tr class="row-odd"><td><p><em>purelib</em></p></td>

  436. <td><p><code class="file docutils literal notranslate"><em><span class="pre">home</span></em><span class="pre">/lib/python</span></code></p></td>

  437. </tr>

  438. <tr class="row-even"><td><p><em>include</em></p></td>

  439. <td><p><code class="file docutils literal notranslate"><em><span class="pre">home</span></em><span class="pre">/include/python</span></code></p></td>

  440. </tr>

  441. <tr class="row-odd"><td><p><em>platinclude</em></p></td>

  442. <td><p><code class="file docutils literal notranslate"><em><span class="pre">home</span></em><span class="pre">/include/python</span></code></p></td>

  443. </tr>

  444. <tr class="row-even"><td><p><em>scripts</em></p></td>

  445. <td><p><code class="file docutils literal notranslate"><em><span class="pre">home</span></em><span class="pre">/bin</span></code></p></td>

  446. </tr>

  447. <tr class="row-odd"><td><p><em>data</em></p></td>

  448. <td><p><code class="file docutils literal notranslate"><em><span class="pre">home</span></em></code></p></td>

  449. </tr>

  450. </tbody>

  451. </table>

  452. </section>

  453. </section>

  454. <section id="prefix-scheme">

  455. <span id="sysconfig-prefix-scheme"></span><h2>Prefix scheme<a class="headerlink" href="#prefix-scheme" title="Link to this heading">¶</a></h2>

  456. <p>The “prefix scheme” is useful when you wish to use one Python installation to

  457. perform the build/install (i.e., to run the setup script), but install modules

  458. into the third-party module directory of a different Python installation (or

  459. something that looks like a different Python installation).  If this sounds a

  460. trifle unusual, it is—that’s why the user and home schemes come before.  However,

  461. there are at least two known cases where the prefix scheme will be useful.</p>

  462. <p>First, consider that many Linux distributions put Python in <code class="file docutils literal notranslate"><span class="pre">/usr</span></code>, rather

  463. than the more traditional <code class="file docutils literal notranslate"><span class="pre">/usr/local</span></code>.  This is entirely appropriate,

  464. since in those cases Python is part of “the system” rather than a local add-on.

  465. However, if you are installing Python modules from source, you probably want

  466. them to go in <code class="file docutils literal notranslate"><span class="pre">/usr/local/lib/python2.</span><em><span class="pre">X</span></em></code> rather than

  467. <code class="file docutils literal notranslate"><span class="pre">/usr/lib/python2.</span><em><span class="pre">X</span></em></code>.</p>

  468. <p>Another possibility is a network filesystem where the name used to write to a

  469. remote directory is different from the name used to read it: for example, the

  470. Python interpreter accessed as <code class="file docutils literal notranslate"><span class="pre">/usr/local/bin/python</span></code> might search for

  471. modules in <code class="file docutils literal notranslate"><span class="pre">/usr/local/lib/python2.</span><em><span class="pre">X</span></em></code>, but those modules would have to

  472. be installed to, say, <code class="file docutils literal notranslate"><span class="pre">/mnt/</span><em><span class="pre">&#64;server</span></em><span class="pre">/export/lib/python2.</span><em><span class="pre">X</span></em></code>.</p>

  473. <section id="posix-prefix">

  474. <h3><code class="docutils literal notranslate"><span class="pre">posix_prefix</span></code><a class="headerlink" href="#posix-prefix" title="Link to this heading">¶</a></h3>

  475. <table class="docutils align-default">

  476. <thead>

  477. <tr class="row-odd"><th class="head"><p>Path</p></th>

  478. <th class="head"><p>Installation directory</p></th>

  479. </tr>

  480. </thead>

  481. <tbody>

  482. <tr class="row-even"><td><p><em>stdlib</em></p></td>

  483. <td><p><code class="file docutils literal notranslate"><em><span class="pre">prefix</span></em><span class="pre">/lib/python</span><em><span class="pre">X.Y</span></em></code></p></td>

  484. </tr>

  485. <tr class="row-odd"><td><p><em>platstdlib</em></p></td>

  486. <td><p><code class="file docutils literal notranslate"><em><span class="pre">prefix</span></em><span class="pre">/lib/python</span><em><span class="pre">X.Y</span></em></code></p></td>

  487. </tr>

  488. <tr class="row-even"><td><p><em>platlib</em></p></td>

  489. <td><p><code class="file docutils literal notranslate"><em><span class="pre">prefix</span></em><span class="pre">/lib/python</span><em><span class="pre">X.Y</span></em><span class="pre">/site-packages</span></code></p></td>

  490. </tr>

  491. <tr class="row-odd"><td><p><em>purelib</em></p></td>

  492. <td><p><code class="file docutils literal notranslate"><em><span class="pre">prefix</span></em><span class="pre">/lib/python</span><em><span class="pre">X.Y</span></em><span class="pre">/site-packages</span></code></p></td>

  493. </tr>

  494. <tr class="row-even"><td><p><em>include</em></p></td>

  495. <td><p><code class="file docutils literal notranslate"><em><span class="pre">prefix</span></em><span class="pre">/include/python</span><em><span class="pre">X.Y</span></em></code></p></td>

  496. </tr>

  497. <tr class="row-odd"><td><p><em>platinclude</em></p></td>

  498. <td><p><code class="file docutils literal notranslate"><em><span class="pre">prefix</span></em><span class="pre">/include/python</span><em><span class="pre">X.Y</span></em></code></p></td>

  499. </tr>

  500. <tr class="row-even"><td><p><em>scripts</em></p></td>

  501. <td><p><code class="file docutils literal notranslate"><em><span class="pre">prefix</span></em><span class="pre">/bin</span></code></p></td>

  502. </tr>

  503. <tr class="row-odd"><td><p><em>data</em></p></td>

  504. <td><p><code class="file docutils literal notranslate"><em><span class="pre">prefix</span></em></code></p></td>

  505. </tr>

  506. </tbody>

  507. </table>

  508. </section>

  509. <section id="nt">

  510. <h3><code class="docutils literal notranslate"><span class="pre">nt</span></code><a class="headerlink" href="#nt" title="Link to this heading">¶</a></h3>

  511. <table class="docutils align-default">

  512. <thead>

  513. <tr class="row-odd"><th class="head"><p>Path</p></th>

  514. <th class="head"><p>Installation directory</p></th>

  515. </tr>

  516. </thead>

  517. <tbody>

  518. <tr class="row-even"><td><p><em>stdlib</em></p></td>

  519. <td><p><code class="file docutils literal notranslate"><em><span class="pre">prefix</span></em><span class="pre">\Lib</span></code></p></td>

  520. </tr>

  521. <tr class="row-odd"><td><p><em>platstdlib</em></p></td>

  522. <td><p><code class="file docutils literal notranslate"><em><span class="pre">prefix</span></em><span class="pre">\Lib</span></code></p></td>

  523. </tr>

  524. <tr class="row-even"><td><p><em>platlib</em></p></td>

  525. <td><p><code class="file docutils literal notranslate"><em><span class="pre">prefix</span></em><span class="pre">\Lib\site-packages</span></code></p></td>

  526. </tr>

  527. <tr class="row-odd"><td><p><em>purelib</em></p></td>

  528. <td><p><code class="file docutils literal notranslate"><em><span class="pre">prefix</span></em><span class="pre">\Lib\site-packages</span></code></p></td>

  529. </tr>

  530. <tr class="row-even"><td><p><em>include</em></p></td>

  531. <td><p><code class="file docutils literal notranslate"><em><span class="pre">prefix</span></em><span class="pre">\Include</span></code></p></td>

  532. </tr>

  533. <tr class="row-odd"><td><p><em>platinclude</em></p></td>

  534. <td><p><code class="file docutils literal notranslate"><em><span class="pre">prefix</span></em><span class="pre">\Include</span></code></p></td>

  535. </tr>

  536. <tr class="row-even"><td><p><em>scripts</em></p></td>

  537. <td><p><code class="file docutils literal notranslate"><em><span class="pre">prefix</span></em><span class="pre">\Scripts</span></code></p></td>

  538. </tr>

  539. <tr class="row-odd"><td><p><em>data</em></p></td>

  540. <td><p><code class="file docutils literal notranslate"><em><span class="pre">prefix</span></em></code></p></td>

  541. </tr>

  542. </tbody>

  543. </table>

  544. </section>

  545. </section>

  546. <section id="installation-path-functions">

  547. <h2>Installation path functions<a class="headerlink" href="#installation-path-functions" title="Link to this heading">¶</a></h2>

  548. <p><a class="reference internal" href="#module-sysconfig" title="sysconfig: Python's configuration information"><code class="xref py py-mod docutils literal notranslate"><span class="pre">sysconfig</span></code></a> provides some functions to determine these installation paths.</p>

  549. <dl class="py function">

  550. <dt class="sig sig-object py" id="sysconfig.get_scheme_names">

  551. <span class="sig-prename descclassname"><span class="pre">sysconfig.</span></span><span class="sig-name descname"><span class="pre">get_scheme_names</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#sysconfig.get_scheme_names" title="Link to this definition">¶</a></dt>

  552. <dd><p>Return a tuple containing all schemes currently supported in

  553. <a class="reference internal" href="#module-sysconfig" title="sysconfig: Python's configuration information"><code class="xref py py-mod docutils literal notranslate"><span class="pre">sysconfig</span></code></a>.</p>

  554. </dd></dl>

  555. 

  556. <dl class="py function">

  557. <dt class="sig sig-object py" id="sysconfig.get_default_scheme">

  558. <span class="sig-prename descclassname"><span class="pre">sysconfig.</span></span><span class="sig-name descname"><span class="pre">get_default_scheme</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#sysconfig.get_default_scheme" title="Link to this definition">¶</a></dt>

  559. <dd><p>Return the default scheme name for the current platform.</p>

  560. <div class="versionadded">

  561. <p><span class="versionmodified added">New in version 3.10: </span>This function was previously named <code class="docutils literal notranslate"><span class="pre">_get_default_scheme()</span></code> and

  562. considered an implementation detail.</p>

  563. </div>

  564. <div class="versionchanged">

  565. <p><span class="versionmodified changed">Changed in version 3.11: </span>When Python runs from a virtual environment,

  566. the <em>venv</em> scheme is returned.</p>

  567. </div>

  568. </dd></dl>

  569. 

  570. <dl class="py function">

  571. <dt class="sig sig-object py" id="sysconfig.get_preferred_scheme">

  572. <span class="sig-prename descclassname"><span class="pre">sysconfig.</span></span><span class="sig-name descname"><span class="pre">get_preferred_scheme</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sysconfig.get_preferred_scheme" title="Link to this definition">¶</a></dt>

  573. <dd><p>Return a preferred scheme name for an installation layout specified by <em>key</em>.</p>

  574. <p><em>key</em> must be either <code class="docutils literal notranslate"><span class="pre">&quot;prefix&quot;</span></code>, <code class="docutils literal notranslate"><span class="pre">&quot;home&quot;</span></code>, or <code class="docutils literal notranslate"><span class="pre">&quot;user&quot;</span></code>.</p>

  575. <p>The return value is a scheme name listed in <a class="reference internal" href="#sysconfig.get_scheme_names" title="sysconfig.get_scheme_names"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_scheme_names()</span></code></a>. It

  576. can be passed to <a class="reference internal" href="#module-sysconfig" title="sysconfig: Python's configuration information"><code class="xref py py-mod docutils literal notranslate"><span class="pre">sysconfig</span></code></a> functions that take a <em>scheme</em> argument,

  577. such as <a class="reference internal" href="#sysconfig.get_paths" title="sysconfig.get_paths"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_paths()</span></code></a>.</p>

  578. <div class="versionadded">

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

  580. </div>

  581. <div class="versionchanged">

  582. <p><span class="versionmodified changed">Changed in version 3.11: </span>When Python runs from a virtual environment and <code class="docutils literal notranslate"><span class="pre">key=&quot;prefix&quot;</span></code>,

  583. the <em>venv</em> scheme is returned.</p>

  584. </div>

  585. </dd></dl>

  586. 

  587. <dl class="py function">

  588. <dt class="sig sig-object py" id="sysconfig._get_preferred_schemes">

  589. <span class="sig-prename descclassname"><span class="pre">sysconfig.</span></span><span class="sig-name descname"><span class="pre">_get_preferred_schemes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#sysconfig._get_preferred_schemes" title="Link to this definition">¶</a></dt>

  590. <dd><p>Return a dict containing preferred scheme names on the current platform.

  591. Python implementers and redistributors may add their preferred schemes to

  592. the <code class="docutils literal notranslate"><span class="pre">_INSTALL_SCHEMES</span></code> module-level global value, and modify this function

  593. to return those scheme names, to e.g. provide different schemes for system

  594. and language package managers to use, so packages installed by either do not

  595. mix with those by the other.</p>

  596. <p>End users should not use this function, but <a class="reference internal" href="#sysconfig.get_default_scheme" title="sysconfig.get_default_scheme"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_default_scheme()</span></code></a> and

  597. <a class="reference internal" href="#sysconfig.get_preferred_scheme" title="sysconfig.get_preferred_scheme"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_preferred_scheme()</span></code></a> instead.</p>

  598. <div class="versionadded">

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

  600. </div>

  601. </dd></dl>

  602. 

  603. <dl class="py function">

  604. <dt class="sig sig-object py" id="sysconfig.get_path_names">

  605. <span class="sig-prename descclassname"><span class="pre">sysconfig.</span></span><span class="sig-name descname"><span class="pre">get_path_names</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#sysconfig.get_path_names" title="Link to this definition">¶</a></dt>

  606. <dd><p>Return a tuple containing all path names currently supported in

  607. <a class="reference internal" href="#module-sysconfig" title="sysconfig: Python's configuration information"><code class="xref py py-mod docutils literal notranslate"><span class="pre">sysconfig</span></code></a>.</p>

  608. </dd></dl>

  609. 

  610. <dl class="py function">

  611. <dt class="sig sig-object py" id="sysconfig.get_path">

  612. <span class="sig-prename descclassname"><span class="pre">sysconfig.</span></span><span class="sig-name descname"><span class="pre">get_path</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">scheme</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">vars</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">expand</span></span></em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#sysconfig.get_path" title="Link to this definition">¶</a></dt>

  613. <dd><p>Return an installation path corresponding to the path <em>name</em>, from the

  614. install scheme named <em>scheme</em>.</p>

  615. <p><em>name</em> has to be a value from the list returned by <a class="reference internal" href="#sysconfig.get_path_names" title="sysconfig.get_path_names"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_path_names()</span></code></a>.</p>

  616. <p><a class="reference internal" href="#module-sysconfig" title="sysconfig: Python's configuration information"><code class="xref py py-mod docutils literal notranslate"><span class="pre">sysconfig</span></code></a> stores installation paths corresponding to each path name,

  617. for each platform, with variables to be expanded.  For instance the <em>stdlib</em>

  618. path for the <em>nt</em> scheme is: <code class="docutils literal notranslate"><span class="pre">{base}/Lib</span></code>.</p>

  619. <p><a class="reference internal" href="#sysconfig.get_path" title="sysconfig.get_path"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_path()</span></code></a> will use the variables returned by <a class="reference internal" href="#sysconfig.get_config_vars" title="sysconfig.get_config_vars"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_config_vars()</span></code></a>

  620. to expand the path.  All variables have default values for each platform so

  621. one may call this function and get the default value.</p>

  622. <p>If <em>scheme</em> is provided, it must be a value from the list returned by

  623. <a class="reference internal" href="#sysconfig.get_scheme_names" title="sysconfig.get_scheme_names"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_scheme_names()</span></code></a>.  Otherwise, the default scheme for the current

  624. platform is used.</p>

  625. <p>If <em>vars</em> is provided, it must be a dictionary of variables that will update

  626. the dictionary returned by <a class="reference internal" href="#sysconfig.get_config_vars" title="sysconfig.get_config_vars"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_config_vars()</span></code></a>.</p>

  627. <p>If <em>expand</em> is set to <code class="docutils literal notranslate"><span class="pre">False</span></code>, the path will not be expanded using the

  628. variables.</p>

  629. <p>If <em>name</em> is not found, raise a <a class="reference internal" href="exceptions.html#KeyError" title="KeyError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">KeyError</span></code></a>.</p>

  630. </dd></dl>

  631. 

  632. <dl class="py function">

  633. <dt class="sig sig-object py" id="sysconfig.get_paths">

  634. <span class="sig-prename descclassname"><span class="pre">sysconfig.</span></span><span class="sig-name descname"><span class="pre">get_paths</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="n"><span class="pre">scheme</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">vars</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">expand</span></span></em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#sysconfig.get_paths" title="Link to this definition">¶</a></dt>

  635. <dd><p>Return a dictionary containing all installation paths corresponding to an

  636. installation scheme. See <a class="reference internal" href="#sysconfig.get_path" title="sysconfig.get_path"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_path()</span></code></a> for more information.</p>

  637. <p>If <em>scheme</em> is not provided, will use the default scheme for the current

  638. platform.</p>

  639. <p>If <em>vars</em> is provided, it must be a dictionary of variables that will

  640. update the dictionary used to expand the paths.</p>

  641. <p>If <em>expand</em> is set to false, the paths will not be expanded.</p>

  642. <p>If <em>scheme</em> is not an existing scheme, <a class="reference internal" href="#sysconfig.get_paths" title="sysconfig.get_paths"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_paths()</span></code></a> will raise a

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

  644. </dd></dl>

  645. 

  646. </section>

  647. <section id="other-functions">

  648. <h2>Other functions<a class="headerlink" href="#other-functions" title="Link to this heading">¶</a></h2>

  649. <dl class="py function">

  650. <dt class="sig sig-object py" id="sysconfig.get_python_version">

  651. <span class="sig-prename descclassname"><span class="pre">sysconfig.</span></span><span class="sig-name descname"><span class="pre">get_python_version</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#sysconfig.get_python_version" title="Link to this definition">¶</a></dt>

  652. <dd><p>Return the <code class="docutils literal notranslate"><span class="pre">MAJOR.MINOR</span></code> Python version number as a string.  Similar to

  653. <code class="docutils literal notranslate"><span class="pre">'%d.%d'</span> <span class="pre">%</span> <span class="pre">sys.version_info[:2]</span></code>.</p>

  654. </dd></dl>

  655. 

  656. <dl class="py function">

  657. <dt class="sig sig-object py" id="sysconfig.get_platform">

  658. <span class="sig-prename descclassname"><span class="pre">sysconfig.</span></span><span class="sig-name descname"><span class="pre">get_platform</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#sysconfig.get_platform" title="Link to this definition">¶</a></dt>

  659. <dd><p>Return a string that identifies the current platform.</p>

  660. <p>This is used mainly to distinguish platform-specific build directories and

  661. platform-specific built distributions.  Typically includes the OS name and

  662. version and the architecture (as supplied by ‘os.uname()’), although the

  663. exact information included depends on the OS; e.g., on Linux, the kernel

  664. version isn’t particularly important.</p>

  665. <p>Examples of returned values:</p>

  666. <ul class="simple">

  667. <li><p>linux-i586</p></li>

  668. <li><p>linux-alpha (?)</p></li>

  669. <li><p>solaris-2.6-sun4u</p></li>

  670. </ul>

  671. <p>Windows will return one of:</p>

  672. <ul class="simple">

  673. <li><p>win-amd64 (64bit Windows on AMD64, aka x86_64, Intel64, and EM64T)</p></li>

  674. <li><p>win32 (all others - specifically, sys.platform is returned)</p></li>

  675. </ul>

  676. <p>macOS can return:</p>

  677. <ul class="simple">

  678. <li><p>macosx-10.6-ppc</p></li>

  679. <li><p>macosx-10.4-ppc64</p></li>

  680. <li><p>macosx-10.3-i386</p></li>

  681. <li><p>macosx-10.4-fat</p></li>

  682. </ul>

  683. <p>For other non-POSIX platforms, currently just returns <a class="reference internal" href="sys.html#sys.platform" title="sys.platform"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.platform</span></code></a>.</p>

  684. </dd></dl>

  685. 

  686. <dl class="py function">

  687. <dt class="sig sig-object py" id="sysconfig.is_python_build">

  688. <span class="sig-prename descclassname"><span class="pre">sysconfig.</span></span><span class="sig-name descname"><span class="pre">is_python_build</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#sysconfig.is_python_build" title="Link to this definition">¶</a></dt>

  689. <dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if the running Python interpreter was built from source and

  690. is being run from its built location, and not from a location resulting from

  691. e.g. running <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">install</span></code> or installing via a binary installer.</p>

  692. </dd></dl>

  693. 

  694. <dl class="py function">

  695. <dt class="sig sig-object py" id="sysconfig.parse_config_h">

  696. <span class="sig-prename descclassname"><span class="pre">sysconfig.</span></span><span class="sig-name descname"><span class="pre">parse_config_h</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fp</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">vars</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#sysconfig.parse_config_h" title="Link to this definition">¶</a></dt>

  697. <dd><p>Parse a <code class="file docutils literal notranslate"><span class="pre">config.h</span></code>-style file.</p>

  698. <p><em>fp</em> is a file-like object pointing to the <code class="file docutils literal notranslate"><span class="pre">config.h</span></code>-like file.</p>

  699. <p>A dictionary containing name/value pairs is returned.  If an optional

  700. dictionary is passed in as the second argument, it is used instead of a new

  701. dictionary, and updated with the values read in the file.</p>

  702. </dd></dl>

  703. 

  704. <dl class="py function">

  705. <dt class="sig sig-object py" id="sysconfig.get_config_h_filename">

  706. <span class="sig-prename descclassname"><span class="pre">sysconfig.</span></span><span class="sig-name descname"><span class="pre">get_config_h_filename</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#sysconfig.get_config_h_filename" title="Link to this definition">¶</a></dt>

  707. <dd><p>Return the path of <code class="file docutils literal notranslate"><span class="pre">pyconfig.h</span></code>.</p>

  708. </dd></dl>

  709. 

  710. <dl class="py function">

  711. <dt class="sig sig-object py" id="sysconfig.get_makefile_filename">

  712. <span class="sig-prename descclassname"><span class="pre">sysconfig.</span></span><span class="sig-name descname"><span class="pre">get_makefile_filename</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#sysconfig.get_makefile_filename" title="Link to this definition">¶</a></dt>

  713. <dd><p>Return the path of <code class="file docutils literal notranslate"><span class="pre">Makefile</span></code>.</p>

  714. </dd></dl>

  715. 

  716. </section>

  717. <section id="using-sysconfig-as-a-script">

  718. <span id="sysconfig-cli"></span><h2>Using <a class="reference internal" href="#module-sysconfig" title="sysconfig: Python's configuration information"><code class="xref py py-mod docutils literal notranslate"><span class="pre">sysconfig</span></code></a> as a script<a class="headerlink" href="#using-sysconfig-as-a-script" title="Link to this heading">¶</a></h2>

  719. <p>You can use <a class="reference internal" href="#module-sysconfig" title="sysconfig: Python's configuration information"><code class="xref py py-mod docutils literal notranslate"><span class="pre">sysconfig</span></code></a> as a script with Python’s <em>-m</em> option:</p>

  720. <div class="highlight-shell-session notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>python<span class="w"> </span>-m<span class="w"> </span>sysconfig

  721. <span class="go">Platform: &quot;macosx-10.4-i386&quot;</span>

  722. <span class="go">Python version: &quot;3.2&quot;</span>

  723. <span class="go">Current installation scheme: &quot;posix_prefix&quot;</span>

  724. 

  725. <span class="go">Paths:</span>

  726. <span class="go">        data = &quot;/usr/local&quot;</span>

  727. <span class="go">        include = &quot;/Users/tarek/Dev/svn.python.org/py3k/Include&quot;</span>

  728. <span class="go">        platinclude = &quot;.&quot;</span>

  729. <span class="go">        platlib = &quot;/usr/local/lib/python3.2/site-packages&quot;</span>

  730. <span class="go">        platstdlib = &quot;/usr/local/lib/python3.2&quot;</span>

  731. <span class="go">        purelib = &quot;/usr/local/lib/python3.2/site-packages&quot;</span>

  732. <span class="go">        scripts = &quot;/usr/local/bin&quot;</span>

  733. <span class="go">        stdlib = &quot;/usr/local/lib/python3.2&quot;</span>

  734. 

  735. <span class="go">Variables:</span>

  736. <span class="go">        AC_APPLE_UNIVERSAL_BUILD = &quot;0&quot;</span>

  737. <span class="go">        AIX_GENUINE_CPLUSPLUS = &quot;0&quot;</span>

  738. <span class="go">        AR = &quot;ar&quot;</span>

  739. <span class="go">        ARFLAGS = &quot;rc&quot;</span>

  740. <span class="go">        ...</span>

  741. </pre></div>

  742. </div>

  743. <p>This call will print in the standard output the information returned by

  744. <a class="reference internal" href="#sysconfig.get_platform" title="sysconfig.get_platform"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_platform()</span></code></a>, <a class="reference internal" href="#sysconfig.get_python_version" title="sysconfig.get_python_version"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_python_version()</span></code></a>, <a class="reference internal" href="#sysconfig.get_path" title="sysconfig.get_path"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_path()</span></code></a> and

  745. <a class="reference internal" href="#sysconfig.get_config_vars" title="sysconfig.get_config_vars"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_config_vars()</span></code></a>.</p>

  746. </section>

  747. </section>

  748. 

  749. 

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

  751.           </div>

  752.         </div>

  753.       </div>

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

  755.         <div class="sphinxsidebarwrapper">

  756.   <div>

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

  758.     <ul>

  759. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">sysconfig</span></code> — Provide access to Python’s configuration information</a><ul>

  760. <li><a class="reference internal" href="#configuration-variables">Configuration variables</a></li>

  761. <li><a class="reference internal" href="#installation-paths">Installation paths</a></li>

  762. <li><a class="reference internal" href="#user-scheme">User scheme</a><ul>

  763. <li><a class="reference internal" href="#posix-user"><code class="docutils literal notranslate"><span class="pre">posix_user</span></code></a></li>

  764. <li><a class="reference internal" href="#nt-user"><code class="docutils literal notranslate"><span class="pre">nt_user</span></code></a></li>

  765. <li><a class="reference internal" href="#osx-framework-user"><code class="docutils literal notranslate"><span class="pre">osx_framework_user</span></code></a></li>

  766. </ul>

  767. </li>

  768. <li><a class="reference internal" href="#home-scheme">Home scheme</a><ul>

  769. <li><a class="reference internal" href="#posix-home"><code class="docutils literal notranslate"><span class="pre">posix_home</span></code></a></li>

  770. </ul>

  771. </li>

  772. <li><a class="reference internal" href="#prefix-scheme">Prefix scheme</a><ul>

  773. <li><a class="reference internal" href="#posix-prefix"><code class="docutils literal notranslate"><span class="pre">posix_prefix</span></code></a></li>

  774. <li><a class="reference internal" href="#nt"><code class="docutils literal notranslate"><span class="pre">nt</span></code></a></li>

  775. </ul>

  776. </li>

  777. <li><a class="reference internal" href="#installation-path-functions">Installation path functions</a></li>

  778. <li><a class="reference internal" href="#other-functions">Other functions</a></li>

  779. <li><a class="reference internal" href="#using-sysconfig-as-a-script">Using <code class="xref py py-mod docutils literal notranslate"><span class="pre">sysconfig</span></code> as a script</a></li>

  780. </ul>

  781. </li>

  782. </ul>

  783. 

  784.   </div>

  785.   <div>

  786.     <h4>Previous topic</h4>

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

  788.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">sys.monitoring</span></code> — Execution event monitoring</a></p>

  789.   </div>

  790.   <div>

  791.     <h4>Next topic</h4>

  792.     <p class="topless"><a href="builtins.html"

  793.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">builtins</span></code> — Built-in objects</a></p>

  794.   </div>

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

  796.     <h3>This Page</h3>

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

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

  799.       <li>

  800.         <a href="https://github.com/python/cpython/blob/main/Doc/library/sysconfig.rst"

  801.             rel="nofollow">Show Source

  802.         </a>

  803.       </li>

  804.     </ul>

  805.   </div>

  806.         </div>

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

  808. <span>«</span>

  809. </div>

  810. 

  811.       </div>

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

  813.     </div>  

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

  815.       <h3>Navigation</h3>

  816.       <ul>

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

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

  819.              >index</a></li>

  820.         <li class="right" >

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

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

  823.         <li class="right" >

  824.           <a href="builtins.html" title="builtins — Built-in objects"

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

  826.         <li class="right" >

  827.           <a href="sys.monitoring.html" title="sys.monitoring — Execution event monitoring"

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

  829. 

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

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

  832.           <li class="switchers">

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

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

  835.           </li>

  836.           <li>

  837.               

  838.           </li>

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

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

  841.     </li>

  842. 

  843.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  844.           <li class="nav-item nav-item-2"><a href="python.html" >Python Runtime Services</a> &#187;</li>

  845.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">sysconfig</span></code> — Provide access to Python’s configuration information</a></li>

  846.                 <li class="right">

  847.                     

  848. 

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

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

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

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

  853.         </form>

  854.     </div>

  855.                      |

  856.                 </li>

  857.             <li class="right">

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

  859.     Theme

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

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

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

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

  864.     </select>

  865. </label> |</li>

  866.             

  867.       </ul>

  868.     </div>  

  869.     <div class="footer">

  870.     &copy; 

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

  872.     

  873.     Copyright

  874.     

  875.       </a>

  876.      2001-2024, Python Software Foundation.

  877.     <br />

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

  879.     <br />

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

  881.     <br />

  882.     

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

  884.     

  885.     

  886.     <br />

  887. 

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

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

  890. <br />

  891.     <br />

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

  893.     

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

  895.     

  896.     <br />

  897. 

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

  899.     </div>

  900. 

  901.   </body>

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