Python site: управление поиском модулей

Расширенные примеры использования модуля site

Пример 1. Получение всех системных и пользовательских site‑packages

import site

# Системные каталоги site-packages
system_sites = site.getsitepackages()
print('System sites:')
for s in system_sites:
    print('  ', s)

# Пользовательский каталог
user_site = site.getusersitepackages()
print('User site:', user_site)

# Флаг включения пользовательского site
print('ENABLE_USER_SITE:', site.ENABLE_USER_SITE)

System sites:
   /usr/lib/python3.10/site-packages
   /usr/lib/python3.10/site-packages/../../lib64/site-packages
User site: /home/user/.local/lib/python3.10/site-packages
ENABLE_USER_SITE: True

Пример 2. Создание и проверка .pth файла

Создадим в каталоге site‑packages файл extras.pth с путями и проверим, что они добавились при следующем запуске.

import os
import sys
import site

# Определим каталог для .pth (первый системный site-packages)
sys_site = site.getsitepackages()[0]
pth_path = os.path.join(sys_site, 'extras.pth')

# Запишем пути
with open(pth_path, 'w') as f:
    f.write('/tmp/mylibs\n')
    f.write('/opt/shared/tools\n')

print('Created', pth_path)

# Теперь перезапустим Python и проверим sys.path
# (в текущей сессии .pth уже обработан, поэтому перезагрузка не требуется)

После перезапуска Python (в новой сессии):

import sys
print(any('/tmp/mylibs' in p for p in sys.path))
print(any('/opt/shared/tools' in p for p in sys.path))

True
True

Примечание: если файл extras.pth содержит ошибку (например, несуществующий путь), он всё равно будет обработан, но предупреждение не выводится. Некорректные строки молча игнорируются.

Пример 3. Использование site.addsitedir() с несколькими каталогами

import site
import sys

# Создадим временные каталоги для примера
import tempfile
import os

temp_dir = tempfile.mkdtemp()
sub1 = os.path.join(temp_dir, 'sub1')
sub2 = os.path.join(temp_dir, 'sub2')
os.makedirs(sub1)
os.makedirs(sub2)

# Поместим .pth файл, который ссылается на подкаталоги
with open(os.path.join(temp_dir, 'paths.pth'), 'w') as f:
    f.write(sub1 + '\n')
    f.write(sub2 + '\n')

# Добавляем родительский каталог через addsitedir
site.addsitedir(temp_dir)

# Проверяем, что sub1 и sub2 появились в sys.path
for p in sys.path:
    if 'sub1' in p or 'sub2' in p:
        print('Found:', p)

Found: /tmp/.../sub1
Found: /tmp/.../sub2

Обратите внимание: сам temp_dir тоже добавляется в sys.path, если он не был там ранее. Порядок добавления: сначала сам каталог, затем пути из .pth файлов.

Пример 4. Файл sitecustomize.py для автоматического добавления пути с логгированием

# Создадим sitecustomize.py в текущем каталоге и вручную разместим его в site-packages
# (для демонстрации просто смоделируем выполнение)

import sys
import site

# Эмуляция: добавляем путь и выводим сообщение
CUSTOM_PATH = '/opt/project/libs'
site.addsitedir(CUSTOM_PATH)

# Проверяем, что путь появился
if any(CUSTOM_PATH in p for p in sys.path):
    print(f'[sitecustomize] Added {CUSTOM_PATH}')
    
# Выводим полный sys.path (первые 10 элементов)
for i, p in enumerate(sys.path[:10]):
    print(f'{i}: {p}')

[sitecustomize] Added /opt/project/libs
0: /usr/lib/python3.10/lib-dynload
1: /usr/lib/python3.10
2: /opt/project/libs
3: /usr/lib/python3.10/site-packages
...

В реальном окружении такой скрипт помещается в каталог site.getsitepackages()[0] и выполняется автоматически при старте Python.

Пример 5. Отключение site для изолированного запуска

# Запуск Python с флагом -S и проверка, что модуль site не импортирован
# В терминале:
# python -S -c "import sys; print('site' in sys.modules)"

# Результат:
# False

# Также без -S site будет загружен:
# python -c "import sys; print('site' in sys.modules)"
# True

Этот приём часто используется для создания «чистого» окружения в докер‑образах или при тестировании кода, который не должен зависеть от внешних путей.