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

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

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

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

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

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

Например, предположим, что 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, который может выполнять произвольные пользовательские настройки сайта. Как правило, он создаётся системным администратором в каталоге site-packages. Если этот импорт завершается ошибкой ImportError или исключением, являющимся его подклассом, и атрибут исключения name равен 'sitecustomize', то оно игнорируется. Если Python запущен без доступных потоков вывода, как в случае с pythonw.exe в Windows (который используется по умолчанию для запуска IDLE), попытки вывода от sitecustomize игнорируются. Любое другое исключение приводит к безмолвному и, возможно, загадочному завершению процесса.

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

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

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