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. Установщики пакетов используют схемы, чтобы определить, куда копировать файлы.

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

• posix_prefix: схема для POSIX-платформ, таких как Linux или macOS. Это схема по умолчанию, используемая при установке Python или его компонента.
• posix_home: схема для POSIX-платформ, используемая при задании параметра home. Эта схема определяет пути, расположенные в пределах указанного префикса home.
• posix_user: схема для POSIX-платформ, используемая при задании параметра user. Эта схема определяет пути, расположенные в домашнем каталоге пользователя (site.USER_BASE).
• posix_venv: схема для Python virtual environments на POSIX-платформах; по умолчанию она совпадает с posix_prefix.
• nt: схема для Windows. Это схема по умолчанию, используемая при установке Python или его компонента.
• nt_user: схема для Windows, используемая при задании параметра user.
• nt_venv: схема для Python virtual environments в Windows; по умолчанию она совпадает с nt.
• venv: схема со значениями из posix_venv или nt_venv в зависимости от платформы, на которой работает Python.
• 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).

Схема home

Идея «схемы home» заключается в том, что вы создаёте и поддерживаете собственный набор модулей Python. Название этой схемы происходит от идеи домашнего каталога в Unix, поскольку пользователь Unix нередко организует домашний каталог по структуре, похожей на /usr/ или /usr/local/. Эту схему может использовать любой пользователь независимо от операционной системы, для которой выполняется установка.

Схема prefix

«Схема prefix» полезна, когда вы хотите использовать одну установку Python для сборки/установки (то есть для запуска скрипта установки), но установить модули в каталог сторонних модулей другой установки Python (или чего-то, что выглядит как другая установка Python). Если это звучит немного необычно, так оно и есть — поэтому сначала описаны схемы пользователя и home. Однако известны как минимум два случая, когда схема prefix может быть полезна.

Во-первых, учтите, что многие дистрибутивы Linux устанавливают Python в /usr, а не в более традиционный каталог /usr/local. Это вполне уместно, поскольку в таких случаях Python является частью «системы», а не локальным дополнением. Однако если вы устанавливаете модули Python из исходного кода, вероятно, вы захотите поместить их в /usr/local/lib/python2.X, а не в /usr/lib/python2.X.

Другой возможный случай — сетевая файловая система, где имя, используемое для записи в удалённый каталог, отличается от имени, используемого для чтения из него: например, интерпретатор Python, доступный как /usr/local/bin/python, может искать модули в /usr/local/lib/python2.X, но эти модули придётся установить, например, в /mnt/@server/export/lib/python2.X.

Функции для работы с путями установки

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 в формате MAJOR.MINOR. Аналогично '%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 как скрипт с параметром Python -m:

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