New in version 3.2.
Source code: Lib/sysconfig.py
sysconfig module provides access to Python’s configuration
information like the list of installation paths and the configuration variables
relevant for the current platform.
A Python distribution contains a
Makefile and a
header file that are necessary to build both the Python binary itself and
third-party C extensions compiled using
Notice that on Windows, it’s a much smaller set.
With no arguments, return a dictionary of all configuration variables relevant for the current platform.
With arguments, return a list of values that result from looking up each argument in the configuration variable dictionary.
For each argument, if the value is not found, return
Return the value of a single variable name. Equivalent to
If name is not found, return
Example of usage:
>>> 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 uses an installation scheme that differs depending on the platform and on
the installation options. These schemes are stored in
unique identifiers based on the value returned by
Every new component that is installed using
distutils or a
Distutils-based system will follow the same scheme to copy its file in the right
Python currently supports nine schemes:
posix_prefix: scheme for POSIX platforms like Linux or macOS. This is the default scheme used when Python or a component is installed.
posix_home: scheme for POSIX platforms used when a home option is used upon installation. This scheme is used when a component is installed through Distutils with a specific home prefix.
posix_user: scheme for POSIX platforms used when a component is installed through Distutils and the user option is used. This scheme defines paths located under the user home directory.
posix_venv: scheme for
Python virtual environmentson POSIX platforms; by default it is the same as posix_prefix.
nt: scheme for NT platforms like Windows.
nt_user: scheme for NT platforms, when the user option is used.
nt_venv: scheme for
Python virtual environmentson NT platforms; by default it is the same as nt.
venv: a scheme with values from either posix_venv or nt_venv depending on the platform Python runs on.
osx_framework_user: scheme for macOS, when the user option is used.
Each scheme is itself composed of a series of paths and each path has a unique identifier. Python currently uses eight paths:
stdlib: directory containing the standard Python library files that are not platform-specific.
platstdlib: directory containing the standard Python library files that are platform-specific.
platlib: directory for site-specific, platform-specific files.
purelib: directory for site-specific, non-platform-specific files.
include: directory for non-platform-specific header files for the Python C-API.
platinclude: directory for platform-specific header files for the Python C-API.
scripts: directory for script files.
data: directory for data files.
sysconfig provides some functions to determine these paths.
Return a tuple containing all schemes currently supported in
Return the default scheme name for the current platform.
New in version 3.10: This function was previously named
_get_default_scheme()and considered an implementation detail.
Changed in version 3.11: When Python runs from a virtual environment, the venv scheme is returned.
Return a preferred scheme name for an installation layout specified by key.
key must be either
New in version 3.10.
Changed in version 3.11: When Python runs from a virtual environment and
key="prefix", the venv scheme is returned.
Return a dict containing preferred scheme names on the current platform. Python implementers and redistributors may add their preferred schemes to the
_INSTALL_SCHEMESmodule-level global value, and modify this function to return those scheme names, to e.g. provide different schemes for system and language package managers to use, so packages installed by either do not mix with those by the other.
New in version 3.10.
Return a tuple containing all path names currently supported in
- sysconfig.get_path(name[, scheme[, vars[, expand]]])¶
Return an installation path corresponding to the path name, from the install scheme named scheme.
name has to be a value from the list returned by
sysconfigstores installation paths corresponding to each path name, for each platform, with variables to be expanded. For instance the stdlib path for the nt scheme is:
If scheme is provided, it must be a value from the list returned by
get_scheme_names(). Otherwise, the default scheme for the current platform is used.
If vars is provided, it must be a dictionary of variables that will update the dictionary returned by
If expand is set to
False, the path will not be expanded using the variables.
If name is not found, raise a
- sysconfig.get_paths([scheme[, vars[, expand]]])¶
Return a dictionary containing all installation paths corresponding to an installation scheme. See
get_path()for more information.
If scheme is not provided, will use the default scheme for the current platform.
If vars is provided, it must be a dictionary of variables that will update the dictionary used to expand the paths.
If expand is set to false, the paths will not be expanded.
MAJOR.MINORPython version number as a string. Similar to
'%d.%d' % sys.version_info[:2].
Return a string that identifies the current platform.
This is used mainly to distinguish platform-specific build directories and platform-specific built distributions. Typically includes the OS name and version and the architecture (as supplied by ‘os.uname()’), although the exact information included depends on the OS; e.g., on Linux, the kernel version isn’t particularly important.
Examples of returned values:
Windows will return one of:
win-amd64 (64bit Windows on AMD64, aka x86_64, Intel64, and EM64T)
win32 (all others - specifically, sys.platform is returned)
macOS can return:
For other non-POSIX platforms, currently just returns
Trueif the running Python interpreter was built from source and is being run from its built location, and not from a location resulting from e.g. running
make installor installing via a binary installer.
- sysconfig.parse_config_h(fp[, vars])¶
fp is a file-like object pointing to the
A dictionary containing name/value pairs is returned. If an optional dictionary is passed in as the second argument, it is used instead of a new dictionary, and updated with the values read in the file.
Return the path of
Return the path of
You can use
sysconfig as a script with Python’s -m option:
$ 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" ...