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

site.USER_SITE: Путь к каталогу пользовательских 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: Путь к базовому каталогу для пользовательских site-packages. Может быть None , если getuserbase() ещё не был вызван. Значение по умолчанию — ~/.local для UNIX и macOS-билдов без фреймворка, ~/Library/Python/X.Y для macOS-билдов с фреймворком и %APPDATA%\Python для Windows. Это значение используется для вычисления каталогов установки скриптов, данных, модулей 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. Чтобы определить, был ли добавлен каталог пользовательских site-packages, следует использовать ENABLE_USER_SITE.

Добавлена в версии 3.2.

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

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

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

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

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

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

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

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

См. также

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