ensurepip — Первоначальная установка установщика pip

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

Исходный код: Lib/ensurepip

Пакет ensurepip обеспечивает возможность первоначальной установки установщика pip в существующую установку Python или виртуальную среду. Такой подход к первоначальной установке отражает тот факт, что pip — независимый проект со своим циклом выпуска, а последняя доступная стабильная версия включается в выпуски с исправлениями и новыми функциями эталонного интерпретатора CPython.

В большинстве случаев конечным пользователям Python не потребуется вызывать этот модуль напрямую (так как pip должен устанавливаться по умолчанию), однако это может понадобиться, если при установке Python (или создании виртуальной среды) установка pip была пропущена либо после явного удаления pip.

Примечание

Этот модуль не обращается к интернету. Все компоненты, необходимые для первоначальной установки pip, включены в пакет.

Это необязательный модуль. Если он отсутствует в вашей копии CPython, обратитесь к документации вашего дистрибутива (то есть того, кто предоставил вам Python). Если вы являетесь дистрибьютором, см. раздел Требования к необязательным модулям.

См. также

Установка модулей Python: Руководство для конечных пользователей по установке пакетов Python
PEP 453: Явная первоначальная установка pip в установках Python: Исходное обоснование и спецификация этого модуля.

Доступность: не поддерживается на Android, iOS и WASI.

Этот модуль не поддерживается на мобильных платформах и платформах WebAssembly.

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

Интерфейс командной строки вызывается с помощью переключателя -m интерпретатора.

Самый простой вариант вызова:

python -m ensurepip

Этот вызов установит pip, если он ещё не установлен, и ничего не сделает в противном случае. Чтобы убедиться, что установленная версия pip не старее версии, доступной в ensurepip, передайте параметр --upgrade:

python -m ensurepip --upgrade

По умолчанию pip устанавливается в текущую виртуальную среду (если она активна) или в системные пакеты сайта (если активной виртуальной среды нет). Место установки можно указать с помощью двух дополнительных параметров командной строки:

--root <dir>: Устанавливает pip относительно указанного корневого каталога, а не корня текущей активной виртуальной среды (если она есть) или корневого каталога по умолчанию для текущей установки Python.

--user: Устанавливает pip в каталог пользовательских пакетов сайта, а не глобально для текущей установки Python (этот параметр нельзя использовать в активной виртуальной среде).

По умолчанию будут установлены скрипты pipX и pipX.Y (где X.Y — версия Python, с помощью которой вызывается ensurepip). Устанавливаемые скрипты можно указать с помощью двух дополнительных параметров командной строки:

--altinstall: Если запрошена альтернативная установка, скрипт pipX не будет установлен.

--default-pip: Если запрошена установка «pip по умолчанию», скрипт pip будет установлен в дополнение к двум стандартным скриптам.

Одновременная передача обоих параметров выбора скриптов вызовет исключение.

API модуля

ensurepip предоставляет две функции для программного использования:

ensurepip.version(): Возвращает строку с указанием доступной версии pip, которая будет установлена при первоначальной установке в среду.

ensurepip.bootstrap(root=None, upgrade=False, user=False, altinstall=False, default_pip=False, verbosity=0)

Выполняет первоначальную установку pip в текущую или указанную среду.

root задаёт альтернативный корневой каталог, относительно которого выполняется установка. Если root равен None, для установки используется расположение по умолчанию для текущей среды.

upgrade указывает, следует ли обновить существующую установку более ранней версии pip до доступной версии.

user указывает, следует ли использовать пользовательскую схему установки вместо глобальной.

По умолчанию будут установлены скрипты pipX и pipX.Y (где X.Y — текущая версия Python).

Если задан altinstall, pipX не будет установлен.

Если задан default_pip, pip будет установлен в дополнение к двум стандартным скриптам.

Одновременная установка altinstall и default_pip вызовет ValueError.

verbosity задаёт уровень вывода операции первоначальной установки в sys.stdout.

Вызывает событие аудита ensurepip.bootstrap с аргументом root.

Примечание

Процесс первоначальной установки имеет побочные эффекты для sys.path и os.environ. Вызов интерфейса командной строки в подпроцессе позволяет избежать этих побочных эффектов.

Примечание

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