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

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

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

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. Эта схема определяет пути внутри указанного префикса домашнего каталога.
• 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 версия ядра не имеет особого значения.

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

Windows:

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

ОС на базе POSIX:

• linux-x86_64
• macosx-15.5-arm64
• macosx-26.0-universal2 (macOS на Apple Silicon или Intel)
• android-24-arm64_v8a

Для других платформ, не основанных на 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 как сценарий с параметром 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().