a )gw@sddlmZmZmZeZdZdZdZddl Z ddl Z ddl Z ddl Z ddl Z ddlZddlZddlZddlmZdZzddlmZdZWneyd ZeZYn0dd lmZdd lmZmZmZdd lm Z dd l!m"Z"dddZ#e $dZ%e j&e j'e j(e j)e j*e j+e j&dZ,ddZ-ddZ.ddZ/ddZ0ddZ1ddZ2d.dd Z3d!d"Z4d#d$Z5d/d%d&Z6d'd(Z7Gd)d*d*Z8d+d,Z9e:d-kre9dS)0)absolute_importdivisionprint_functiona --- module: pip short_description: Manages Python library dependencies description: - "Manage Python library dependencies. To use this module, one of the following keys is required: C(name) or C(requirements)." version_added: "0.7" options: name: description: - The name of a Python library to install or the url(bzr+,hg+,git+,svn+) of the remote package. - This can be a list (since 2.2) and contain version specifiers (since 2.7). type: list elements: str version: description: - The version number to install of the Python library specified in the I(name) parameter. type: str requirements: description: - The path to a pip requirements file, which should be local to the remote system. File can be specified as a relative path if using the chdir option. type: str virtualenv: description: - An optional path to a I(virtualenv) directory to install into. It cannot be specified together with the 'executable' parameter (added in 2.1). If the virtualenv does not exist, it will be created before installing packages. The optional virtualenv_site_packages, virtualenv_command, and virtualenv_python options affect the creation of the virtualenv. type: path virtualenv_site_packages: description: - Whether the virtual environment will inherit packages from the global site-packages directory. Note that if this setting is changed on an already existing virtual environment it will not have any effect, the environment must be deleted and newly created. type: bool default: "no" version_added: "1.0" virtualenv_command: description: - The command or a pathname to the command to create the virtual environment with. For example C(pyvenv), C(virtualenv), C(virtualenv2), C(~/bin/virtualenv), C(/usr/local/bin/virtualenv). type: path default: virtualenv version_added: "1.1" virtualenv_python: description: - The Python executable used for creating the virtual environment. For example C(python3.5), C(python2.7). When not specified, the Python version used to run the ansible module is used. This parameter should not be used when C(virtualenv_command) is using C(pyvenv) or the C(-m venv) module. type: str version_added: "2.0" state: description: - The state of module - The 'forcereinstall' option is only available in Ansible 2.1 and above. type: str choices: [ absent, forcereinstall, latest, present ] default: present extra_args: description: - Extra arguments passed to pip. type: str version_added: "1.0" editable: description: - Pass the editable flag. type: bool default: 'no' version_added: "2.0" chdir: description: - cd into this directory before running the command type: path version_added: "1.3" executable: description: - The explicit executable or pathname for the pip executable, if different from the Ansible Python interpreter. For example C(pip3.3), if there are both Python 2.7 and 3.3 installations in the system and you want to run pip for the Python 3.3 installation. - Mutually exclusive with I(virtualenv) (added in 2.1). - Does not affect the Ansible Python interpreter. - The setuptools package must be installed for both the Ansible Python interpreter and for the version of Python specified by this option. type: path version_added: "1.3" umask: description: - The system umask to apply before installing the pip package. This is useful, for example, when installing on systems that have a very restrictive umask by default (e.g., "0077") and you want to pip install packages which are to be used by all users. Note that this requires you to specify desired umask mode as an octal string, (e.g., "0022"). type: str version_added: "2.1" extends_documentation_fragment: - action_common_attributes attributes: check_mode: support: full diff_mode: support: none platform: platforms: posix notes: - Python installations marked externally-managed (as defined by PEP668) cannot be updated by pip versions >= 23.0.1 without the use of a virtual environment or setting the environment variable ``PIP_BREAK_SYSTEM_PACKAGES=1``. - The virtualenv (U(http://www.virtualenv.org/)) must be installed on the remote host if the virtualenv parameter is specified and the virtualenv needs to be created. - Although it executes using the Ansible Python interpreter, the pip module shells out to run the actual pip command, so it can use any pip version you specify with I(executable). By default, it uses the pip version for the Ansible Python interpreter. For example, pip3 on python 3, and pip2 or pip on python 2. - The interpreter used by Ansible (see R(ansible_python_interpreter, ansible_python_interpreter)) requires the setuptools package, regardless of the version of pip set with the I(executable) option. requirements: - pip - virtualenv - setuptools author: - Matt Wright (@mattupstate) ad - name: Install bottle python package ansible.builtin.pip: name: bottle - name: Install bottle python package on version 0.11 ansible.builtin.pip: name: bottle==0.11 - name: Install bottle python package with version specifiers ansible.builtin.pip: name: bottle>0.10,<0.20,!=0.11 - name: Install multi python packages with version specifiers ansible.builtin.pip: name: - django>1.11.0,<1.12.0 - bottle>0.10,<0.20,!=0.11 - name: Install python package using a proxy ansible.builtin.pip: name: six environment: http_proxy: 'http://127.0.0.1:8080' https_proxy: 'https://127.0.0.1:8080' # You do not have to supply '-e' option in extra_args - name: Install MyApp using one of the remote protocols (bzr+,hg+,git+,svn+) ansible.builtin.pip: name: svn+http://myrepo/svn/MyApp#egg=MyApp - name: Install MyApp using one of the remote protocols (bzr+,hg+,git+) ansible.builtin.pip: name: git+http://myrepo/app/MyApp - name: Install MyApp from local tarball ansible.builtin.pip: name: file:///path/to/MyApp.tar.gz - name: Install bottle into the specified (virtualenv), inheriting none of the globally installed modules ansible.builtin.pip: name: bottle virtualenv: /my_app/venv - name: Install bottle into the specified (virtualenv), inheriting globally installed modules ansible.builtin.pip: name: bottle virtualenv: /my_app/venv virtualenv_site_packages: yes - name: Install bottle into the specified (virtualenv), using Python 2.7 ansible.builtin.pip: name: bottle virtualenv: /my_app/venv virtualenv_command: virtualenv-2.7 - name: Install bottle within a user home directory ansible.builtin.pip: name: bottle extra_args: --user - name: Install specified python requirements ansible.builtin.pip: requirements: /my_app/requirements.txt - name: Install specified python requirements in indicated (virtualenv) ansible.builtin.pip: requirements: /my_app/requirements.txt virtualenv: /my_app/venv - name: Install specified python requirements and custom Index URL ansible.builtin.pip: requirements: /my_app/requirements.txt extra_args: -i https://example.com/pypi/simple - name: Install specified python requirements offline from a local directory with downloaded packages ansible.builtin.pip: requirements: /my_app/requirements.txt extra_args: "--no-index --find-links=file:///my_downloaded_packages_dir" - name: Install bottle for Python 3.3 specifically, using the 'pip3.3' executable ansible.builtin.pip: name: bottle executable: pip3.3 - name: Install bottle, forcing reinstallation if it's already installed ansible.builtin.pip: name: bottle state: forcereinstall - name: Install bottle while ensuring the umask is 0022 (to ensure other users can use it) ansible.builtin.pip: name: bottle umask: "0022" become: True a cmd: description: pip command used by the module returned: success type: str sample: pip2 install ansible six name: description: list of python modules targeted by pip returned: success type: list sample: ['ansible', 'six'] requirements: description: Path to the requirements file returned: success, if a requirements file was provided type: str sample: "/srv/git/project/requirements.txt" version: description: Version of the package specified in 'name' returned: success, if a name and version were provided type: str sample: "2.5.1" virtualenv: description: Path to the virtualenv returned: success, if a virtualenv path was provided type: str sample: "/tmp/virtualenv" N) LooseVersion) RequirementTF to_native) AnsibleModule is_executablemissing_required_lib)get_best_parsable_locale)PY3z0import setuptools; print(setuptools.__version__)zJimport pkg_resources; print(pkg_resources.get_distribution("pip").version) setuptoolspipz(svn|git|hg|bzr)\+)z>=z<=><==z!=z~=cCs tt|S)z(Test whether a name is a vcs url or not.)rematch_VCS_REnamer7/usr/lib/python3.9/site-packages/ansible/modules/pip.py _is_vcs_url3srcCs|tt S)z?Test whether the name is a package name or a version specifier.)lstrip startswithtupleop_dictkeysrrrr_is_package_name8sr!cCsg}|D]}||dq|}g}g}d}|D]N}t|rZ|sZ|rV|d|g}d|vrfd}|rvd|vrvd}||q2|d||S)aRecover package names as list from user's raw input. :input: a mixed and invalid list of names or version specifiers :return: a list of valid package name eg. input: ['django>1.11.1', '<1.11.3', 'ipaddress', 'simpleproject>1.1.0', '<2.0.0'] return: ['django>1.11.1,<1.11.3', 'ipaddress', 'simpleproject>1.1.0,<2.0.0'] input: ['django>1.11.1,<1.11.3,ipaddress', 'simpleproject>1.1.0,<2.0.0'] return: ['django>1.11.1,<1.11.3', 'ipaddress', 'simpleproject>1.1.0,<2.0.0'] ,F[T])extendsplitr!appendjoin)namestmpZone_lineZ name_partsZ package_namesZ in_bracketsrrrr_recover_package_name=s&   r+cCsV|d}||\}}}|dkr8|jd|||fd|}dd|D}|S)Nz --helprz Could not get output from %s: %smsgcSsg|]}|dr|qS)z--r).0xrrr iz$_get_cmd_options..) run_command fail_jsonstripr&)modulecmdZthiscmdrcstdoutstderrwordsZ cmd_optionsrrr_get_cmd_optionsbs r<c Cs|ddg}t|}|||d}|j|||d\}}}|dkrr|dg}|j||d\}}}|dkrrt||||d|||fS) z.Return results of pip command to get packages.listz--format=freeze)LANGLC_ALL LC_MESSAGES)cwdZenviron_updaterZfreezerA )r r3_failr() r6rchdirZcommandlocaleZlang_envr8outerrrrr _get_packagesms   rIcCsL|D]B}d|vr|d\}}t|}nq||jkr||rdSqdS)z+Return whether or not package is installed.rTF)r&Packagecanonicalize_name package_nameis_satisfied_by)r6ZreqZinstalled_pkgsZ pkg_commandpkgpkg_nameZ pkg_versionrrr _is_presents rPc Cs.d}tr d}d}|dur2tj|r*|}qT|f}n"|durT|durTtrTtjddg}|dur|durg}|D]}||d|}|durnqqn|jdd |dnrtj |d }|d d f}|D]0}tj ||}tj |rt |r|}qq|jd |d d |ddt |t s*|g}|S)N)Zpip2r)Zpip3z-mz pip.__main__Fz"r2z#setup_virtualenv..)Zpyvenvz-m venvz-p%sz_virtualenv_python should not be used when using the venv module or pyvenv as virtualenv_commandr,rB) check_mode exit_jsonshlexr&rrrRrSr]rXr'r<anyr rVrWr4r3rD) r6r[rErGrHr7Zcmd_optsrqr8Zout_venvZerr_venvrrtrsetup_virtualenv s6        rzc@sLeZdZdZedZdddZeddZ dd Z e d d Z d d Z dS)rJzPython distribution package metadata wrapper. A wrapper class for Requirement, which provides API to parse package name, version specifier, test whether a package is already satisfied. z[-_.]+Nc Csd|_||_d|_|r@|}|dr.dnd}|||f}zJt||_|jjdkrrd|vrrd|_d|j_nt |jj|_d|_Wn$t y}z WYd}~n d}~00dS)NFrrrCZ distributerT) _plain_packagerL _requirementrisdigitr(rparseZ project_namerJrK ValueError)selfZ name_stringZversion_string separatorerrr__init__Is    zPackage.__init__cCs|jrt|jjSdS)NF)r{rcr|specsrrrrhas_version_specifier^s zPackage.has_version_specifiercsX|js dSz|jjjddWStyRttfdd|jjDYS0dS)NFT)Z prereleasesc3s$|]\}}t|t|VqdSN)rr)r/opZverversion_to_testrrrulsz*Package.is_satisfied_by..)r{r|Z specifiercontainsAttributeErrorrallr)rrrrrrMds  zPackage.is_satisfied_bycCstjd|S)N-)rJ_CANONICALIZE_REsublowerrrrrrKqszPackage.canonicalize_namecCs|jrt|jS|jSr)r{rr|rLrrrr__str__vs zPackage.__str__)N)__name__ __module__ __qualname____doc__rcompilerrpropertyrrM staticmethodrKrrrrrrJ?s     rJc!Cstdgddgddggdd}tttddt|d td dd tdd tdd td d tdddtd ddtdd tdd tdddtd d td d tdd d ddggddgddggdd}ts|jtdtd|jd}|jd}|jd}|jd}|jd}|jd}|jd}|jd} d} | rD|rDt j || } |rt |t szt |d}Wn.ty|jd ttd!d"Yn0d} |durt |} z|d#kr|dur|jd$d%|durt}d&} d&} | r"t j t j | d'd(s"d} t|| || | \} } t|| |jd}|||}d}| rXt j | d'}d}|r|D] }|rft|rfd}qqfd)d*t|D}|durt|d!kr|jd+d%|d,jr|jd-d%tt|d,||d,<|jd.r*g}|r |d/}d0|vr*|d0d/ |}|r@|t ||r\|d1d2|Dn&|rr|d3|gn|j!dd4gd5|j"r|s|s|d#ks|s|j!dd6t#|||\}}}| |7} | |7} d}|rd7d*| d8D}|$d9rTd:|vsd|vrTd;D]<}||vrt%||| }|dur||| d<|7} q|D]>}t&||||}|dkrz|r|d=krX|rXd}qqX|j!||| | d>d}|s|rt#|||\}}}|j'|||d?\}}}| |7} | |7} |d!kr|d=krd@|vs4d@|vrn|d,kr4t(||| | |d=krHdA|v}n.|dur\dB|v}nt#|||\}} }|| k}|p~| }|j!||||||| | | dC W| durt | n| durt | 0dS)DNinstallZ uninstallz-y-U)rrz--force-reinstall)presentabsentlatestZforcereinstallstrr)typedefaultchoicesr=)relements)rrSrcF)rr virtualenv) staterversion requirementsrrprorq extra_argseditablerErWumaskrrrWT)Z argument_specZrequired_one_ofZmutually_exclusiveZsupports_check_moder)r- exceptionrrrrErzumask must be an octal integer)r-detailsrz)version is incompatible with state=latestr,rhrQZactivatecSsg|] }t|qSr)rJ)r/rNrrrr1r2zmain..z'version' argument is ambiguous when installing multiple package distributions. Please specify version restrictions next to each package in 'name' argument.rzThe 'version' argument conflicts with any version specifier provided along with a package name. Please keep the version specifier, but remove the 'version' argument.rrCz-ecss|]}t|VqdSrrr/prrrrur2zmain..z-rz)No valid name or requirements file found.)rnwarningsrmcSs(g|] }|ds|ds|r|qS)z You are usingzYou should considerr.rrrrr1 r2 z freezerrz%s r)rnr7r9r:) path_prefixrAz not installedzSuccessfully uninstalledzSuccessfully installed) rnr7rrrrrr9r:))dictr r=r HAS_SETUPTOOLSr4r SETUPTOOLS_IMP_ERRrrrRrSr(rZintrdrrVexc_infortempfileZ gettempdirrYrzr_rr+lenrrJr&r'r%rxrwrvrIendswithrlrPr3rD)!Z state_mapr6rrrrrrErr[Z venv_createdZ old_umaskrHrGrr7rZhas_vcsrNZpackagesZ args_listZpkg_cmdZout_pipZerr_piprnZpkg_listrkrjZ is_presentZout_freeze_before_r8Zout_freeze_afterrrrmain|s0                                              r__main__)NN)N);Z __future__rrrrZ __metaclass__Z DOCUMENTATIONZEXAMPLESZRETURNrRrrVroperatorrx tracebacktypesZ#ansible.module_utils.compat.versionrrZ pkg_resourcesrrrb format_excZansible.module_utils._textrZansible.module_utils.basicr r r Z"ansible.module_utils.common.localer Zansible.module_utils.sixr rirrgelegtlteqnerrr!r+r<rIrPr_rUrDrlrzrJrrrrrrs`a        %  ; 6=F