o Paj @sdZddlZddlZddlZddlZddlZddlZddlZddlZddl Z ddl Z ddl m Z ddlmZmZmZmZddlZddlmZmZddlmZddlZddlmZmZddlmZmZdd l m!Z!m"Z"dd lm#Z#dd l$m%Z%dd l&m'Z'dd l(m)Z)m*Z*m+Z+m,Z,ddl-m.Z.ddl/m0Z0e1e2Z3ee4gee4fZ5d^ddZ6e7dZ8e7de4ej9de4ej:dZ;e;e+dddd7Z;edej?de=dZ@Gd d!d!ejAZBGd"d#d#ZCd$ee4e4fdee4fd%d&ZDd$ee4e4fdee4fd'd(ZEd)ejFde#fd*d+ZGd,ejHddfd-d.ZId,ejHddfd/d0ZJd1ejKddfd2d3ZLd4e5ddfd5d6ZMd4e5ddfd7d8ZNd1ejKddfd9d:ZOd4e5ddfd;d<ZPd1ejKddfd=d>ZQd4e5ddfd?d@ZRd1ejKddfdAdBZSd1ejKddfdCdDZTd1ejKddfdEdFZUd4e5ddfdGdHZVd1ejKddfdIdJZWdejHfdKdLZXdMee dNeYddfdOdPZZde fdQdRZ[dSe\ddfdTdUZ]d)ejFddfdVdWZ^dXejFddfdYdZZ_de#fd[d\Z`e2d]kreae`dSdS)_z"The command line interface to pipxN)Path)AnyCallableDictList)InvalidRequirement Requirementcanonicalize_name)commands constants) hide_cursor show_cursor)boldgreen)ExitCode)hazard)DEFAULT_PYTHON) PipxErrormkdir pipx_wraprmdir) VenvContainer) __version__returncCs ttdSN)printrrr+/usr/lib/python3/dist-packages/pipx/main.py print_version&s rz The package name or specific installation source passed to pip. Runs `pip install -U SPEC`. For example `--spec mypackage==2.0.0` or `--spec git+https://github.com/user/repo.git@branch` z Install and execute apps from Python packages. Binaries can either be installed globally into isolated Virtual Environments or run directly in a temporary Virtual Environment. Virtual Environment location is z%. Symlinks to apps are placed in z. a optional environment variables: PIPX_HOME Overrides default pipx location. Virtual Environments will be installed to $PIPX_HOME/venvs. PIPX_BIN_DIR Overrides location of app installations. Apps are symlinked or copied here. USE_EMOJI Overrides emoji behavior. Default value varies based on platform. PIPX_DEFAULT_PYTHON Overrides default python used for commands. z T)subsequent_indent keep_newlinesPIPX__DOC_DEFAULT_PYTHONa The install command is the preferred way to globally install apps from python packages on your system. It creates an isolated virtual environment for the package, then ensures the package's apps are accessible on your $PATH. The result: apps you can run from anywhere, located in packages you can cleanly upgrade or uninstall. Guaranteed to not have dependency version conflicts or interfere with your OS's python packages. 'sudo' is not required to do this. pipx install PACKAGE_NAME pipx install --python PYTHON PACKAGE_NAME pipx install VCS_URL pipx install ./LOCAL_PATH pipx install ZIP_FILE pipx install TAR_GZ_FILE The PACKAGE_SPEC argument is passed directly to `pip install`. The default virtual environment location is z and can be overridden by setting the environment variable `PIPX_HOME` (Virtual Environments will be installed to `$PIPX_HOME/venvs`). The default app location is z and can be overridden by setting the environment variable `PIPX_BIN_DIR`. The default python executable used to install a package is zZ and can be overridden by setting the environment variable `PIPX_DEFAULT_PYTHON`. c@s&eZdZdededeefddZdS)LineWrapRawTextHelpFormattertextwidthrcCs|jd|}t||S)N )_whitespace_matchersubstriptextwrapwrap)selfr$r%rrr _split_linesps z)LineWrapRawTextHelpFormatter._split_linesN)__name__ __module__ __qualname__strintrr-rrrrr#osr#c@s8eZdZdeddfddZdededeefdd ZdS) InstalledVenvsCompletervenv_containerrNcCsddt|D|_dS)NcSsg|]}t|jqSr)r1name).0prrr wsz4InstalledVenvsCompleter.__init__..)sortediter_venv_dirspackages)r,r4rrr__init__vsz InstalledVenvsCompleter.__init__prefixkwargsc sfdd|jDS)Ncs2g|]}|tr|tdqSr) startswithr lenr6xr=rrr8zs  z/InstalledVenvsCompleter.use..)r;)r,r=r>rrCruseys zInstalledVenvsCompleter.use) r.r/r0rr<r1rrrDrrrrr3usr3 parsed_argscCsVg}|dr|d|dg7}|dr|t|dd7}|dr)|dg7}|S)N index_url --index-urlpip_argseditable --editable)getshlexsplit)rErHrrr get_pip_argss    rOcCsg}|dr |dg7}|S)Nsystem_site_packages--system-site-packages)rL)rE venv_argsrrr get_venv_argss  rSargsc CsTd|vr|jnd}tt|}tt|}ttj}d|vrX|j}tj |j r,t dd|vrK|j durKtj |j j rKd|j vrK|j d||_ ||}td|d|vrdd d |jD}|jd krd|vru|j duru|j n|jd }z t|jd j} Wnty|jd } Ynw|j } t| ||jd d|j|||j|| td S|jdkrtjdd|jtj|j||||j |j!|j"d S|jdkrtj#|d|j$|||j%|j!|j dS|jdkrtj&||||j'|j dS|jdkrtj(|||j'||j dS|jdkrt)||j'|j*S|jdkr t+|tj|S|jdkr.t,|tj|S|jdkr?tj-|tj|j|dS|jdkrQtj.|tj|j||dS|jdkrh|s^t dt/|||j0|jS|jdkrztj1|j d WSt2y} ztj3d!d"d#t t4| dd$d} ~ ww|jd%krt5tj6td St d&|j)'NverboseFpackagezPackage cannot be a urlspecz#egg=z Virtual Environment location is skipcSsg|]}t|qSrr rArrrr8sz$run_pipx_command..runrinstall)forceinclude_dependenciessuffixinject)rU include_appsr]r\upgrade)include_injectedr\ upgrade-all)rbrXr\list uninstall uninstall-all reinstall)venv_dir local_bin_dirpythonrU reinstall-all)rXrunpipz)Developer error: venv_dir is not defined. ensurepath)r\Uncaught Exception:Texc_info) wrap_message completionszUnknown command )7rUrOvarsrSrr PIPX_LOCAL_VENVSrVurllibparseurlparseschemerrW get_venv_dirloggerinforXcommand app_with_argsrr5rno_cacher rYrj pypackagesrr[ package_spec LOCAL_BIN_DIRr\ include_depsr^r_ dependenciesr`rarb upgrade_all list_packagesjsonre uninstall_allrg reinstall_allrun_pippipargsensure_pipx_paths Exceptiondebugr1rcompletion_instructions) rTrUrHrRr4rVrh skip_listpackage_or_url package_name use_cacheerrrrun_pipx_commands                     rparsercCsD|jdddd|jdddd|jd d d dd |jd dddS)NrQ store_truezDGive the virtual environment access to the system site-packages dir.actionhelprGz-iz Base URL of Python Package IndexrrKz-ez"Install a project in editable moderrz --pip-argszHArbitrary pip arguments to pass directly to pip install/upgrade commands add_argumentrrrradd_pip_venv_argss  rcCs|jdddddS)Nz--include-depsz"Include apps of dependent packagesrrrrrrradd_include_dependencies+s r subparserscCst|jddttd}|jdddt||jddd |jd d dd d |jdddd|jdtddt|dS)Nr[zInstall a package)rformatter_class descriptionrz%package name or pip installation specr --verboserr--force-f=Modify existing virtual environment and files in PIPX_BIN_DIRrz--suffixrIz}Optional suffix for virtual environment and executable names. NOTE: The suffix feature is experimental and subject to change.defaultr--pythonzlThe Python executable used to create the Virtual Environment and run the associated app/apps. Must be v3.6+.) add_parserr#INSTALL_DESCRIPTIONrrrrrr7rrr _add_install1s4 rvenv_completercCst|jdddd}||jddd_|jdd d d |jd d ddt|t||jddd dd|jdd ddS)Nr_z5Install packages into an existing Virtual EnvironmentzBInstalls packages to an existing pipx-managed virtual environment.rrrVzDName of the existing pipx-managed Virtual Environment to inject intorr+z\the packages to inject into the Virtual Environment--either package name or pip package spec)nargsrz--include-appsrz2Add apps from the injected packages onto your PATHrrrrrr)rr completerrrrrr7rrr _add_injectTs<rcCsX|jdddd}||d_|jdddd |jd d dd d t||jd dddS)NrazUpgrade a packagezbUpgrade a package in a pipx-managed Virtual Environment by running 'pip install --upgrade PACKAGE'rrV--include-injectedr>Also upgrade packages injected into the main app's environmentrrrrrr)rrrrrrrr _add_upgradess& rcCsV|jdddd}|jdddd|jd d gd d |jd dddd|jddddS)NrczGUpgrade all packages. Runs `pip install -U ` for each package.zbUpgrades all packages within their virtual environments by running 'pip install --upgrade PACKAGE'rrrrr--skiprskip these packagesrrrrrrrrrrrrrr_add_upgrade_alls$rcCs.|jdddd}||d_|jddddS) NrezUninstall a packagezbUninstalls a pipx-managed Virtual Environment by deleting it and any files that point to its apps.rrVrrr)rrrrrrr_add_uninstalls rcCs"|jdddd}|jddddS)NrfzUninstall all packagesz#Uninstall all pipx-managed packagesrrrrrrrrr_add_uninstall_alls rcCsF|jdtdtdd}||d_|jdtdd|jd d d dS) NrgzReinstall a packagez Reinstalls a package. Package is uninstalled, then installed with pipx install PACKAGE with the same options used in the original install of PACKAGE. rrrrVrnThe Python executable used to recreate the Virtual Environment and run the associated app/apps. Must be v3.6+.rrrr)rr#r*dedentrrrrrrr_add_reinstalls rcCsL|jdtdtdd}|jdtdd|jdd gd d |jd d ddS)NrkzReinstall all packagesaV Reinstalls all packages. Packages are uninstalled, then installed with pipx install PACKAGE with the same options used in the original install of PACKAGE. This is useful if you upgraded to a new version of Python and want all your packages to use the latest as well. rrrrrrrrrrr)rr#r*rrrrrrr_add_reinstall_allsrcCsB|jdddd}|jdddd|jd dd d|jd dd dS) NrdzList installed packagesz*List packages and apps installed with pipxrrrz6Show packages injected into the main app's environmentrz--jsonz Output rich data in json format.rrrrrrr _add_listsrc Cs|jdtdtdtjdd}|jdddd |jd d tjd gd |jdddd |jdt d|jddd|jdt ddt ||j |dt dd||_t dd |j|_dS)NrYzDownload the latest version of a package to a temporary virtual environment, then run an app from it. Also compatible with local `__pypackages__` directory (experimental).z Download the latest version of a package to a temporary virtual environment, then run an app from it. The environment will be cached and re-used for up to a days. This means subsequent calls to 'run' for the same package will be faster since they can re-use the cached Virtual Environment. In support of PEP 582 'run' will use apps found in a local __pypackages__ directory, if present. Please note that this behavior is experimental, and acts as a companion tool to pythonloc. It may be modified or removed in the future. See https://github.com/cs01/pythonloc. rz --no-cacherz5Do not re-use cached virtual environment if it existsrr}zapp ...z5app/package name and any arguments to be passed to it)metavarrrrz --pypackagesz9Require app to be run from local __pypackages__ directoryz--specrrrrz@The Python version to run package's CLI app with. Must be v3.6+.r) subparserz^usage: rIz\.\.\.)rr#r*rr #TEMP_VENV_EXPIRATION_THRESHOLD_DAYSrargparse REMAINDER SPEC_HELPrr set_defaultsrer( format_usageusagerrrr_add_runsL rcCsF|jdddd}||jddd_|jdtjgdd |jd d d dS) Nrlz7Run pip in an existing pipx-managed Virtual EnvironmentrrVzCName of the existing pipx-managed Virtual Environment to run pip inrrz#Arguments to forward to pip commandrrrr)rrrrrrrrr _add_runpip3s$rcCs&|jdddd}|jddddd dS) NrmzVEnsure directories necessary for pipx operation are in your PATH environment variable.aEnsure directory where pipx stores apps is in your PATH environment variable. Also if pipx was installed via `pip install --user`, ensure pipx itself is in your PATH. Note that running this may modify your shell's configuration file(s) such as '~/.bashrc'.rrrrzzAdd text to your shell's config file even if it looks like your PATH already contains paths to pipx and pipx-install apps.rrrrrr_add_ensurepathFs rcCsttj}t|}tjdttd}td|_ |j ddd}t |t ||j t||j t|t||j t|t||j t|t|t|t||j t||jddd d |jd d d d |S)Npipx)progrrrZr|z.Get help for commands with pipx COMMAND --help)destrz --versionrzPrint version and exitrrrz9Print instructions on enabling shell completions for pipxr)rr rtr3rArgumentParserr#PIPX_DESCRIPTION splitlinesman_short_descriptionadd_subparsersrrrDrrrrrrrrrrrr)r4completer_venvsrrrrrget_command_parser`s<      r file_list keep_numberc CsNt|}t||kr#|d| D]}z|Wqty"YqwdSdSr)r9r@unlinkFileNotFoundError)rr existing_filerrrdelete_oldest_logss   rcCsd}tjjdddtttjd|tttjd|td}tjd|d}d }|rP|dkrPtjd|d |d}|d 7}|rP|dks8|S) N T)parentsexist_okzcmd_*[0-9].logzcmd_*_pip_errors.logz%Y-%m-%d_%H.%M.%Scmd_z.logrZ_) r PIPX_LOG_DIRrrrdglobtimestrftimeexists)max_logs datetime_strlog_filecounterrrrsetup_log_files rrUc Cstjr ttdnd}ttj_dddddd|dddddddd d |r+d nd |r0d nddddt tjjdddddddgddidd}t j |dS)Nzpipx >rZzlogging.Formatterz {message}{)classformatstylez ({funcName}:{lineno}): {message}z;{relativeCreated: >8.1f}ms ({funcName}:{lineno}): {message})stream_nonverbosestream_verbosefilezlogging.StreamHandlerrrINFOWARNING)r formatterlevelzlogging.FileHandlerrzutf-8DEBUG)rrfilenameencodingr)streamrrr)handlersrF)version formattersrloggers incremental) sysstdoutisattyrrrrr pipx_log_filer1loggingconfig dictConfig)rUpipx_strlogging_configrrr setup_loggings>    $rcCsd|vr|jrttdtd|vo|jtt dtd tj t dt t dttttjttjttjttjdtjd }|rottd td t|d d ddSdS)NrrrUz%Y-%m-%d %H:%M:%Sr&zpipx version is zDefault python interpreter is Fzpipx-appz zA A virtual environment for pipx was detected at z. The 'pipx-app' package has been renamed back to 'pipx' (https://github.com/pypa/pipx/issues/82). z )r )rrrexitrrUrzrrrjoinargvr{rreprrrr rtrPIPX_VENV_CACHEDIRrPIPX_TRASH_DIRrwarningrrr1)rTold_pipx_venv_locationrrrsetups2      rparsed_pipx_argscCsH|jdkr |jr|jddkr|jd|js"|jddSdSdS)NrYrz--z)the following arguments are required: app)r|r}poprerror)rrrr check_argss  rc Cs4zz:tt}t||}t|t||js.|t dWWt dt St |WWt dt Stym}z&tt|tjdt j d|ddt dWYd}~Wt dt Sd}~wtyt dYWt dt Styt j dddwt dt w) zEntry point from command linerZzpipx finished.)rz PipxError: TroNrn)r r argcomplete autocomplete parse_argsrrr| print_helprrzrrrrrr1rstderrKeyboardInterruptr)rrrrrrclis@         r$__main__)rN)b__doc__rr logging.configosrrMrr*r urllib.parserupathlibrtypingrrrrrpackaging.requirementsrrpackaging.utilsr pipx.constantsrr r pipx.animater r pipx.colorsrrr pipx.emojisrpipx.interpreterr pipx.utilrrrr pipx.venvr pipx.versionr getLoggerr.rzr1 VenvCompleterrrrrtrrgetenvDOC_DEFAULT_PYTHONDEFAULT_PIPX_HOMEDEFAULT_PIPX_BIN_DIRrRawDescriptionHelpFormatterr#r3rOrS Namespacerrrr_SubParsersActionrrrrrrrrrrrrrr2rrboolrrrr$rrrrrs           # #  9& ,!