Модуль community.general.pipx_info – Получение информации о приложениях, установленных с помощью pipx

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.general.

Для использования в playbook, укажите: community.general.pipx_info.

Новое в community.general 5.6.0

Краткое описание
Параметры
Атрибуты
Примечания
См. также
Примеры
Возвращаемые значения

Краткое описание

Получение подробной информации о приложениях Python, установленных в изолированных виртуальных средах с помощью pipx.

Параметры

Параметр	Комментарии
executable path	Путь к `pipx`, установленному в системе. Если не указан, модуль будет использовать `python -m pipx` для запуска инструмента, используя тот же интерпретатор Python, что и сам Ansible.
global boolean добавлено в community.general 9.3.0	Модуль передаст аргумент `--global` в `pipx`, для выполнения действий в глобальной области видимости. `--global` доступен только в `pipx>=1.6.0`, поэтому убедитесь, что у вас установлена совместимая версия при использовании этого параметра. Кроме того, неприятная ошибка с `--global` была исправлена в `pipx==1.7.0`, поэтому настоятельно рекомендуется использовать эту версию или новее. Варианты: `false` ← (по умолчанию) `true`
include_deps boolean	Включать зависимые пакеты в вывод. Варианты: `false` ← (по умолчанию) `true`
include_injected boolean	Включать внедрённые пакеты в вывод. Варианты: `false` ← (по умолчанию) `true`
include_raw boolean	Возвращает необработанный вывод `pipx list --json`. Необработанный вывод не затрагивается `include_deps` или `include_injected`. Варианты: `false` ← (по умолчанию) `true`
name string	Имя приложения, установленного с помощью `pipx`.

Атрибуты

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

Примечания

Примечание

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

См. также

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

Примеры

---
- name: retrieve all installed applications
  community.general.pipx_info: {}

- name: retrieve all installed applications, include dependencies and injected packages
  community.general.pipx_info:
    include_deps: true
    include_injected: true

- name: retrieve application tox
  community.general.pipx_info:
    name: tox
    include_deps: true

- name: retrieve application ansible-lint, include dependencies
  community.general.pipx_info:
    name: ansible-lint
    include_deps: true

Значения возврата

Общие значения возврата документированы здесь, следующие — поля, уникальные для этого модуля:

Ключ	Описание
application список / элементы=словарь	Список установленных приложений Возвращается: успех
dependencies список / элементы=строка	Зависимости установленного приложения, когда `include_deps=true`. Возвращается: успех Пример: `["virtualenv"]`
injected словарь	Инжектированные пакеты для установленного приложения, когда `include_injected=true`. Возвращается: успех Пример: `{"licenses": "0.6.1"}`
name строка	Имя установленного приложения. Возвращается: успех Пример: `"tox"`
version строка	Версия установленного приложения. Возвращается: успех Пример: `"3.24.0"`
cmd список / элементы=строка	Команда, исполненная для получения списка установленных приложений. Возвращается: успех Пример: `["/usr/bin/python3.10", "-m", "pipx", "list", "--include-injected", "--json"]`
raw_output словарь	Необработанный вывод команды `pipx list`, когда `include_raw=true`. Используется для отладки. Возвращается: успех

Авторы

Алексей Знаменский (@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_info_module.html