sysconfig — 提供对 Python 配置信息的访问¶
在 3.2 版本加入。
源代码: Lib/sysconfig
sysconfig 模块提供对 Python 配置信息的访问，例如安装路径列表和与当前平台相关的配置变量。
配置变量¶
Python 发行版包含一个 Makefile 和一个 pyconfig.h 头文件，它们对于构建 Python 二进制文件本身和使用 setuptools 编译的第三方 C 扩展都是必需的。
sysconfig 将这些文件中找到的所有变量放入一个字典中，可以使用 get_config_vars() 或 get_config_var() 访问。
请注意，在 Windows 上，这个集合要小得多。
- sysconfig.get_config_vars(*args)¶
不带参数时，返回一个包含所有与当前平台相关的配置变量的字典。
带参数时，返回一个值列表，这些值是通过在配置变量字典中查找每个参数而获得的。
对于每个参数，如果未找到值，则返回
None。
- sysconfig.get_config_var(name)¶
返回单个变量 name 的值。相当于
get_config_vars().get(name)。如果未找到 name，则返回
None。
使用示例
>>> import sysconfig
>>> sysconfig.get_config_var('Py_ENABLE_SHARED')
0
>>> sysconfig.get_config_var('LIBDIR')
'/usr/local/lib'
>>> sysconfig.get_config_vars('AR', 'CXX')
['ar', 'g++']
安装路径¶
Python 使用的安装方案根据平台和安装选项而异。这些方案存储在 sysconfig 中，其唯一标识符基于 os.name 返回的值。这些方案由包安装程序用于确定将文件复制到何处。
Python 目前支持九种方案
posix_prefix: 用于 Linux 或 macOS 等 POSIX 平台的方案。这是安装 Python 或组件时使用的默认方案。
posix_home: 用于 POSIX 平台的方案，当使用 home 选项时。此方案定义位于特定主目录前缀下的路径。
posix_user: 用于 POSIX 平台的方案，当使用 user 选项时。此方案定义位于用户主目录 (
site.USER_BASE) 下的路径。posix_venv: 用于 POSIX 平台上的
Python 虚拟 环境的方案；默认情况下，它与 posix_prefix 相同。nt: 用于 Windows 的方案。这是安装 Python 或组件时使用的默认方案。
nt_user: 用于 Windows 的方案，当使用 user 选项时。
nt_venv: 用于 Windows 平台上的
Python 虚拟 环境的方案；默认情况下，它与 nt 相同。venv: 一个方案，其值取决于 Python 运行的平台是 posix_venv 还是 nt_venv。
osx_framework_user: 用于 macOS 的方案，当使用 user 选项时。
每个方案本身由一系列路径组成，每个路径都有一个唯一的标识符。Python 目前使用八种路径
stdlib: 包含不特定于平台的标准 Python 库文件的目录。
platstdlib: 包含特定于平台的标准 Python 库文件的目录。
platlib: 用于特定于站点的、特定于平台的文件目录。
purelib: 用于特定于站点的、不特定于平台的文件（“纯”Python）目录。
include: 用于 Python C-API 的非平台特定头文件的目录。
platinclude: 用于 Python C-API 的平台特定头文件的目录。
scripts: 用于脚本文件的目录。
data: 用于数据文件的目录。
用户方案¶
此方案旨在为没有全局 site-packages 目录写入权限或不想安装到其中的用户提供最便捷的解决方案。
文件将安装到 site.USER_BASE 的子目录中（下文写作 userbase）。此方案将纯 Python 模块和扩展模块安装在相同的位置（也称为 site.USER_SITE）。
posix_user¶
路径 |
安装目录 |
|---|---|
stdlib |
|
platstdlib |
|
platlib |
|
purelib |
|
include |
|
scripts |
|
数据 |
|
nt_user¶
路径 |
安装目录 |
|---|---|
stdlib |
|
platstdlib |
|
platlib |
|
purelib |
|
include |
|
scripts |
|
数据 |
|
osx_framework_user¶
路径 |
安装目录 |
|---|---|
stdlib |
|
platstdlib |
|
platlib |
|
purelib |
|
include |
|
scripts |
|
数据 |
|
主目录方案¶
“主目录方案”背后的想法是构建和维护个人 Python 模块库。此方案的名称来源于 Unix 上“主目录”的概念，因为 Unix 用户将其主目录布局类似于 /usr/ 或 /usr/local/ 并非不寻常。任何人都可以使用此方案，无论他们安装的操作系统是什么。
posix_home¶
路径 |
安装目录 |
|---|---|
stdlib |
|
platstdlib |
|
platlib |
|
purelib |
|
include |
|
platinclude |
|
scripts |
|
数据 |
|
前缀方案¶
当您希望使用一个 Python 安装来执行构建/安装（即运行 setup 脚本），但将模块安装到另一个 Python 安装（或看起来像另一个 Python 安装）的第三方模块目录时，“前缀方案”非常有用。如果这听起来有点不寻常，那是因为用户和主目录方案更常用。然而，至少有两种已知情况会用到前缀方案。
首先，许多 Linux 发行版将 Python 放在 /usr 中，而不是更传统的 /usr/local。这完全是合适的，因为在这些情况下，Python 是“系统”的一部分，而不是本地附加组件。但是，如果您从源代码安装 Python 模块，您可能希望它们进入 /usr/local/lib/python2.X 而不是 /usr/lib/python2.X。
另一种可能性是网络文件系统，其中用于写入远程目录的名称与用于读取它的名称不同：例如，访问为 /usr/local/bin/python 的 Python 解释器可能会在 /usr/local/lib/python2.X 中搜索模块，但这些模块必须安装到，例如，/mnt/@server/export/lib/python2.X。
posix_prefix¶
路径 |
安装目录 |
|---|---|
stdlib |
|
platstdlib |
|
platlib |
|
purelib |
|
include |
|
platinclude |
|
scripts |
|
数据 |
|
nt¶
路径 |
安装目录 |
|---|---|
stdlib |
|
platstdlib |
|
platlib |
|
purelib |
|
include |
|
platinclude |
|
scripts |
|
数据 |
|
安装路径函数¶
sysconfig 提供一些函数来确定这些安装路径。
- sysconfig.get_default_scheme()¶
返回当前平台的默认方案名称。
3.10 新增: 此函数以前名为
_get_default_scheme()，并被认为是实现细节。3.11 版变更: 当 Python 从虚拟环境运行时，返回 venv 方案。
- sysconfig.get_preferred_scheme(key)¶
返回由 key 指定的安装布局的首选方案名称。
key 必须是
"prefix"、"home"或"user"。返回值是
get_scheme_names()中列出的方案名称。它可以传递给接受 scheme 参数的sysconfig函数，例如get_paths()。在 3.10 版本加入。
3.11 版变更: 当 Python 从虚拟环境运行且
key="prefix"时，返回 venv 方案。
- sysconfig._get_preferred_schemes()¶
返回一个字典，其中包含当前平台上的首选方案名称。Python 实现者和再分发者可以将他们首选的方案添加到模块级别的全局值
_INSTALL_SCHEMES中，并修改此函数以返回这些方案名称，例如为系统和语言包管理器提供不同的方案，以便通过其中任何一个安装的包不会与另一个安装的包混淆。最终用户不应使用此函数，而应使用
get_default_scheme()和get_preferred_scheme()。在 3.10 版本加入。
- sysconfig.get_path(name[, scheme[, vars[, expand]]])¶
返回与路径 name 对应的安装路径，来自名为 scheme 的安装方案。
name 必须是
get_path_names()返回列表中的值。sysconfig为每个平台存储了与每个路径名称对应的安装路径，并带有待扩展的变量。例如，nt 方案的 stdlib 路径是：{base}/Lib。get_path()将使用get_config_vars()返回的变量来扩展路径。所有变量都为每个平台设置了默认值，因此可以调用此函数并获取默认值。如果提供了 scheme，它必须是
get_scheme_names()返回列表中的值。否则，将使用当前平台的默认方案。如果提供了 vars，它必须是一个变量字典，该字典将更新
get_config_vars()返回的字典。如果 expand 设置为
False，则路径不会使用变量进行扩展。如果未找到 name，则引发
KeyError。
- sysconfig.get_paths([scheme[, vars[, expand]]])¶
返回一个字典，其中包含与安装方案对应的所有安装路径。有关更多信息，请参阅
get_path()。如果未提供 scheme，将使用当前平台的默认方案。
如果提供了 vars，它必须是一个变量字典，该字典将更新用于扩展路径的字典。
如果 expand 设置为 false，则路径不会被扩展。
如果 scheme 不是现有方案，
get_paths()将引发KeyError。
其他函数¶
- sysconfig.get_python_version()¶
以字符串形式返回
MAJOR.MINORPython 版本号。类似于'%d.%d' % sys.version_info[:2]。
- sysconfig.get_platform()¶
返回标识当前平台的字符串。
这主要用于区分平台特定的构建目录和平台特定的构建发行版。通常包括操作系统名称和版本以及架构（由
os.uname()提供），尽管包含的确切信息取决于操作系统；例如，在 Linux 上，内核版本并不是特别重要。返回值的示例
Windows
win-amd64 (AMD64 上的 64 位 Windows，也称为 x86_64、Intel64 和 EM64T)
win-arm64 (ARM64 上的 64 位 Windows，也称为 AArch64)
win32 (所有其他 - 特别是返回 sys.platform)
基于 POSIX 的操作系统
linux-x86_64
macosx-15.5-arm64
macosx-26.0-universal2 (Apple Silicon 或 Intel 上的 macOS)
android-24-arm64_v8a
对于其他非 POSIX 平台，目前只返回
sys.platform。
- sysconfig.is_python_build()¶
如果正在运行的 Python 解释器是从源代码构建的，并且正在从其构建位置运行，而不是从例如运行
make install或通过二进制安装程序安装的位置运行，则返回True。
- sysconfig.parse_config_h(fp[, vars])¶
解析
config.h样式文件。fp 是指向
config.h样式文件的类文件对象。返回一个包含名称/值对的字典。如果将可选字典作为第二个参数传入，则使用它而不是新字典，并使用文件中读取的值进行更新。
- sysconfig.get_config_h_filename()¶
返回
pyconfig.h的路径。
- sysconfig.get_makefile_filename()¶
返回
Makefile的路径。
命令行用法¶
您可以使用 Python 的 -m 选项将 sysconfig 用作脚本
$ python -m sysconfig
Platform: "macosx-10.4-i386"
Python version: "3.2"
Current installation scheme: "posix_prefix"
Paths:
data = "/usr/local"
include = "/Users/tarek/Dev/svn.python.org/py3k/Include"
platinclude = "."
platlib = "/usr/local/lib/python3.2/site-packages"
platstdlib = "/usr/local/lib/python3.2"
purelib = "/usr/local/lib/python3.2/site-packages"
scripts = "/usr/local/bin"
stdlib = "/usr/local/lib/python3.2"
Variables:
AC_APPLE_UNIVERSAL_BUILD = "0"
AIX_GENUINE_CPLUSPLUS = "0"
AR = "ar"
ARFLAGS = "rc"
...
此调用将在标准输出中打印由 get_platform()、get_python_version()、get_path() 和 get_config_vars() 返回的信息。