site — Модуль настройки сайта

Исходный код: Lib/site.py

Этот модуль автоматически импортируется во время инициализации. Автоматический импорт можно отключить, используя опцию интерпретатора -S.

Импорт этого модуля добавит пути, специфичные для сайта, в путь поиска модулей и добавит несколько встроенных функций, если не использовалась опция -S. В этом случае этот модуль можно безопасно импортировать без автоматических изменений пути поиска модулей или добавления встроенных функций. Чтобы явно выполнить обычные добавления, специфичные для сайта, вызовите функцию main().

Изменено в версии 3.3: Импорт модуля начал вызывать манипуляции с путями даже при использовании опции -S.

Он начинается с построения до четырёх каталогов из части головы и части хвоста. Для части головы он использует sys.prefix и sys.exec_prefix; пустые части головы пропускаются. Для части хвоста он использует пустую строку, а затем lib/site-packages (в Windows) или lib/pythonX.Y/site-packages (в Unix и macOS). Для каждой уникальной комбинации голова-хвост он проверяет, является ли это существующим каталогом, и если да, добавляет его в sys.path и также проверяет добавленный путь на наличие конфигурационных файлов.

Изменено в версии 3.5: Поддержка каталога «site-python» была удалена.

Если файл с именем «pyvenv.cfg» существует на один каталог выше sys.executable, sys.prefix и sys.exec_prefix устанавливаются на этот каталог, а также проверяется наличие site-packages (sys.base_prefix и sys.base_exec_prefix всегда будут «реальными» префиксами установки Python). Если «pyvenv.cfg» (файл конфигурации загрузки) содержит ключ «include-system-site-packages» с любым значением, кроме «true» (регистронезависимое), пути системных префиксов не будут проверяться на наличие site-packages; в противном случае они будут.

Файл конфигурации пути — это файл, имя которого имеет форму name.pth и существует в одном из четырёх упомянутых каталогов; его содержимое — дополнительные элементы (по одному на строку), которые нужно добавить в sys.path. Несуществующие элементы никогда не добавляются в sys.path, и не проверяется, относится ли элемент к каталогу, а не к файлу. Ни один элемент не добавляется в sys.path более одного раза. Пустые строки и строки, начинающиеся с #, пропускаются. Строки, начинающиеся с import (за которыми следуют пробел или табуляция), выполняются.

Примечание

Выполнимая строка в файле .pth выполняется при каждом запуске Python, независимо от того, будет ли фактически использоваться конкретный модуль. Следовательно, её влияние должно быть минимальным. Основное назначение выполняемых строк — сделать соответствующие модули импортируемыми (загрузка импортных плагинов сторонних разработчиков, настройка PATH и т. д.). Любая другая инициализация должна выполняться при фактическом импорте модуля, если и когда это произойдёт. Ограничение фрагмента кода одной строкой — это преднамеренная мера, чтобы не позволять размещать здесь что-либо более сложное.

Например, пусть sys.prefix и sys.exec_prefix установлены в /usr/local. Библиотека Python X.Y затем установлена в /usr/local/lib/pythonX.Y. Предположим, что у неё есть подкаталог /usr/local/lib/pythonX.Y/site-packages с тремя подподкаталогами foo, bar и spam, и двумя файлами конфигурации путей foo.pth и bar.pth. Предположим, foo.pth содержит следующее:

# foo package configuration

foo
bar
bletch

и bar.pth содержит:

# bar package configuration

bar

Тогда следующие каталоги, специфичные для версии, добавляются в sys.path, в этом порядке:

/usr/local/lib/pythonX.Y/site-packages/bar
/usr/local/lib/pythonX.Y/site-packages/foo

Обратите внимание, что bletch пропущен, потому что он не существует; каталог bar предшествует каталогу foo, потому что bar.pth идёт в алфавитном порядке перед foo.pth; и spam пропущен, потому что он не указан ни в одном файле конфигурации путей.

sitecustomize

После этих манипуляций с путями производится попытка импортировать модуль с именем sitecustomize, который может выполнять произвольные настройки, специфичные для сайта. Обычно он создаётся системным администратором в каталоге site-packages. Если этот импорт терпит неудачу с исключением ImportError или его подклассом, и атрибут исключения name равен 'sitecustomize', он молча игнорируется. Если Python запускается без доступных потоков вывода, как в случае с pythonw.exe в Windows (который используется по умолчанию для запуска IDLE), попытки вывода из sitecustomize игнорируются. Любое другое исключение приводит к молчаливой, а возможно, и таинственной ошибке процесса.

usercustomize

После этого, если ENABLE_USER_SITE равно true, предпринимается попытка импортировать модуль с именем usercustomize, который может выполнять произвольные пользовательские настройки. Этот файл предназначен для создания в пользовательском каталоге site-packages (см. ниже), который является частью sys.path , если это не отключено опцией -s. Если этот импорт терпит неудачу с исключением ImportError или его подклассом, и атрибут исключения name равен 'usercustomize', он молча игнорируется.

Обратите внимание, что для некоторых систем, отличных от Unix, sys.prefix и sys.exec_prefix пустые, и манипуляции с путями пропускаются; однако импорт sitecustomize и usercustomize всё равно предпринимается.

Настройка Readline

На системах, поддерживающих readline, этот модуль также импортирует и настраивает модуль rlcompleter, если Python запущен в интерактивном режиме и без опции -S. По умолчанию включена автодополнения по табуляции и используется ~/.python_history в качестве файла сохранения истории. Для отключения его нужно удалить (или переопределить) атрибут sys.__interactivehook__ в модуле sitecustomize или usercustomize или в файле PYTHONSTARTUP.

Изменено в версии 3.4: Активация rlcompleter и истории была автоматизирована.

Содержание модуля

site.PREFIXES: Список префиксов для каталогов site-packages.

site.ENABLE_USER_SITE: Флаг, показывающий статус каталога user site-packages. True означает, что он включен и был добавлен в sys.path. False означает, что он был отключен по запросу пользователя (с помощью -s или PYTHONNOUSERSITE). None означает, что он был отключен по соображениям безопасности (несовпадение идентификаторов пользователя или группы и эффективного идентификатора) или администратором.

site.USER_SITE: Путь к каталогу user site-packages для выполняемого Python. Может быть None если getusersitepackages() ещё не был вызван. Значение по умолчанию — ~/.local/lib/pythonX.Y/site-packages для UNIX и macOS-сборок без фреймворка, ~/Library/Python/X.Y/lib/python/site-packages для macOS-сборок с фреймворком и %APPDATA%\Python\PythonXY\site-packages для Windows. Этот каталог является каталогом сайта, что означает, что .pth файлы в нём будут обработаны.

site.USER_BASE: Путь к базовому каталогу для user site-packages. Может быть None если getuserbase() ещё не был вызван. Значение по умолчанию — ~/.local для UNIX и macOS-сборок без фреймворка, ~/Library/Python/X.Y для macOS-сборок с фреймворком и %APPDATA%\Python для Windows. Это значение используется Distutils для вычисления каталогов установки скриптов, данных, модулей Python и т.д. для схемы установки пользователя. См. также PYTHONUSERBASE.

site.main(): Добавляет все стандартные каталоги, относящиеся к сайту, в путь поиска модулей. Эта функция вызывается автоматически при импорте этого модуля, если интерпретатор Python не был запущен с флагом -S.

Изменено в версии 3.3: Эта функция раньше вызывалась безусловно.

site.addsitedir(sitedir, known_paths=None): Добавляет каталог в sys.path и обрабатывает его .pth файлы. Обычно используется в sitecustomize или usercustomize (см. выше).

site.getsitepackages(): Возвращает список, содержащий все глобальные каталоги site-packages.

Введено в версии 3.2.

site.getuserbase(): Возвращает путь к каталогу базы пользователя, USER_BASE. Если он ещё не инициализирован, эта функция также инициализирует его, соблюдая PYTHONUSERBASE.

Введено в версии 3.2.

site.getusersitepackages(): Возвращает путь к каталогу site-packages для конкретного пользователя, USER_SITE. Если он ещё не инициализирован, эта функция также инициализирует его, соблюдая USER_BASE. Чтобы определить, был ли каталог user-specific site-packages добавлен в sys.path, следует использовать ENABLE_USER_SITE.

Введено в версии 3.2.

Интерфейс командной строки

Модуль site также предоставляет способ получения каталогов пользователя из командной строки:

$ python3 -m site --user-site
/home/user/.local/lib/python3.3/site-packages

Если он вызывается без аргументов, он выведет содержимое sys.path в стандартный вывод, за которым последует значение USER_BASE и информация о существовании каталога, затем то же самое для USER_SITE и, наконец, значение ENABLE_USER_SITE.

--user-base: Выводит путь к каталогу базы пользователя.

--user-site: Выводит путь к каталогу site-packages пользователя.

Если оба параметра указаны, будут выведены база пользователя и каталог site пользователя (всегда в этом порядке), разделенные os.pathsep.

Если указан любой параметр, скрипт завершится с одним из этих значений: 0 если каталог site-packages пользователя включен, 1 если он был отключен пользователем, 2 если он отключен по соображениям безопасности или администратором, и значение, большее 2, если произошла ошибка.

См. также

PEP 370 — Каталог site-packages для каждого пользователя
Инициализация пути поиска модулей sys.path — Инициализация sys.path.