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 со специфическим префиксом домашней директории.
• posix_user: схема для POSIX-платформ, используемая, когда компонент устанавливается через Distutils, и используется опция user. Эта схема определяет пути, расположенные в домашней директории пользователя.
• nt: схема для платформ NT, таких как Windows.
• nt_user: схема для платформ NT, когда используется опция user.
• osx_framework_user: схема для macOS, когда используется опция user.

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

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

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

sysconfig.get_scheme_names()

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

sysconfig.get_default_scheme()

Возвращает имя схемы по умолчанию для текущей платформы.

Новое в версии 3.10: Эта функция ранее называлась _get_default_scheme() и считалась деталью реализации.

sysconfig.get_preferred_scheme(key)

Возвращает предпочтительное имя схемы для макета установки, заданного параметром key.

key должен быть либо "prefix", либо "home", либо "user".

Возвращаемое значение — имя схемы, перечисленное в get_scheme_names(). Его можно передать функциям sysconfig, которые принимают аргумент scheme, например get_paths().

Новое в версии 3.10.

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 установлено в ложь, пути не будут расширяться.

Если 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().