Модуль community.general.pipx — Управляет приложениями, установленными с помощью pipx

Примечание

Этот модуль является частью коллекции community.general (версия 9.5.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.general.

Чтобы использовать её в playbook, укажите: community.general.pipx.

Новая в community.general 3.8.0

Обзор
Параметры
Атрибуты
Примечания
См. также
Примеры

Обзор

Управление Python-приложениями, установленными в изолированных виртуальных средах с помощью pipx.

Параметры

Параметр	Комментарии
editable boolean добавлено в community.general 4.6.0	Установить проект в режиме редактирования. Варианты: `false` ← (по умолчанию) `true`
executable path	Путь к `pipx` установленной в системе. Если не указано, модуль будет использовать `python -m pipx` для запуска инструмента, используя тот же интерпретатор Python, что и сам ansible.
force boolean	Принудительно изменить виртуальную среду приложения. Подробнее см. `pipx`. Используется только при `state=install`, `state=upgrade`, `state=upgrade_all`, `state=latest`, или `state=inject`. Варианты: `false` ← (по умолчанию) `true`
global boolean добавлено в community.general 9.4.0	Модуль передаст аргумент `--global` в `pipx`, чтобы выполнить действия в глобальном масштабе. `--global` доступен только в `pipx>=1.6.0`, поэтому убедитесь, что у вас есть совместимая версия, когда вы используете этот параметр. Кроме того, в `--global` была исправлена неприятная ошибка в `pipx==1.7.0`, поэтому настоятельно рекомендуется использовать эту версию или более новую. Варианты: `false` ← (по умолчанию) `true`
include_injected boolean	Обновить инжектированные пакеты вместе с приложением. Используется только при `state=upgrade`, `state=upgrade_all`, или `state=latest`. Это используется с `state=upgrade` и `state=latest` с версии community.general 6.6.0. Варианты: `false` ← (по умолчанию) `true`
index_url string	Базовый URL-адрес Python Package Index. Используется только при `state=install`, `state=upgrade`, `state=latest`, или `state=inject`.
inject_packages list / elements=string	Пакеты, которые необходимо инжектировать в существующую виртуальную среду. Используется только при `state=inject`.
install_apps boolean добавлено в community.general 6.5.0	Добавить приложения из инжектированных пакетов. Используется только при `state=inject`. Варианты: `false` ← (по умолчанию) `true`
install_deps boolean	Включить приложения зависимых пакетов. Используется только при `state=install`, `state=latest`, или `state=inject`. Варианты: `false` ← (по умолчанию) `true`
name string	Имя приложения. В документации `pipx` также упоминается как имя виртуальной среды, где будет установлено приложение. Если `name` — это просто имя пакета без указания версии, то это имя используется как имя Python-пакета для установки. Используйте `source` для передачи спецификаций пакетов или установки из URL-адресов или каталогов.
pip_args string добавлено в community.general 4.6.0	Произвольные аргументы для прямой передачи в `pip`.
python string	Версия Python, которая будет использоваться при создании виртуальной среды приложения. Должна быть 3.6+. Используется только при `state=install`, `state=latest`, `state=reinstall`, или `state=reinstall_all`.
source string	Источник пакета. Этот параметр используется при `state=install` или `state=latest`, и он игнорируется при других состояниях. Используйте `source` при установке Python-пакета с указанием версии или из локального пути, URL-адреса VCS или сжатого файла. Значение этого параметра передается как есть в `pipx`. `name` все еще требуется при использовании `source` для определения имени приложения без извлечения пакета из удаленного источника.
spec_metadata path добавлено в community.general 9.4.0	Файл метаданных спецификаций для `state=install_all`. Это содержимое файла обычно генерируется с помощью `pipx list --json`, и его можно получить с помощью community.general.pipx_info с `include_raw=true` и получением содержимого из `raw_output`.

состояние строка	Желаемое состояние приложения. Состояния `present` и `absent` являются псевдонимами состояний `install` и `uninstall`, соответственно. Состояние `latest` эквивалентно выполнению задачи дважды, с состоянием `install` и затем `upgrade`. Оно было добавлено в community.general 5.5.0. Состояния `install_all`, `uninject`, `upgrade_shared`, `pin` и `unpin` доступны только в `pipx>=1.6.0`, убедитесь, что у вас установлена совместимая версия при использовании этого параметра. Эти состояния были добавлены в community.general 9.4.0. Доступные значения: `"present"` `"absent"` `"install"` ← (по умолчанию) `"install_all"` `"uninstall"` `"uninstall_all"` `"inject"` `"uninject"` `"upgrade"` `"upgrade_shared"` `"upgrade_all"` `"reinstall"` `"reinstall_all"` `"latest"` `"pin"` `"unpin"`
приставка строка добавлен в community.general 9.3.0	Дополнительная приставка для имен виртуальных сред и исполняемых файлов. Предупреждение: документация `pipx` указывает, что это экспериментальная функция, которая может быть изменена.
system_site_packages булево добавлен в community.general 6.6.0	Предоставление виртуальной среде приложения доступа к каталогу system site-packages. Используется только при `state=install` или `state=latest`. Доступные значения: `false` ← (по умолчанию) `true`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогноз изменения состояния без модификации целевого объекта.
diff_mode	Поддержка: полная	Возвращает подробности о том, что изменилось (или, возможно, нуждается в изменении в `check_mode` ), при работе в режиме сравнения.

Примечания

Примечание

Эта первая реализация не проверяет, установлено ли указанное ограничение версии. Поэтому при использовании операторов версии модуль pipx всегда будет пытаться выполнить операцию, даже если приложение было установлено ранее. Эта функция будет добавлена в будущем.
Этот модуль требует pipx версии 0.16.2.1 или выше. Начиная с версии community.general 11.0.0, модуль будет требовать pipx>=1.7.0.
Обратите внимание, что pipx требует Python 3.6 или выше.
Этот модуль не устанавливает пакет pipx python, но это можно легко сделать с помощью модуля ansible.builtin.pip.
Этот модуль не требует, чтобы pipx находился в оболочке PATH, но он должен быть загружаем Python как модуль.
Этот модуль будет учитывать переменные среды pipx, такие как, но не ограничиваясь PIPX_HOME и PIPX_BIN_DIR, переданные с помощью ключа Ansible environment.

См. также

C(pipx) справочная страница команды: Справочная страница команды.

Примеры

---
- name: Install tox
  community.general.pipx:
    name: tox

- name: Install tox from git repository
  community.general.pipx:
    name: tox
    source: git+https://github.com/tox-dev/tox.git

- name: Upgrade tox
  community.general.pipx:
    name: tox
    state: upgrade

- name: Reinstall black with specific Python version
  community.general.pipx:
    name: black
    state: reinstall
    python: 3.7

- name: Uninstall pycowsay
  community.general.pipx:
    name: pycowsay
    state: absent

- name: Install multiple packages from list
  vars:
    pipx_packages:
    - pycowsay
    - black
    - tox
  community.general.pipx:
    name: "{{ item }}"
    state: latest
  with_items: "{{ pipx_packages }}"

Авторы

Алексей Знаменский (@russoz)

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/pipx_module.html