Vh@ddlmZmZmZeZdZdZdZddl m Z ddl m Z m Z mZddlmZddlmZd ZGd d e Zd Zed k(reyy))absolute_importdivisionprint_functiona module: pipx short_description: Manages applications installed with pipx version_added: 3.8.0 description: - Manage Python applications installed in isolated virtualenvs using pipx. extends_documentation_fragment: - community.general.attributes - community.general.pipx attributes: check_mode: support: full diff_mode: support: full options: state: type: str choices: - present - absent - install - install_all - uninstall - uninstall_all - inject - uninject - upgrade - upgrade_shared - upgrade_all - reinstall - reinstall_all - latest - pin - unpin default: install description: - Desired state for the application. - The states V(present) and V(absent) are aliases to V(install) and V(uninstall), respectively. - The state V(latest) is equivalent to executing the task twice, with state V(install) and then V(upgrade). It was added in community.general 5.5.0. - The states V(install_all), V(uninject), V(upgrade_shared), V(pin) and V(unpin) are only available in C(pipx>=1.6.0), make sure to have a compatible version when using this option. These states have been added in community.general 9.4.0. name: type: str description: - The name of the application and also the name of the Python package being installed. - In C(pipx) documentation it is also referred to as the name of the virtual environment where the application is installed. - If O(name) is a simple package name without version specifiers, then that name is used as the Python package name to be installed. - Starting in community.general 10.7.0, you can use package specifiers when O(state=present) or O(state=install). For example, O(name=tox<4.0.0) or O(name=tox>3.0.27). - Please note that when you use O(state=present) and O(name) with version specifiers, contrary to the behavior of C(pipx), this module honors the version specifier and installs a version of the application that satisfies it. If you want to ensure the reinstallation of the application even when the version specifier is met, then you must use O(force=true), or perhaps use O(state=upgrade) instead. - Use O(source) for installing from URLs or directories. source: type: str description: - Source for the package. This option is used when O(state=install) or O(state=latest), and it is ignored with other states. - Use O(source) when installing a Python package with version specifier, or from a local path, from a VCS URL or compressed file. - The value of this option is passed as-is to C(pipx). - O(name) is still required when using O(source) to establish the application name without fetching the package from a remote source. - The module is not idempotent when using O(source). install_apps: description: - Add apps from the injected packages. - Only used when O(state=inject). type: bool default: false version_added: 6.5.0 install_deps: description: - Include applications of dependent packages. - Only used when O(state=install), O(state=latest), or O(state=inject). type: bool default: false inject_packages: description: - Packages to be injected into an existing virtual environment. - Only used when O(state=inject). type: list elements: str force: description: - Force modification of the application's virtual environment. See C(pipx) for details. - Only used when O(state=install), O(state=upgrade), O(state=upgrade_all), O(state=latest), or O(state=inject). - The module is not idempotent when O(force=true). type: bool default: false include_injected: description: - Upgrade the injected packages along with the application. - Only used when O(state=upgrade), O(state=upgrade_all), or O(state=latest). - This is used with O(state=upgrade) and O(state=latest) since community.general 6.6.0. type: bool default: false index_url: description: - Base URL of Python Package Index. - Only used when O(state=install), O(state=upgrade), O(state=latest), or O(state=inject). type: str python: description: - Python version to be used when creating the application virtual environment. Must be 3.6+. - Only used when O(state=install), O(state=latest), O(state=reinstall), or O(state=reinstall_all). type: str system_site_packages: description: - Give application virtual environment access to the system site-packages directory. - Only used when O(state=install) or O(state=latest). type: bool default: false version_added: 6.6.0 editable: description: - Install the project in editable mode. type: bool default: false version_added: 4.6.0 pip_args: description: - Arbitrary arguments to pass directly to C(pip). type: str version_added: 4.6.0 suffix: description: - Optional suffix for virtual environment and executable names. - B(Warning:) C(pipx) documentation states this is an B(experimental) feature subject to change. type: str version_added: 9.3.0 global: version_added: 9.4.0 spec_metadata: description: - Spec metadata file for O(state=install_all). - This content of the file is usually generated with C(pipx list --json), and it can be obtained with M(community.general.pipx_info) with O(community.general.pipx_info#module:include_raw=true) and obtaining the content from the RV(community.general.pipx_info#module:raw_output). type: path version_added: 9.4.0 requirements: - When using O(name) with version specifiers, the Python package C(packaging) is required. - If the package C(packaging) is at a version lesser than C(22.0.0), it will fail silently when processing invalid specifiers, like C(tox<<<<4.0). author: - "Alexei Znamensky (@russoz)" aX - 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: Install or upgrade tox with dependency group 'docs' community.general.pipx: name: tox source: tox[docs] state: latest - 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 }}" zs version: description: Version of pipx. type: str returned: always sample: "1.7.1" version_added: 10.1.0 )StateModuleHelper) pipx_runnerpipx_common_argspecmake_process_dict)PackageRequirement) ansible_factsc.||Sdj||S)Nz{0}{1})format)namesuffixs j/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/community/general/plugins/modules/pipx.py _make_namers>4DxtV'DDcZeZdZgdZeeddgdedededd edd ed d edd edd edededd edd ededed  Zej eeedddgfdddgfdddgfdddgfdddgfdddgfdddgfdddgfddddgfdddgfdddgfg eddZdZ dZ d Z d!Z d"Z d#ZeZd$Zd%Zd&ZeZd'Zd(Zd)Zd*Zd+Zd,Zd-Zd.Zd/Zd0Zy1)2PipX)rsource index_urlforce installdepsstrinstall)presentabsentr install_all uninstall uninstall_allinjectuninjectupgradeupgrade_shared upgrade_all reinstall reinstall_alllatestpinunpin)typedefaultchoices)r*boolF)r*r+list)r*elementspath)staterr install_apps install_depsinject_packagesrinclude_injectedrpythonsystem_site_packageseditablepip_argsr spec_metadatar1rrrr:rrr"r%r'r r4r(r))rT) argument_spec required_if required_bysupports_check_modectd}|jd|j\}}|j|S|j Dcic]\}}||jk(s||c}}Scc}}w)NT)r5z _list global)output_process)r runnerrunapp_nameitems)selfr@ installeddummykvs r_retrieve_installedzPipX._retrieve_installedsj*DA;;~n;UYY[ 5 ==  !*!2IAa4==6H1IIIs A3*A3c|jjr|jjg|_n(t|jdg}|ddddg|_t |j|j|_t|j|jj}|j|_ |j|_ t|j|jj|_|jjd|j!dd|j d 5}|j#\}}}|j%|j_dddy#1swYyxYw) Nr6) gather_subset executablez-mpipx applicationT)changediffversion)varsrMcommandr modulerrAr r parsed_name requirement parsed_reqrrrCsetrJrBstriprR)rEfactspkg_reqctxrcouterrs r__init_module__zPipX.__init_module__s 99   II001DL!$++hZHE!(OL94HDL!$++t||< $T[[$))..A"..!--"4#3#3TYY5E5EF  mT%=%=%?SW X [[ # ,s779LBS # DII  , , ,s :4E77FcB|j|j_yN)rJrSrO)rEs r__quit_module__zPipX.__quit_module__/s $ 8 8 : rc|j|j_|j|j_|j |j_|jj d|jdy)Nrun_info) verbosity) results_outrSstdout results_errstderrcmdrYrfrEr]s r_capture_resultszPipX._capture_results2sK?? ??   j#,,! .>?D0$G +3T"%%c* + + ! + +s $B  Bc|t|jj|jj}|jjs |j dj |d|_|jdd5}|j||j|dddy#1swYyxYw)Nz3Trying to reinstall a non-existent application: {0}Tzstate global name pythonrrr) rrSrrrOrr rwrArBrors rstate_reinstallzPipX.state_reinstallks$))..$))*:*:;yy$$ MMOVVW[\ ] [[3T[ J 'c GGG   ! !# & ' ' 's $B22B;ct|jj|jj}|jjs |j dj ||jjrd|_|jdd5}|j||j|dddy#1swYyxYw)Nz>Trying to inject packages into a non-existent application: {0}Tz]state global index_url install_apps install_deps force editable pip_args name inject_packagesrrrrrs r state_injectzPipX.state_injectts$))..$))*:*:;yy$$ MMZaabfg h 99??DL [[xKO[P 'TW GGG   ! !# & ' ' 'rcnt|jj|jj}|jjs |j dj ||jdd5}|j||j|dddy#1swYyxYw)Nz@Trying to uninject packages into a non-existent application: {0}z!state global name inject_packagesTrrr) rrSrrrOrr rArBrors rstate_uninjectzPipX.state_uninject~s$))..$))*:*:;yy$$ MM\ccdhi j [[$B++B4c|jdd5}|j|j|dddy#1swYyxYw)Nz state globalTrrrArBrorns rstate_uninstall_allzPipX.state_uninstall_alls@ [[[ > '# GGI  ! !# & ' ' ' "?Ac|jdd5}|j|j|dddy#1swYyxYw)Nzstate global pythonTrrrrns rstate_reinstall_allzPipX.state_reinstall_allsA [[.[ E ' GGI  ! !# & ' ' 'rc|jjrd|_|jdd5}|j |j |dddy#1swYyxYw)NTz#state global include_injected forcerr)rSrrwrArBrorns rstate_upgrade_allzPipX.state_upgrade_allsU 99??DL [[>PT[ U 'Y\ GGI  ! !# & ' ' 's "AA%c|jdd5}|j|j|dddy#1swYyxYw)Nzstate global pip_argsTrrrrns rstate_upgrade_sharedzPipX.state_upgrade_sharedsA [[0$[ G '3 GGI  ! !# & ' ' 'rc|jjr|jjrsd|_d}|j |d5}|j d|jj |jjg|j|ddd|j dd5}|j d|j|dddy#1swYIxYw#1swYyxYw) NTrqrrr)r1rtrr")r1) rSrOrrwrArBrrro)rErzr]s r state_latestzPipX.state_latestsyy$$ DLFJZ> +#idiinndiiFVFV5WX%%c* +[[_qu[ v 'z} GG)G $  ! !# & ' '  + + ' 's AC 3$C, C),C5c|jdd5}|j|j|dddy#1swYyxYwNrTrrrrns r state_pinzPipX.state_pinA [[,d[ C 's GGI  ! !# & ' ' 'rc|jdd5}|j|j|dddy#1swYyxYwrrrns r state_unpinzPipX.state_unpinrrN)__name__ __module__ __qualname__ output_paramsdictr;updaterrUuse_old_vardictrJrardror{ state_presentr}rr state_absentrrrrrrrrrrrrrrsKMy u vu5vu5&59.659E"!vu=6515!''M*,- # i& * i& * mo%6 7 h ) kF8 , i& * kF8 , h ) h): ; < efX & gx (   !%F(OJ,&;= '."M' '+#L'''' ' '' '' 'rrc,tjyrc)rexecuterrrmainrs LLNr__main__N) __future__rrrr* __metaclass__ DOCUMENTATIONEXAMPLESRETURNHansible_collections.community.general.plugins.module_utils.module_helperr?ansible_collections.community.general.plugins.module_utils.pipxrrr Bansible_collections.community.general.plugins.module_utils.pkg_reqr !ansible.module_utils.facts.compatr rrrrrrrrslA@ U n* X ga;EL' L'^ zFr