pip — Управляет зависимостями библиотек Python.
Описание
- Управляет зависимостями библиотек Python. Для использования этого модуля требуется один из следующих ключей:
nameилиrequirements.
Требования (к хосту, на котором выполняется модуль)
- virtualenv
- pip
Параметры
| параметр | обязательно | значение по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| chdir (добавлен в 1.3)
| нет | Перейти в этот каталог перед выполнением команды | ||
| editable (добавлен в 2.0)
| нет | Указать флаг editable. | ||
| executable (добавлен в 1.3)
| нет | Явный исполняемый файл или путь к исполняемому файлу, который будет использоваться для запуска pip для определенной версии Python, установленной в системе. Например, pip-3.3, если в системе установлены Python 2.7 и 3.3, и вы хотите запустить pip для установки Python 3.3. Его нельзя указывать вместе с параметром «virtualenv» (добавлен в 2.1). По умолчанию будет использоваться соответствующая версия для интерпретатора Python, используемого Ansible, например, pip3 для Python 3 и pip2 или pip для Python 2. | ||
| extra_args | нет | Дополнительные аргументы, передаваемые в pip. | ||
| name | нет | Имя Python библиотеки для установки или URL удаленного пакета. Начиная с версии 2.2, вы можете указать список имен. | ||
| requirements | нет | Путь к файлу требований pip, который должен быть локальным для удаленной системы. Путь может быть относительным, если используется параметр chdir. | ||
| state | нет | present |
| Состояние модуля Параметр «forcereinstall» доступен только в Ansible 2.1 и выше. |
| umask (добавлен в 2.1)
| нет | Системный umask, применяемый перед установкой пакета pip. Это полезно, например, при установке на системах, у которых по умолчанию очень жёсткий umask (например, 0077), и вы хотите установить пакеты pip, которые должны использоваться всеми пользователями. Обратите внимание, что вам необходимо указать требуемый режим umask в восьмеричной форме с ведущей цифрой 0 (например, 0077). | ||
| version | нет | Номер версии для установки Python библиотеки, указанной в параметре name | ||
| virtualenv | нет | Необязательный путь к каталогу virtualenv для установки. Его нельзя указывать вместе с параметром «executable» (добавлен в 2.1). Если virtualenv не существует, он будет создан перед установкой пакетов. Необязательные параметры virtualenv_site_packages, virtualenv_command и virtualenv_python влияют на создание virtualenv. | ||
| virtualenv_command | нет | virtualenv | Команда или путь к команде для создания виртуальной среды. Например, pyvenv, virtualenv, virtualenv2, ~/bin/virtualenv, /usr/local/bin/virtualenv. | |
| virtualenv_python (добавлен в 2.0)
| нет | Интерпретатор Python, используемый для создания виртуальной среды. Например, python3.5, python2.7. Если не указано, используется версия Python, используемая для запуска модуля Ansible. Этот параметр не следует использовать, когда virtualenv_command использует pyvenv или модуль -m venv. | ||
| virtualenv_site_packages | нет | нет |
| Указывает, будет ли виртуальная среда наследовать пакеты из глобального каталога site-packages. Обратите внимание, что если это значение изменено в уже существующей виртуальной среде, это не повлияет, среда должна быть удалена и создана заново. |
Примеры
# Install (Bottle) python package.
- pip:
name: bottle
# Install (Bottle) python package on version 0.11.
- pip:
name: bottle
version: 0.11
# Install (MyApp) using one of the remote protocols (bzr+,hg+,git+,svn+). You do not have to supply '-e' option in extra_args.
- pip:
name: svn+http://myrepo/svn/MyApp#egg=MyApp
# Install MyApp using one of the remote protocols (bzr+,hg+,git+).
- pip:
name: git+http://myrepo/app/MyApp
# Install (MyApp) from local tarball
- pip:
name: file:///path/to/MyApp.tar.gz
# Install (Bottle) into the specified (virtualenv), inheriting none of the globally installed modules
- pip:
name: bottle
virtualenv: /my_app/venv
# Install (Bottle) into the specified (virtualenv), inheriting globally installed modules
- pip:
name: bottle
virtualenv: /my_app/venv
virtualenv_site_packages: yes
# Install (Bottle) into the specified (virtualenv), using Python 2.7
- pip:
name: bottle
virtualenv: /my_app/venv
virtualenv_command: virtualenv-2.7
# Install (Bottle) within a user home directory.
- pip:
name: bottle
extra_args: --user
# Install specified python requirements.
- pip:
requirements: /my_app/requirements.txt
# Install specified python requirements in indicated (virtualenv).
- pip:
requirements: /my_app/requirements.txt
virtualenv: /my_app/venv
# Install specified python requirements and custom Index URL.
- pip:
requirements: /my_app/requirements.txt
extra_args: -i https://example.com/pypi/simple
# Install (Bottle) for Python 3.3 specifically,using the 'pip-3.3' executable.
- pip:
name: bottle
executable: pip-3.3
# Install (Bottle), forcing reinstallation if it's already installed
- pip:
name: bottle
state: forcereinstall
# Install (Bottle) while ensuring the umask is 0022 (to ensure other users can use it)
- pip:
name: bottle
umask: 0022
become: True
Примечания
Примечание
- Обратите внимание, что virtualenv (http://www.virtualenv.org/) должен быть установлен на удалённом хосте, если указан параметр virtualenv и virtualenv нужно создать.
- По умолчанию этот модуль будет использовать соответствующую версию pip для интерпретатора, используемого Ansible (например, pip3 при использовании Python 3, pip2 в противном случае)
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Информация о техническом обслуживании
Для получения дополнительной информации о поддержке этого модуля компанией Red Hat, пожалуйста, обратитесь к knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>
Для помощи в разработке модулей, если вы так заинтересованы, пожалуйста, прочитайте Справочную информацию и участие в сообществе, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/pip_module.html
