diff --git a/changelogs/fragments/10874-pipx-180.yml b/changelogs/fragments/10874-pipx-180.yml new file mode 100644 index 0000000000..dd776827e8 --- /dev/null +++ b/changelogs/fragments/10874-pipx-180.yml @@ -0,0 +1,2 @@ +minor_changes: + - pipx module_utils - use ``PIPX_USE_EMOJI`` to disable emojis in the output of ``pipx`` 1.8.0 (https://github.com/ansible-collections/community.general/pull/10874). diff --git a/plugins/doc_fragments/pipx.py b/plugins/doc_fragments/pipx.py index dde13f6dd3..e019ba7672 100644 --- a/plugins/doc_fragments/pipx.py +++ b/plugins/doc_fragments/pipx.py @@ -23,12 +23,18 @@ options: itself. type: path requirements: - - This module requires C(pipx) version 1.7.0 or above. Please note that C(pipx) 1.7.0 requires Python 3.8 or above. + - This module requires C(pipx) version 1.7.0 or above. + - Please note that C(pipx) 1.7.0 requires Python 3.8 or above. + - Please note that C(pipx) 1.8.0 requires Python 3.9 or above. notes: - This module does not install the C(pipx) python package, however that can be easily done with the module M(ansible.builtin.pip). - - This module does not require C(pipx) to be in the shell C(PATH), but it must be loadable by Python as a module. + - This module does not require C(pipx) to be in the shell C(PATH), but it must be loadable by Python as a module, meaning + that C(python -m pipx) must work. - This module honors C(pipx) environment variables such as but not limited to E(PIPX_HOME) and E(PIPX_BIN_DIR) passed using the R(environment Ansible keyword, playbooks_environment). + - This module disabled emojis in the output of C(pipx) commands to reduce clutter. In C(pipx) 1.8.0, the environment variable + E(USE_EMOJI) was renamed to E(PIPX_USE_EMOJI) and for compatibility with both versions, starting in community.general + 11.4.0, this module sets them both to C(0) to disable emojis. seealso: - name: C(pipx) command manual page description: Manual page for the command. diff --git a/plugins/module_utils/pipx.py b/plugins/module_utils/pipx.py index bb37712c21..e877624e1f 100644 --- a/plugins/module_utils/pipx.py +++ b/plugins/module_utils/pipx.py @@ -64,7 +64,7 @@ def pipx_runner(module, command, **kwargs): module, command=command, arg_formats=arg_formats, - environ_update={'USE_EMOJI': '0'}, + environ_update={'USE_EMOJI': '0', 'PIPX_USE_EMOJI': '0'}, check_rc=True, **kwargs )