sysconfig — Предоставление доступа к конфигурационной информации Python

Переменные конфигурации

Распространение Python содержит файл заголовков Makefile и pyconfig.h, которые необходимы для сборки как самого бинарного файла Python, так и сторонних расширений C, скомпилированных с использованием distutils.

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.

Каждый новый компонент, устанавливаемый с помощью distutils или системы на основе Distutils, будет следовать той же схеме, чтобы скопировать свои файлы в правильные места.

Python в настоящее время поддерживает девять схем:

• posix_prefix: схема для платформ POSIX, таких как Linux или macOS. Это основная схема, используемая при установке Python или компонента.
• posix_home: схема для платформ POSIX, используемая при использовании опции home при установке. Эта схема используется при установке компонента через Distutils со специфическим префиксом home.
• posix_user: схема для платформ POSIX, используемая при установке компонента через Distutils с использованием опции user. Эта схема определяет пути, расположенные в домашнем каталоге пользователя.
• posix_venv: схема для Python virtual environments на платформах POSIX; по умолчанию она такая же, как posix_prefix.
• nt: схема для платформ NT, таких как Windows.
• nt_user: схема для платформ NT, когда используется опция user.
• nt_venv: схема для Python virtual environments на платформах NT; по умолчанию она такая же, как nt.
• venv: схема со значениями из posix_venv или nt_venv в зависимости от платформы, на которой работает Python.
• osx_framework_user: схема для macOS, когда используется опция user.

Каждая схема состоит из ряда путей, и каждый путь имеет уникальный идентификатор. Python в настоящее время использует восемь путей:

• stdlib: каталог, содержащий стандартные файлы библиотеки Python, которые не зависят от платформы.
• platstdlib: каталог, содержащий стандартные файлы библиотеки Python, которые зависят от платформы.
• platlib: каталог для файлов, специфичных для сайта и платформы.
• purelib: каталог для файлов, специфичных для сайта, но не зависящих от платформы.
• include: каталог для файлов заголовков, не зависящих от платформы, для Python C-API.
• platinclude: каталог для файлов заголовков, специфичных для платформы, для Python C-API.
• scripts: каталог для файлов сценариев.
• data: каталог для файлов данных.

sysconfig предоставляет некоторые функции для определения этих путей.

sysconfig.get_scheme_names()

Возвращает кортеж, содержащий все схемы, которые в настоящее время поддерживаются в 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(). Его можно передать в функции sysconfig, принимающие аргумент scheme, такие как 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_names()

Возвращает кортеж, содержащий все имена путей, которые в настоящее время поддерживаются в sysconfig.

sysconfig.get_path(name[, scheme[, vars[, expand]]])

Возвращает путь установки, соответствующий имени пути name, из схемы установки с именем scheme.

name должен быть значением из списка, возвращаемого get_path_names().

sysconfig хранит пути установки, соответствующие каждому имени пути, для каждой платформы, со переменными, которые необходимо расширить. Например, путь stdlib для схемы nt: {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()

Возвращает номер версии Python в виде строки. Аналогично '%d.%d' % sys.version_info[:2].

sysconfig.get_platform()

Возвращает строку, идентифицирующую текущую платформу.

Эта строка используется в основном для различения каталогов скомпилированных файлов и скомпилированных дистрибутивов, специфичных для платформы. Обычно включает имя и версию ОС, а также архитектуру (как предоставляется ‘os.uname()’), хотя точная информация зависит от ОС; например, на Linux версия ядра не так важна.

Примеры возвращаемых значений:

• linux-i586
• linux-alpha (?)
• solaris-2.6-sun4u

Windows вернёт одно из следующих значений:

• win-amd64 (64-битная Windows на AMD64, также известная как x86_64, Intel64 и EM64T)
• win32 (все остальные — конкретно, возвращается sys.platform)

macOS может вернуть:

• macosx-10.6-ppc
• macosx-10.4-ppc64
• macosx-10.3-i386
• macosx-10.4-fat

Для других платформ, не являющихся POSIX, в настоящее время просто возвращает sys.platform.

sysconfig.is_python_build()

Возвращает True, если интерпретатор Python был скомпилирован из исходного кода и запускается из своего каталога, а не из каталога, полученного, например, запуском make install или установкой через установщик библиотек.

sysconfig.parse_config_h(fp[, vars])

Парсит файл в формате config.h.

fp — это файлоподобный объект, указывающий на файл в формате config.h.

Возвращается словарь, содержащий пары имя/значение. Если в качестве второго аргумента передаётся необязательный словарь, он используется вместо нового словаря и обновляется значениями, считанными из файла.

sysconfig.get_config_h_filename()

Возвращает путь к pyconfig.h.

sysconfig.get_makefile_filename()

Возвращает путь к Makefile.

Использование sysconfig как скрипта

Вы можете использовать sysconfig как скрипт с помощью опции -m Python:

$ 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().