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

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля могут потребоваться дополнительные зависимости; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.general.pipx_info.

Добавлено в community.general 5.6.0

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

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

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

Требования

На хосте, на котором выполняется этот модуль, должны быть установлены следующие компоненты.

Для этого модуля требуется pipx версии 1.7.0 или выше.
Обратите внимание: для pipx версии 1.7.0 требуется Python 3.8 или выше.
Обратите внимание: для pipx версии 1.8.0 требуется Python 3.9 или выше.

Параметры

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

Атрибуты

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

Примечания

Примечание

Этот модуль не устанавливает пакет Python pipx, однако его можно легко установить с помощью модуля ansible.builtin.pip.
Для этого модуля не требуется, чтобы pipx находился в переменной оболочки PATH, но он должен быть доступен Python как модуль, то есть команда python -m pipx должна работать.
Этот модуль учитывает переменные окружения pipx, включая, помимо прочего, PIPX_HOME и PIPX_BIN_DIR, переданные с помощью ключевого слова Ansible environment.
Этот модуль отключает эмодзи в выводе команд pipx, чтобы уменьшить загромождение. В версии pipx 1.8.0 переменная окружения USE_EMOJI была переименована в PIPX_USE_EMOJI. Для совместимости с обеими версиями, начиная с community.general 11.4.0, модуль присваивает им обеим значение 0, чтобы отключить эмодзи.

См. также

Страница руководства по команде 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"`
pinned логический добавлено в community.general 10.0.0	Закреплено ли установленное приложение. При использовании `pipx<=1.6.0` возвращается `null`. Возвращается: при успехе Пример: `{"pinned": true}`
version строка	Версия установленного приложения. Возвращается: при успехе Пример: `"3.24.0"`
cmd список / элементы=строка	Команда, выполненная для получения списка установленных приложений. Возвращается: при успехе Пример: `["/usr/bin/python3.10", "-m", "pipx", "list", "--include-injected", "--json"]`
raw_output словарь	Необработанный вывод команды `pipx list`, если `include_raw=true`. Используется для отладки. Возвращается: при успехе
version строка добавлено в community.general 10.1.0	Версия pipx. Возвращается: всегда Пример: `"1.7.1"`

Авторы

Alexei Znamensky (@russoz)

Ссылки на коллекцию

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