29.13. site —— 站点专属的配置钩子

源代码: Lib/site.py

这个模块将在初始化时被自动导入。 此自动导入可以通过使用解释器的 -S 选项来屏蔽。

导入此模块将会附加域特定的路径到模块搜索路径并且添加一些内建对象，除非使用了 -S 选项。 那样的话，模块可以被安全地导入，而不会对模块搜索路径和内建对象有自动的修改或添加。要明确地触发通常域特定的添加，调用函数 site.main()。

在 3.3 版更改: 在之前即便使用了 -S，导入此模块仍然会触发路径操纵。

它会从头部和尾部构建至多四个目录作为起点。 对于头部，它会使用 sys.prefix 和 sys.exec_prefix；空的头部会被跳过。 对于尾部，它会使用空字符串然后是 lib/site-packages (在 Windows 上) 或 lib/python*X.Y*/site-packages (在 Unix 和 Macintosh 上)。 对于每个不同的头-尾组合，它会查看其是否指向现有的目录，如果是的话，则将其添加到 sys.path 并且检查新添加目录中的配置文件。

在 3.5 版更改: 对 “site-python” 目录的支持已被移除。

If a file named “pyvenv.cfg” exists one directory above sys.executable, sys.prefix and sys.exec_prefix are set to that directory and it is also checked for site-packages (sys.base_prefix and sys.base_exec_prefix will always be the “real” prefixes of the Python installation). If “pyvenv.cfg” (a bootstrap configuration file) contains the key “include-system-site-packages” set to anything other than “false” (case-insensitive), the system-level prefixes will still also be searched for site-packages; otherwise they won’t.

一个路径配置文件是具有 *name*.pth 命名格式的文件，并且存在上面提到的四个目录之一中；它的内容是要添加到 sys.path 中的额外项目（每行一个）。不存在的项目不会添加到 sys.path，并且不会检查项目指向的是目录还是文件。项目不会被添加到 sys.path 超过一次。空行和由 # 起始的行会被跳过。以 import 开始的行（跟着空格或 TAB）会被执行。

例如，假设 sys.prefix 和 sys.exec_prefix 已经被设置为 /usr/local。 Python X.Y 的库之后被安装为 /usr/local/lib/python*X.Y*。假设有一个拥有三个孙目录 foo, bar 和 spam 的子目录 /usr/local/lib/python*X.Y*/site-packages，并且有两个路径配置文件 foot.pth 和 bar.pth。假定 foo.pth 内容如下:

  1. # foo package configuration
  3. foo
  4. bar
  5. bletch

并且 bar.pth 包含:

  1. # bar package configuration
  3. bar

则下面特定版目录将以如下顺序被添加到 sys.path。

  1. /usr/local/lib/pythonX.Y/site-packages/bar
  2. /usr/local/lib/pythonX.Y/site-packages/foo

请注意 bletch 已被省略因为它并不存在；bar 目前在 foo 目录之前因为 bar.pth 按字母顺序排在 foo.pth 之前；而 spam 已被省略因为它在两个路径配置文件中都未被提及。

After these path manipulations, an attempt is made to import a module named sitecustomize, which can perform arbitrary site-specific customizations. It is typically created by a system administrator in the site-packages directory. If this import fails with an ImportError exception, it is silently ignored. If Python is started without output streams available, as with pythonw.exe on Windows (which is used by default to start IDLE), attempted output from sitecustomize is ignored. Any exception other than ImportError causes a silent and perhaps mysterious failure of the process.

After this, an attempt is made to import a module named usercustomize, which can perform arbitrary user-specific customizations, if ENABLE_USER_SITE is true. This file is intended to be created in the user site-packages directory (see below), which is part of sys.path unless disabled by -s. An ImportError will be silently ignored.

请注意对于某些非 Unix 系统来说，sys.prefix 和 sys.exec_prefix 均为空值，并且路径操作会被跳过；但是仍然会尝试导入 sitecustomize 和 usercustomize。

29.13.1. Readline（类库） 配置

在支持 readline 的系统上，这个模块也将导入并配置 rlcompleter 模块，如果 Python 是以 交互模式 启动并且不带 -S 选项的话。 默认的行为是启用 tab 键补全并使用 ~/.python_history 作为历史存档文件。 要禁用它，请删除（或重载）你的 sitecustomize 或 usercustomize 模块或 PYTHONSTARTUP 文件中的 sys.__interactivehook__ 属性。

在 3.4 版更改: rlcompleter 和 history 会被自动激活。

29.13.2. 模块内容

site.PREFIXES

site-packages 目录的前缀列表。

site.ENABLE_USER_SITE

显示用户 site-packages 目录状态的旗标。 True 意味着它被启用并被添加到 sys.path。 False 意味着它按照用户请求被禁用 (通过 -s 或 PYTHONNOUSERSITE)。 None 意味着它因安全理由（user 或 group id 和 effective id 之间不匹配）或是被管理员所禁用。

site.USER_SITE

正在运行的 Python 的用户级 site-packages 的路径。 它可以为 None，如果 getusersitepackages() 尚未被调用的话。 默认值在 UNIX 和非框架 Mac OS X 编译版上为 ~/.local/lib/python*X.Y*/site-packages，在 Mac 框架编译版上为 ~/Library/Python/*X.Y*/lib/python/site-packages，而在 Windows 上则为 *%APPDATA%*\Python\Python*XY*\site-packages。 此目录属于站点目录，这意味着其中的 .pth 文件将会被处理。

site.USER_BASE

用户级 site-packages 的基准目录的路径。 它可以为 None，如果 getuserbase() 尚未被调用的话。 默认值在 UNIX 和 Mac OS X 非框架编译版上为 ~/.local，在 Mac 框架编译版上为 ~/Library/Python/*X.Y*，而在 Windows 上则为 *%APPDATA%*\Python。 这个值会被 Distutils 用来计算脚本、数据文件和 Python 模块等的安装目录。 对于 用户安装规范。 另请参阅 PYTHONUSERBASE。

site.main()

将所有的标准站点专属目录添加到模块搜索路径。 这个函数会在导入此模块时被自动调用，除非 Python 解释器启动时附带了 -S 旗标。

在 3.3 版更改: 这个函数使用无条件调用。

site.addsitedir(sitedir, known_paths=None)

将一个目录添加到 sys.path 并处理其 .pth 文件。 通常被用于 sitecustomize 或 usercustomize (见下文)。

site.getsitepackages()

返回包含所有全局 site-packages 目录的列表。

3.2 新版功能.

site.getuserbase()

返回用户基准目录的路径 USER_BASE。 如果它尚未被初始化，则此函数还将参照 PYTHONUSERBASE 来设置它。

3.2 新版功能.

site.getusersitepackages()

Return the path of the user-specific site-packages directory, USER_SITE. If it is not initialized yet, this function will also set it, respecting PYTHONNOUSERSITE and USER_BASE.

3.2 新版功能.

site 模块还提供了一个从命令行获取用户目录的方式:

  1. $ python3 -m site --user-site
  2. /home/user/.local/lib/python3.3/site-packages

如果它被不带参数地调用，它将在标准输出打印 sys.path 的内容，再打印 USER_BASE 的值以及该目录是否存在，然后打印 USER_SITE 的相应信息，最后打印 ENABLE_USER_SITE 的值。

--user-base

输出用户基本的路径。

--user-site

将路径输出到用户site-packages目录。

如果同时给出了两个选项，则将打印用户基准目录和用户站点信息（总是按此顺序），并以 os.pathsep 分隔。

如果给出了其中一个选项，脚本将退出并返回以下值中的一个：如果用户级 site-packages 目录被启用则为 0，如果它被用户禁用则为 1，如果它因安全理由或被管理员禁用则为 2，如果发生错误则为大于 2 的值。

参见

PEP 370 – 分用户的 site-packages 目录