Baoding-FenShuaJiang
/
Green_GoodERP18_FSJ_Standard
Volgen 1
Ster 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 Labels
${ item.name }
Maak branch ${ searchTerm }
van '0f75e31513'
${ noResults }
Green_GoodERP18_FSJ_Standard/python/Doc/html/library/site.html

594 lines
43KB
Ruw Blame Geschiedenis 

  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="site — Site-specific configuration hook" />

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

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

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

  11. <meta property="og:description" content="Source code: Lib/site.py This module is automatically imported during initialization. The automatic import can be suppressed using the interpreter’s-S option. Importing this module will append site..." />

  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/site.py This module is automatically imported during initialization. The automatic import can be suppressed using the interpreter’s-S option. Importing this module will append site..." />

  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>site — Site-specific configuration hook &#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="Custom Python Interpreters" href="custominterp.html" />

  39.     <link rel="prev" title="inspect — Inspect live objects" href="inspect.html" />

  40.     <link rel="canonical" href="https://docs.python.org/3/library/site.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">site</span></code> — Site-specific configuration hook</a><ul>

  99. <li><a class="reference internal" href="#module-sitecustomize"><code class="xref py py-mod docutils literal notranslate"><span class="pre">sitecustomize</span></code></a></li>

  100. <li><a class="reference internal" href="#module-usercustomize"><code class="xref py py-mod docutils literal notranslate"><span class="pre">usercustomize</span></code></a></li>

  101. <li><a class="reference internal" href="#readline-configuration">Readline configuration</a></li>

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

  103. <li><a class="reference internal" href="#command-line-interface">Command Line Interface</a></li>

  104. </ul>

  105. </li>

  106. </ul>

  107. 

  108.   </div>

  109.   <div>

  110.     <h4>Previous topic</h4>

  111.     <p class="topless"><a href="inspect.html"

  112.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">inspect</span></code> — Inspect live objects</a></p>

  113.   </div>

  114.   <div>

  115.     <h4>Next topic</h4>

  116.     <p class="topless"><a href="custominterp.html"

  117.                           title="next chapter">Custom Python Interpreters</a></p>

  118.   </div>

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

  120.     <h3>This Page</h3>

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

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

  123.       <li>

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

  125.             rel="nofollow">Show Source

  126.         </a>

  127.       </li>

  128.     </ul>

  129.   </div>

  130.         </nav>

  131.     </div>

  132. </div>

  133. 

  134.   

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

  136.       <h3>Navigation</h3>

  137.       <ul>

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

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

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

  141.         <li class="right" >

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

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

  144.         <li class="right" >

  145.           <a href="custominterp.html" title="Custom Python Interpreters"

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

  147.         <li class="right" >

  148.           <a href="inspect.html" title="inspect — Inspect live objects"

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

  150. 

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

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

  153.           <li class="switchers">

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

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

  156.           </li>

  157.           <li>

  158.               

  159.           </li>

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

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

  162.     </li>

  163. 

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

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

  166.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">site</span></code> — Site-specific configuration hook</a></li>

  167.                 <li class="right">

  168.                     

  169. 

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

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

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

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

  174.         </form>

  175.     </div>

  176.                      |

  177.                 </li>

  178.             <li class="right">

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

  180.     Theme

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

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

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

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

  185.     </select>

  186. </label> |</li>

  187.             

  188.       </ul>

  189.     </div>    

  190. 

  191.     <div class="document">

  192.       <div class="documentwrapper">

  193.         <div class="bodywrapper">

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

  195.             

  196.   <section id="module-site">

  197. <span id="site-site-specific-configuration-hook"></span><h1><a class="reference internal" href="#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> — Site-specific configuration hook<a class="headerlink" href="#module-site" title="Link to this heading">¶</a></h1>

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

  199. <hr class="docutils" />

  200. <p><strong>This module is automatically imported during initialization.</strong> The automatic

  201. import can be suppressed using the interpreter’s <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> option.</p>

  202. <p id="index-0">Importing this module will append site-specific paths to the module search path

  203. and add a few builtins, unless <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> was used.  In that case, this module

  204. can be safely imported with no automatic modifications to the module search path

  205. or additions to the builtins.  To explicitly trigger the usual site-specific

  206. additions, call the <a class="reference internal" href="#site.main" title="site.main"><code class="xref py py-func docutils literal notranslate"><span class="pre">main()</span></code></a> function.</p>

  207. <div class="versionchanged">

  208. <p><span class="versionmodified changed">Changed in version 3.3: </span>Importing the module used to trigger paths manipulation even when using

  209. <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>.</p>

  210. </div>

  211. <p id="index-1">It starts by constructing up to four directories from a head and a tail part.

  212. For the head part, it uses <code class="docutils literal notranslate"><span class="pre">sys.prefix</span></code> and <code class="docutils literal notranslate"><span class="pre">sys.exec_prefix</span></code>; empty heads

  213. are skipped.  For the tail part, it uses the empty string and then

  214. <code class="file docutils literal notranslate"><span class="pre">lib/site-packages</span></code> (on Windows) or

  215. <code class="file docutils literal notranslate"><span class="pre">lib/python</span><em><span class="pre">X.Y</span></em><span class="pre">/site-packages</span></code> (on Unix and macOS).  For each

  216. of the distinct head-tail combinations, it sees if it refers to an existing

  217. directory, and if so, adds it to <code class="docutils literal notranslate"><span class="pre">sys.path</span></code> and also inspects the newly

  218. added path for configuration files.</p>

  219. <div class="versionchanged">

  220. <p><span class="versionmodified changed">Changed in version 3.5: </span>Support for the “site-python” directory has been removed.</p>

  221. </div>

  222. <p>If a file named “pyvenv.cfg” exists one directory above sys.executable,

  223. sys.prefix and sys.exec_prefix are set to that directory and

  224. it is also checked for site-packages (sys.base_prefix and

  225. sys.base_exec_prefix will always be the “real” prefixes of the Python

  226. installation). If “pyvenv.cfg” (a bootstrap configuration file) contains

  227. the key “include-system-site-packages” set to anything other than “true”

  228. (case-insensitive), the system-level prefixes will not be

  229. searched for site-packages; otherwise they will.</p>

  230. <p id="index-2">A path configuration file is a file whose name has the form <code class="file docutils literal notranslate"><em><span class="pre">name</span></em><span class="pre">.pth</span></code>

  231. and exists in one of the four directories mentioned above; its contents are

  232. additional items (one per line) to be added to <code class="docutils literal notranslate"><span class="pre">sys.path</span></code>.  Non-existing items

  233. are never added to <code class="docutils literal notranslate"><span class="pre">sys.path</span></code>, and no check is made that the item refers to a

  234. directory rather than a file.  No item is added to <code class="docutils literal notranslate"><span class="pre">sys.path</span></code> more than

  235. once.  Blank lines and lines beginning with <code class="docutils literal notranslate"><span class="pre">#</span></code> are skipped.  Lines starting

  236. with <code class="docutils literal notranslate"><span class="pre">import</span></code> (followed by space or tab) are executed.</p>

  237. <div class="admonition note">

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

  239. <p>An executable line in a <code class="file docutils literal notranslate"><span class="pre">.pth</span></code> file is run at every Python startup,

  240. regardless of whether a particular module is actually going to be used.

  241. Its impact should thus be kept to a minimum.

  242. The primary intended purpose of executable lines is to make the

  243. corresponding module(s) importable

  244. (load 3rd-party import hooks, adjust <span class="target" id="index-3"></span><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PATH</span></code> etc).

  245. Any other initialization is supposed to be done upon a module’s

  246. actual import, if and when it happens.

  247. Limiting a code chunk to a single line is a deliberate measure

  248. to discourage putting anything more complex here.</p>

  249. </div>

  250. <p id="index-4">For example, suppose <code class="docutils literal notranslate"><span class="pre">sys.prefix</span></code> and <code class="docutils literal notranslate"><span class="pre">sys.exec_prefix</span></code> are set to

  251. <code class="file docutils literal notranslate"><span class="pre">/usr/local</span></code>.  The Python X.Y library is then installed in

  252. <code class="file docutils literal notranslate"><span class="pre">/usr/local/lib/python</span><em><span class="pre">X.Y</span></em></code>.  Suppose this has

  253. a subdirectory <code class="file docutils literal notranslate"><span class="pre">/usr/local/lib/python</span><em><span class="pre">X.Y</span></em><span class="pre">/site-packages</span></code> with three

  254. subsubdirectories, <code class="file docutils literal notranslate"><span class="pre">foo</span></code>, <code class="file docutils literal notranslate"><span class="pre">bar</span></code> and <code class="file docutils literal notranslate"><span class="pre">spam</span></code>, and two path

  255. configuration files, <code class="file docutils literal notranslate"><span class="pre">foo.pth</span></code> and <code class="file docutils literal notranslate"><span class="pre">bar.pth</span></code>.  Assume

  256. <code class="file docutils literal notranslate"><span class="pre">foo.pth</span></code> contains the following:</p>

  257. <div class="highlight-none notranslate"><div class="highlight"><pre><span></span># foo package configuration

  258. 

  259. foo

  260. bar

  261. bletch

  262. </pre></div>

  263. </div>

  264. <p>and <code class="file docutils literal notranslate"><span class="pre">bar.pth</span></code> contains:</p>

  265. <div class="highlight-none notranslate"><div class="highlight"><pre><span></span># bar package configuration

  266. 

  267. bar

  268. </pre></div>

  269. </div>

  270. <p>Then the following version-specific directories are added to

  271. <code class="docutils literal notranslate"><span class="pre">sys.path</span></code>, in this order:</p>

  272. <div class="highlight-none notranslate"><div class="highlight"><pre><span></span>/usr/local/lib/pythonX.Y/site-packages/bar

  273. /usr/local/lib/pythonX.Y/site-packages/foo

  274. </pre></div>

  275. </div>

  276. <p>Note that <code class="file docutils literal notranslate"><span class="pre">bletch</span></code> is omitted because it doesn’t exist; the <code class="file docutils literal notranslate"><span class="pre">bar</span></code>

  277. directory precedes the <code class="file docutils literal notranslate"><span class="pre">foo</span></code> directory because <code class="file docutils literal notranslate"><span class="pre">bar.pth</span></code> comes

  278. alphabetically before <code class="file docutils literal notranslate"><span class="pre">foo.pth</span></code>; and <code class="file docutils literal notranslate"><span class="pre">spam</span></code> is omitted because it is

  279. not mentioned in either path configuration file.</p>

  280. <section id="module-sitecustomize">

  281. <span id="sitecustomize"></span><h2><a class="reference internal" href="#module-sitecustomize" title="sitecustomize"><code class="xref py py-mod docutils literal notranslate"><span class="pre">sitecustomize</span></code></a><a class="headerlink" href="#module-sitecustomize" title="Link to this heading">¶</a></h2>

  282. <p>After these path manipulations, an attempt is made to import a module named

  283. <a class="reference internal" href="#module-sitecustomize" title="sitecustomize"><code class="xref py py-mod docutils literal notranslate"><span class="pre">sitecustomize</span></code></a>, which can perform arbitrary site-specific customizations.

  284. It is typically created by a system administrator in the site-packages

  285. directory.  If this import fails with an <a class="reference internal" href="exceptions.html#ImportError" title="ImportError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ImportError</span></code></a> or its subclass

  286. exception, and the exception’s <a class="reference internal" href="exceptions.html#ImportError.name" title="ImportError.name"><code class="xref py py-attr docutils literal notranslate"><span class="pre">name</span></code></a>

  287. attribute equals to <code class="docutils literal notranslate"><span class="pre">'sitecustomize'</span></code>,

  288. it is silently ignored.  If Python is started without output streams available, as

  289. with <code class="file docutils literal notranslate"><span class="pre">pythonw.exe</span></code> on Windows (which is used by default to start IDLE),

  290. attempted output from <a class="reference internal" href="#module-sitecustomize" title="sitecustomize"><code class="xref py py-mod docutils literal notranslate"><span class="pre">sitecustomize</span></code></a> is ignored.  Any other exception

  291. causes a silent and perhaps mysterious failure of the process.</p>

  292. </section>

  293. <section id="module-usercustomize">

  294. <span id="usercustomize"></span><h2><a class="reference internal" href="#module-usercustomize" title="usercustomize"><code class="xref py py-mod docutils literal notranslate"><span class="pre">usercustomize</span></code></a><a class="headerlink" href="#module-usercustomize" title="Link to this heading">¶</a></h2>

  295. <p>After this, an attempt is made to import a module named <a class="reference internal" href="#module-usercustomize" title="usercustomize"><code class="xref py py-mod docutils literal notranslate"><span class="pre">usercustomize</span></code></a>,

  296. which can perform arbitrary user-specific customizations, if

  297. <a class="reference internal" href="#site.ENABLE_USER_SITE" title="site.ENABLE_USER_SITE"><code class="xref py py-data docutils literal notranslate"><span class="pre">ENABLE_USER_SITE</span></code></a> is true.  This file is intended to be created in the

  298. user site-packages directory (see below), which is part of <code class="docutils literal notranslate"><span class="pre">sys.path</span></code> unless

  299. disabled by <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>.  If this import fails with an <a class="reference internal" href="exceptions.html#ImportError" title="ImportError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ImportError</span></code></a> or

  300. its subclass exception, and the exception’s <a class="reference internal" href="exceptions.html#ImportError.name" title="ImportError.name"><code class="xref py py-attr docutils literal notranslate"><span class="pre">name</span></code></a>

  301. attribute equals to <code class="docutils literal notranslate"><span class="pre">'usercustomize'</span></code>, it is silently ignored.</p>

  302. <p>Note that for some non-Unix systems, <code class="docutils literal notranslate"><span class="pre">sys.prefix</span></code> and <code class="docutils literal notranslate"><span class="pre">sys.exec_prefix</span></code> are

  303. empty, and the path manipulations are skipped; however the import of

  304. <a class="reference internal" href="#module-sitecustomize" title="sitecustomize"><code class="xref py py-mod docutils literal notranslate"><span class="pre">sitecustomize</span></code></a> and <a class="reference internal" href="#module-usercustomize" title="usercustomize"><code class="xref py py-mod docutils literal notranslate"><span class="pre">usercustomize</span></code></a> is still attempted.</p>

  305. </section>

  306. <section id="readline-configuration">

  307. <span id="rlcompleter-config"></span><h2>Readline configuration<a class="headerlink" href="#readline-configuration" title="Link to this heading">¶</a></h2>

  308. <p>On systems that support <a class="reference internal" href="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>, this module will also import and

  309. configure the <a class="reference internal" href="rlcompleter.html#module-rlcompleter" title="rlcompleter: Python identifier completion, suitable for the GNU readline library."><code class="xref py py-mod docutils literal notranslate"><span class="pre">rlcompleter</span></code></a> module, if Python is started in

  310. <a class="reference internal" href="../tutorial/interpreter.html#tut-interactive"><span class="std std-ref">interactive mode</span></a> and without 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> option.

  311. The default behavior is enable tab-completion and to use

  312. <code class="file docutils literal notranslate"><span class="pre">~/.python_history</span></code> as the history save file.  To disable it, delete (or

  313. override) the <a class="reference internal" href="sys.html#sys.__interactivehook__" title="sys.__interactivehook__"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.__interactivehook__</span></code></a> attribute in your

  314. <a class="reference internal" href="#module-sitecustomize" title="sitecustomize"><code class="xref py py-mod docutils literal notranslate"><span class="pre">sitecustomize</span></code></a> or <a class="reference internal" href="#module-usercustomize" title="usercustomize"><code class="xref py py-mod docutils literal notranslate"><span class="pre">usercustomize</span></code></a> module or your

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

  316. <div class="versionchanged">

  317. <p><span class="versionmodified changed">Changed in version 3.4: </span>Activation of rlcompleter and history was made automatic.</p>

  318. </div>

  319. </section>

  320. <section id="module-contents">

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

  322. <dl class="py data">

  323. <dt class="sig sig-object py" id="site.PREFIXES">

  324. <span class="sig-prename descclassname"><span class="pre">site.</span></span><span class="sig-name descname"><span class="pre">PREFIXES</span></span><a class="headerlink" href="#site.PREFIXES" title="Link to this definition">¶</a></dt>

  325. <dd><p>A list of prefixes for site-packages directories.</p>

  326. </dd></dl>

  327. 

  328. <dl class="py data">

  329. <dt class="sig sig-object py" id="site.ENABLE_USER_SITE">

  330. <span class="sig-prename descclassname"><span class="pre">site.</span></span><span class="sig-name descname"><span class="pre">ENABLE_USER_SITE</span></span><a class="headerlink" href="#site.ENABLE_USER_SITE" title="Link to this definition">¶</a></dt>

  331. <dd><p>Flag showing the status of the user site-packages directory.  <code class="docutils literal notranslate"><span class="pre">True</span></code> means

  332. that it is enabled and was added to <code class="docutils literal notranslate"><span class="pre">sys.path</span></code>.  <code class="docutils literal notranslate"><span class="pre">False</span></code> means that it

  333. was disabled by user request (with <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> or

  334. <span class="target" id="index-6"></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>).  <code class="docutils literal notranslate"><span class="pre">None</span></code> means it was disabled for security

  335. reasons (mismatch between user or group id and effective id) or by an

  336. administrator.</p>

  337. </dd></dl>

  338. 

  339. <dl class="py data">

  340. <dt class="sig sig-object py" id="site.USER_SITE">

  341. <span class="sig-prename descclassname"><span class="pre">site.</span></span><span class="sig-name descname"><span class="pre">USER_SITE</span></span><a class="headerlink" href="#site.USER_SITE" title="Link to this definition">¶</a></dt>

  342. <dd><p>Path to the user site-packages for the running Python.  Can be <code class="docutils literal notranslate"><span class="pre">None</span></code> if

  343. <a class="reference internal" href="#site.getusersitepackages" title="site.getusersitepackages"><code class="xref py py-func docutils literal notranslate"><span class="pre">getusersitepackages()</span></code></a> hasn’t been called yet.  Default value is

  344. <code class="file docutils literal notranslate"><span class="pre">~/.local/lib/python</span><em><span class="pre">X.Y</span></em><span class="pre">/site-packages</span></code> for UNIX and non-framework

  345. macOS builds, <code class="file docutils literal notranslate"><span class="pre">~/Library/Python/</span><em><span class="pre">X.Y</span></em><span class="pre">/lib/python/site-packages</span></code> for macOS

  346. framework builds, and <code class="file docutils literal notranslate"><em><span class="pre">%APPDATA%</span></em><span class="pre">\Python\Python</span><em><span class="pre">XY</span></em><span class="pre">\site-packages</span></code>

  347. on Windows.  This directory is a site directory, which means that

  348. <code class="file docutils literal notranslate"><span class="pre">.pth</span></code> files in it will be processed.</p>

  349. </dd></dl>

  350. 

  351. <dl class="py data">

  352. <dt class="sig sig-object py" id="site.USER_BASE">

  353. <span class="sig-prename descclassname"><span class="pre">site.</span></span><span class="sig-name descname"><span class="pre">USER_BASE</span></span><a class="headerlink" href="#site.USER_BASE" title="Link to this definition">¶</a></dt>

  354. <dd><p>Path to the base directory for the user site-packages.  Can be <code class="docutils literal notranslate"><span class="pre">None</span></code> if

  355. <a class="reference internal" href="#site.getuserbase" title="site.getuserbase"><code class="xref py py-func docutils literal notranslate"><span class="pre">getuserbase()</span></code></a> hasn’t been called yet.  Default value is

  356. <code class="file docutils literal notranslate"><span class="pre">~/.local</span></code> for UNIX and macOS non-framework builds,

  357. <code class="file docutils literal notranslate"><span class="pre">~/Library/Python/</span><em><span class="pre">X.Y</span></em></code> for macOS framework builds, and

  358. <code class="file docutils literal notranslate"><em><span class="pre">%APPDATA%</span></em><span class="pre">\Python</span></code> for Windows.  This value is used to

  359. compute the installation directories for scripts, data files, Python modules,

  360. etc. for the <a class="reference internal" href="sysconfig.html#sysconfig-user-scheme"><span class="std std-ref">user installation scheme</span></a>.

  361. See also <span class="target" id="index-7"></span><a class="reference internal" href="../using/cmdline.html#envvar-PYTHONUSERBASE"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PYTHONUSERBASE</span></code></a>.</p>

  362. </dd></dl>

  363. 

  364. <dl class="py function">

  365. <dt class="sig sig-object py" id="site.main">

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

  367. <dd><p>Adds all the standard site-specific directories to the module search

  368. path.  This function is called automatically when this module is imported,

  369. unless the Python interpreter was started with 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> flag.</p>

  370. <div class="versionchanged">

  371. <p><span class="versionmodified changed">Changed in version 3.3: </span>This function used to be called unconditionally.</p>

  372. </div>

  373. </dd></dl>

  374. 

  375. <dl class="py function">

  376. <dt class="sig sig-object py" id="site.addsitedir">

  377. <span class="sig-prename descclassname"><span class="pre">site.</span></span><span class="sig-name descname"><span class="pre">addsitedir</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sitedir</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">known_paths</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#site.addsitedir" title="Link to this definition">¶</a></dt>

  378. <dd><p>Add a directory to sys.path and process its <code class="file docutils literal notranslate"><span class="pre">.pth</span></code> files.  Typically

  379. used in <a class="reference internal" href="#module-sitecustomize" title="sitecustomize"><code class="xref py py-mod docutils literal notranslate"><span class="pre">sitecustomize</span></code></a> or <a class="reference internal" href="#module-usercustomize" title="usercustomize"><code class="xref py py-mod docutils literal notranslate"><span class="pre">usercustomize</span></code></a> (see above).</p>

  380. </dd></dl>

  381. 

  382. <dl class="py function">

  383. <dt class="sig sig-object py" id="site.getsitepackages">

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

  385. <dd><p>Return a list containing all global site-packages directories.</p>

  386. <div class="versionadded">

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

  388. </div>

  389. </dd></dl>

  390. 

  391. <dl class="py function">

  392. <dt class="sig sig-object py" id="site.getuserbase">

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

  394. <dd><p>Return the path of the user base directory, <a class="reference internal" href="#site.USER_BASE" title="site.USER_BASE"><code class="xref py py-data docutils literal notranslate"><span class="pre">USER_BASE</span></code></a>.  If it is not

  395. initialized yet, this function will also set it, respecting

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

  397. <div class="versionadded">

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

  399. </div>

  400. </dd></dl>

  401. 

  402. <dl class="py function">

  403. <dt class="sig sig-object py" id="site.getusersitepackages">

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

  405. <dd><p>Return the path of the user-specific site-packages directory,

  406. <a class="reference internal" href="#site.USER_SITE" title="site.USER_SITE"><code class="xref py py-data docutils literal notranslate"><span class="pre">USER_SITE</span></code></a>.  If it is not initialized yet, this function will also set

  407. it, respecting <a class="reference internal" href="#site.USER_BASE" title="site.USER_BASE"><code class="xref py py-data docutils literal notranslate"><span class="pre">USER_BASE</span></code></a>.  To determine if the user-specific

  408. site-packages was added to <code class="docutils literal notranslate"><span class="pre">sys.path</span></code> <a class="reference internal" href="#site.ENABLE_USER_SITE" title="site.ENABLE_USER_SITE"><code class="xref py py-data docutils literal notranslate"><span class="pre">ENABLE_USER_SITE</span></code></a> should be

  409. used.</p>

  410. <div class="versionadded">

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

  412. </div>

  413. </dd></dl>

  414. 

  415. </section>

  416. <section id="command-line-interface">

  417. <span id="site-commandline"></span><h2>Command Line Interface<a class="headerlink" href="#command-line-interface" title="Link to this heading">¶</a></h2>

  418. <p>The <a class="reference internal" href="#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 also provides a way to get the user directories from the

  419. command line:</p>

  420. <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>site<span class="w"> </span>--user-site

  421. <span class="go">/home/user/.local/lib/python3.11/site-packages</span>

  422. </pre></div>

  423. </div>

  424. <p>If it is called without arguments, it will print the contents of

  425. <a class="reference internal" href="sys.html#sys.path" title="sys.path"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.path</span></code></a> on the standard output, followed by the value of

  426. <a class="reference internal" href="#site.USER_BASE" title="site.USER_BASE"><code class="xref py py-data docutils literal notranslate"><span class="pre">USER_BASE</span></code></a> and whether the directory exists, then the same thing for

  427. <a class="reference internal" href="#site.USER_SITE" title="site.USER_SITE"><code class="xref py py-data docutils literal notranslate"><span class="pre">USER_SITE</span></code></a>, and finally the value of <a class="reference internal" href="#site.ENABLE_USER_SITE" title="site.ENABLE_USER_SITE"><code class="xref py py-data docutils literal notranslate"><span class="pre">ENABLE_USER_SITE</span></code></a>.</p>

  428. <dl class="std option">

  429. <dt class="sig sig-object std" id="cmdoption-site-user-base">

  430. <span class="sig-name descname"><span class="pre">--user-base</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-site-user-base" title="Link to this definition">¶</a></dt>

  431. <dd><p>Print the path to the user base directory.</p>

  432. </dd></dl>

  433. 

  434. <dl class="std option">

  435. <dt class="sig sig-object std" id="cmdoption-site-user-site">

  436. <span class="sig-name descname"><span class="pre">--user-site</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-site-user-site" title="Link to this definition">¶</a></dt>

  437. <dd><p>Print the path to the user site-packages directory.</p>

  438. </dd></dl>

  439. 

  440. <p>If both options are given, user base and user site will be printed (always in

  441. this order), separated by <a class="reference internal" href="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>

  442. <p>If any option is given, the script will exit with one of these values: <code class="docutils literal notranslate"><span class="pre">0</span></code> if

  443. the user site-packages directory is enabled, <code class="docutils literal notranslate"><span class="pre">1</span></code> if it was disabled by the

  444. user, <code class="docutils literal notranslate"><span class="pre">2</span></code> if it is disabled for security reasons or by an administrator, and a

  445. value greater than 2 if there is an error.</p>

  446. <div class="admonition seealso">

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

  448. <ul class="simple">

  449. <li><p><span class="target" id="index-9"></span><a class="pep reference external" href="https://peps.python.org/pep-0370/"><strong>PEP 370</strong></a> – Per user site-packages directory</p></li>

  450. <li><p><a class="reference internal" href="sys_path_init.html#sys-path-init"><span class="std std-ref">The initialization of the sys.path module search path</span></a> – The initialization of <a class="reference internal" href="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>

  451. </ul>

  452. </div>

  453. </section>

  454. </section>

  455. 

  456. 

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

  458.           </div>

  459.         </div>

  460.       </div>

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

  462.         <div class="sphinxsidebarwrapper">

  463.   <div>

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

  465.     <ul>

  466. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">site</span></code> — Site-specific configuration hook</a><ul>

  467. <li><a class="reference internal" href="#module-sitecustomize"><code class="xref py py-mod docutils literal notranslate"><span class="pre">sitecustomize</span></code></a></li>

  468. <li><a class="reference internal" href="#module-usercustomize"><code class="xref py py-mod docutils literal notranslate"><span class="pre">usercustomize</span></code></a></li>

  469. <li><a class="reference internal" href="#readline-configuration">Readline configuration</a></li>

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

  471. <li><a class="reference internal" href="#command-line-interface">Command Line Interface</a></li>

  472. </ul>

  473. </li>

  474. </ul>

  475. 

  476.   </div>

  477.   <div>

  478.     <h4>Previous topic</h4>

  479.     <p class="topless"><a href="inspect.html"

  480.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">inspect</span></code> — Inspect live objects</a></p>

  481.   </div>

  482.   <div>

  483.     <h4>Next topic</h4>

  484.     <p class="topless"><a href="custominterp.html"

  485.                           title="next chapter">Custom Python Interpreters</a></p>

  486.   </div>

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

  488.     <h3>This Page</h3>

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

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

  491.       <li>

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

  493.             rel="nofollow">Show Source

  494.         </a>

  495.       </li>

  496.     </ul>

  497.   </div>

  498.         </div>

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

  500. <span>«</span>

  501. </div>

  502. 

  503.       </div>

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

  505.     </div>  

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

  507.       <h3>Navigation</h3>

  508.       <ul>

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

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

  511.              >index</a></li>

  512.         <li class="right" >

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

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

  515.         <li class="right" >

  516.           <a href="custominterp.html" title="Custom Python Interpreters"

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

  518.         <li class="right" >

  519.           <a href="inspect.html" title="inspect — Inspect live objects"

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

  521. 

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

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

  524.           <li class="switchers">

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

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

  527.           </li>

  528.           <li>

  529.               

  530.           </li>

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

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

  533.     </li>

  534. 

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

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

  537.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">site</span></code> — Site-specific configuration hook</a></li>

  538.                 <li class="right">

  539.                     

  540. 

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

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

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

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

  545.         </form>

  546.     </div>

  547.                      |

  548.                 </li>

  549.             <li class="right">

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

  551.     Theme

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

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

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

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

  556.     </select>

  557. </label> |</li>

  558.             

  559.       </ul>

  560.     </div>  

  561.     <div class="footer">

  562.     &copy; 

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

  564.     

  565.     Copyright

  566.     

  567.       </a>

  568.      2001-2024, Python Software Foundation.

  569.     <br />

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

  571.     <br />

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

  573.     <br />

  574.     

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

  576.     

  577.     

  578.     <br />

  579. 

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

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

  582. <br />

  583.     <br />

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

  585.     

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

  587.     

  588.     <br />

  589. 

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

  591.     </div>

  592. 

  593.   </body>

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