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-пакетов (sys.base_prefix и sys.base_exec_prefix всегда будут «настоящими» префиксами установки Python). Если в «pyvenv.cfg» (конфигурационный файл загрузочной платформы) ключ «include-system-site-packages» имеет значение, отличное от «true» (без учета регистра), префиксы системного уровня не будут проверяться на наличие site-пакетов; в противном случае они будут проверяться.

Файл конфигурации пути - это файл, имя которого имеет вид 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