community.general/plugins/module_utils/pipx.py

# -*- coding: utf-8 -*-
# Copyright (c) 2022, Alexei Znamensky <russoz@gmail.com>
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later

from __future__ import absolute_import, division, print_function
__metaclass__ = type

from ansible_collections.community.general.plugins.module_utils.cmd_runner import CmdRunner, cmd_runner_fmt as fmt


pipx_common_argspec = {
    "global": dict(type='bool', default=False),
    "executable": dict(type='path'),
}


_state_map = dict(
    install='install',
    install_all='install-all',
    present='install',
    uninstall='uninstall',
    absent='uninstall',
    uninstall_all='uninstall-all',
    inject='inject',
    uninject='uninject',
    upgrade='upgrade',
    upgrade_shared='upgrade-shared',
    upgrade_all='upgrade-all',
    reinstall='reinstall',
    reinstall_all='reinstall-all',
    pin='pin',
    unpin='unpin',
)


def pipx_runner(module, command, **kwargs):
    arg_formats = dict(
        state=fmt.as_map(_state_map),
        name=fmt.as_list(),
        name_source=fmt.as_func(fmt.unpack_args(lambda n, s: [s] if s else [n])),
        install_apps=fmt.as_bool("--include-apps"),
        install_deps=fmt.as_bool("--include-deps"),
        inject_packages=fmt.as_list(),
        force=fmt.as_bool("--force"),
        include_injected=fmt.as_bool("--include-injected"),
        index_url=fmt.as_opt_val('--index-url'),
        python=fmt.as_opt_val('--python'),
        system_site_packages=fmt.as_bool("--system-site-packages"),
        _list=fmt.as_fixed(['list', '--include-injected', '--json']),
        editable=fmt.as_bool("--editable"),
        pip_args=fmt.as_opt_eq_val('--pip-args'),
        suffix=fmt.as_opt_val('--suffix'),
    )
    arg_formats["global"] = fmt.as_bool("--global")

    runner = CmdRunner(
        module,
        command=command,
        arg_formats=arg_formats,
        environ_update={'USE_EMOJI': '0'},
        check_rc=True,
        **kwargs
    )
    return runner