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

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

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

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

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