3
Rene @ s d Z ddlmZ ddlZddlZddlZddlZddlZddlZddl m
Z
ddl m Z
ddlmZmZmZ ddlmZmZ ddlmZ dd lmZmZmZmZm Z m Z dd
l m Z m Z m!Z!m"Z" dd l#m$Z$ dd l%m&Z& e$r>dd
l'm(Z(m)Z)m*Z*m+Z+m,Z,m-Z-m.Z.m/Z/m0Z0m1Z1m2Z2 ddlm3Z3 ddl m4Z4 e.e,e5 e,e5 f Z6dgZ7ej8e9Z:dd Z;d"ddZG dd de?Z@G d d d eAZBG d d d eAZCeC ZDG d d! d!eAZEdS )$z)Handles all VCS (version control) support )absolute_importN)
pkg_resources)parse)
BadCommandInstallationErrorSubProcessError)console_to_strsamefile)subprocess_logger)ask_path_exists
backup_dir display_pathhide_url
hide_valuermtree)format_command_args make_command make_subprocess_output_errorreveal_command_args)MYPY_CHECK_RUNNING)get_url_scheme) DictIterableIteratorListOptionalTextTupleTypeUnionMappingAny)
HiddenText) CommandArgsvcsc C s* t | }|dkrdS |ddddgtj kS )z3
Return true if the name looks like a URL.
NFhttphttpsfileftp)r r$ all_schemes)namescheme r, /builddir/build/BUILDROOT/alt-python36-pip-20.2.4-5.el8.x86_64/opt/alt/python36/lib/python3.6/site-packages/pip/_internal/vcs/versioncontrol.pyis_url8 s r. c C s. t j|}dj| ||}|r*|dj|7 }|S )z
Return the URL for a VCS requirement.
Args:
repo_url: the remote VCS url, with any needed VCS prefix (e.g. "git+").
project_name: the (unescaped) project name.
z {}@{}#egg={}z&subdirectory={})r to_filenameformat)repo_urlrev project_namesubdiregg_project_namereqr, r, r- make_vcs_requirement_urlC s
r7 Tc C sf |dkr g }t j}tjj }|r*|j| d}t| }y.tjt | tj
tj
|d} | j rb| j j W n6 t
k
r }
z|rt jd|
| W Y dd}
~
X nX g } x@d} | jrt| jj } | sP | j } | j| d || qW z | j W d| jr| jj X | jo| j|k}
|
r\| rF|rFt| || | jd}t j| dj| j|}t|dj| S ) z
Args:
extra_ok_returncodes: an iterable of integer return codes that are
acceptable, in addition to 0. Defaults to None, which means [].
log_failed_cmd: if false, failed commands are not logged,
only raised.
NT)stdoutstderrcwdz#Error %s while executing command %s
)cmd_argsr: lines exit_statuszSCommand errored out with exit status {}: {} Check the logs for full command output. )r
debugosenvironcopyupdater
subprocessPopenr PIPEstdinclose Exceptioncriticalr8 r readlinerstripappendwait
returncoder errorr0 r join)cmdr:
extra_environextra_ok_returncodeslog_failed_cmdlog_subprocessenvshowing_subprocess command_descprocexc
all_outputlineproc_had_errormsgexc_msgr, r, r- call_subprocessT s`
rb c C sd | }xBt jjt jj| dsF| }t jj| } | |krtjd| dS qW t|| rVdS t jj| |S )z
Find the path to `setup.py` by searching up the filesystem from `location`.
Return the path to `setup.py` relative to `repo_root`.
Return None if `setup.py` is in `repo_root` or cannot be found.
zsetup.pyzGCould not find setup.py for directory %s (tried all parent directories)N) rA pathexistsrR dirnameloggerwarningr relpath)location repo_root
orig_location
last_locationr, r, r- !find_path_to_setup_from_repo_root s
rm c @ s e Zd ZdS )RemoteNotFoundErrorN)__name__
__module__ __qualname__r, r, r, r- rn s rn c @ sF e Zd ZdZdddZdd Zedd Zd d
Zd d Z d
d Z
dS )
RevOptionsz
Encapsulates a VCS-specific revision to install, along with any VCS
install options.
Instances of this class should be treated as if immutable.
Nc C s( |dkr g }|| _ || _|| _d| _dS )z
Args:
vc_class: a VersionControl subclass.
rev: the name of the revision to install.
extra_args: a list of extra options.
N)
extra_argsr2 vc_class branch_name)selfrt r2 rs r, r, r- __init__ s
zRevOptions.__init__c C s dj | jj| jS )Nz)r0 rt r* r2 )rv r, r, r- __repr__ s zRevOptions.__repr__c C s | j d kr| jjS | j S )N)r2 rt default_arg_rev)rv r, r, r- arg_rev s
zRevOptions.arg_revc C s0 g }| j }|dk r"|| jj|7 }|| j7 }|S )z<
Return the VCS-specific command arguments.
N)rz rt get_base_rev_argsrs )rv argsr2 r, r, r- to_args s
zRevOptions.to_argsc C s | j s
dS dj| j S )Nr? z (to revision {}))r2 r0 )rv r, r, r-
to_display s zRevOptions.to_displayc C s | j j|| jdS )z
Make a copy of the current instance, but with a new rev.
Args:
rev: the name of the revision for the new object.
)rs )rt make_rev_optionsrs )rv r2 r, r, r- make_new s zRevOptions.make_new)NN) ro rp rq __doc__rw rx propertyrz r} r~ r r, r, r, r- rr s
rr c s e Zd Zi ZddddddgZ fddZd d
Zed d Zed
d Z edd Z
dd Z dd Z dd Z
dd Zdd Z ZS )
VcsSupportsshgithgbzrsftpsvnc s: t jj| j tt dd r(t jj| j tt| j d S )N
uses_fragment) urllib_parse uses_netlocextendschemesgetattrr superr rw )rv ) __class__r, r- rw s zVcsSupport.__init__c C s
| j j S )N) _registry__iter__)rv r, r, r- r ! s zVcsSupport.__iter__c C s t | jj S )N)listr values)rv r, r, r- backends% s zVcsSupport.backendsc C s dd | j D S )Nc S s g | ]
}|j qS r, )re ).0backendr, r, r-
- s z'VcsSupport.dirnames..)r )rv r, r, r- dirnames* s zVcsSupport.dirnamesc C s$ g }x| j D ]}|j|j q W |S )N)r r r )rv r r r, r, r- r) / s zVcsSupport.all_schemesc C sH t |ds tjd|j d S |j| jkrD| | j|j< tjd|j d S )Nr* zCannot register VCS %szRegistered VCS backend: %s)hasattrrf rg ro r* r r@ )rv clsr, r, r- register7 s
zVcsSupport.registerc C s || j kr| j |= d S )N)r )rv r* r, r, r-
unregister@ s
zVcsSupport.unregisterc C s\ i }x:| j j D ],}|j|}|s$qtjd||j |||< qW |sHdS t|td}|| S )zv
Return a VersionControl object if a repository of that type is found
at the given directory.
z Determine that %s uses VCS: %sN)key)r r get_repository_rootrf r@ r* maxlen)rv ri vcs_backends vcs_backend repo_pathinner_most_repo_pathr, r, r- get_backend_for_dirE s
z VcsSupport.get_backend_for_dirc C s& x | j j D ]}||jkr |S q W dS )z9
Return a VersionControl object or None.
N)r r r )rv r+ r r, r, r- get_backend_for_scheme^ s
z!VcsSupport.get_backend_for_schemec C s |j }| jj|S )z9
Return a VersionControl object or None.
)lowerr get)rv r* r, r, r- get_backendh s zVcsSupport.get_backend)ro rp rq r r rw r r r r r) r r r r r
__classcell__r, r, )r r- r s
r c @ s@ e Zd ZdZdZdZf Zf ZdZe dd Z
e dd Z e dd Z e d d
Z
ed d Zd
d Ze d8ddZe dd Zdd Ze dd Ze dd Zedd Zdd Zed d Ze d d Zd!d" Zd#d$ Zd%d& Z e d'd( Z d)d* Z d+d, Z e d-d. Z e d/d0 Z!e d9d2d3Z"e d4d5 Z#e d6d7 Z$dS ):VersionControlr? Nc C s |j jdj| j S )z
Return whether the vcs prefix (e.g. "git+") should be added to a
repository's remote url when used in a requirement.
z{}:)r
startswithr0 r* )r
remote_urlr, r, r- should_add_vcs_url_prefix~ s z(VersionControl.should_add_vcs_url_prefixc C s dS )z~
Return the path to setup.py, relative to the repo root.
Return None if setup.py is in the repo root.
Nr, )r ri r, r, r- get_subdirectory s z VersionControl.get_subdirectoryc C s
| j |S )zR
Return the revision string that should be used in a requirement.
) get_revision)r repo_dirr, r, r- get_requirement_revision s z'VersionControl.get_requirement_revisionc C sV | j |}|dkrdS | j|r.dj| j|}| j|}| j|}t||||d}|S )aC
Return the requirement string to use to redownload the files
currently at the given repository directory.
Args:
project_name: the (unescaped) project name.
The return value has a form similar to the following:
{repository_url}@{revision}#egg={project_name}
Nz{}+{})r4 )get_remote_urlr r0 r* r r r7 )r r r3 r1 revisionr4 r6 r, r, r- get_src_requirement s
z"VersionControl.get_src_requirementc C s t dS )z
Return the base revision arguments for a vcs command.
Args:
rev: the name of a revision to install. Cannot be None.
N)NotImplementedError)r2 r, r, r- r{ s z VersionControl.get_base_rev_argsc C s dS )aZ
Return true if the commit hash checked out at dest matches
the revision in url.
Always return False, if the VCS does not support immutable commit
hashes.
This method does not check if there are local uncommitted changes
in dest after checkout, as pip currently has no use case for that.
Fr, )rv urldestr, r, r- is_immutable_rev_checkout s z(VersionControl.is_immutable_rev_checkoutc C s t | ||dS )z
Return a RevOptions object.
Args:
rev: the name of a revision to install.
extra_args: a list of extra options.
)rs )rr )r r2 rs r, r, r- r s
z VersionControl.make_rev_optionsc C s& t jj|\}}|jt jjp$t|S )zy
posix absolute paths start with os.path.sep,
win32 ones start with drive (like c:\folder)
)rA rc
splitdriver sepbool)r repodrivetailr, r, r- _is_local_repository s z#VersionControl._is_local_repositoryc C s t dS )z
Export the repository at the url to the destination location
i.e. only download the files, without vcs informations
:param url: the repository URL starting with a vcs prefix.
N)r )rv ri r r, r, r- export s zVersionControl.exportc C s |dfS )aZ
Parse the repository URL's netloc, and return the new netloc to use
along with auth information.
Args:
netloc: the original repository URL netloc.
scheme: the repository URL's scheme without the vcs prefix.
This is mainly for the Subversion class to override, so that auth
information can be provided via the --username and --password options
instead of through the URL. For other subclasses like Git without
such an option, auth information must stay in the URL.
Returns: (netloc, (username, password)).
N)NNr, )r netlocr+ r, r, r- get_netloc_and_auth s z"VersionControl.get_netloc_and_authc C s t j|\}}}}}d|kr*tdj||jddd }| j||\}}d}d|krx|jdd\}}|sxtdj|t j||||df}|||fS )z
Parse the repository URL to use, and return the URL, revision,
and auth info to use.
Returns: (url, rev, (username, password)).
+zvSorry, {!r} is a malformed VCS url. The format is +://, e.g. svn+http://myrepo/svn/MyApp#egg=MyApp N@zyThe URL {!r} has an empty revision (after @) which is not supported. Include a revision after @ or remove @ from the URL.r? ) r urlsplit
ValueErrorr0 splitr rsplitr
urlunsplit) r r r+ r rc queryfrag user_passr2 r, r, r- get_url_rev_and_auth s z#VersionControl.get_url_rev_and_authc C s g S )zM
Return the RevOptions "extra arguments" to use in obtain().
r, )usernamepasswordr, r, r-
make_rev_args s z VersionControl.make_rev_argsc
C sT | j |j\}}}|\}}d}|dk r.t|}| j||}| j||d} t|| fS )z
Return the URL and RevOptions object to use in obtain() and in
some cases export(), as a tuple (url, rev_options).
N)rs )r secretr r r r )
rv r
secret_urlr2 r r secret_passwordr rs rev_optionsr, r, r- get_url_rev_options( s z"VersionControl.get_url_rev_optionsc C s t j| jdS )zi
Normalize a URL for comparison by unquoting it and removing any
trailing slash.
/)r unquoterM )r r, r, r-
normalize_url8 s z VersionControl.normalize_urlc C s | j || j |kS )zV
Compare two repo URLs for identity, ignoring incidental differences.
)r )r url1url2r, r, r- compare_urlsA s zVersionControl.compare_urlsc C s t dS )z
Fetch a revision from a repository, in the case that this is the
first fetch from the repository.
Args:
dest: the directory to fetch the repository to.
rev_options: a RevOptions object.
N)r )rv r r r r, r, r- fetch_newI s
zVersionControl.fetch_newc C s t dS )z}
Switch the repo at ``dest`` to point to ``URL``.
Args:
rev_options: a RevOptions object.
N)r )rv r r r r, r, r- switchU s zVersionControl.switchc C s t dS )z
Update an already-existing repo to the given ``rev_options``.
Args:
rev_options: a RevOptions object.
N)r )rv r r r r, r, r- rD _ s zVersionControl.updatec C s t dS )z
Return whether the id of the current commit equals the given name.
Args:
dest: the repository directory.
name: a string name.
N)r )r r r* r, r, r- is_commit_id_equali s
z!VersionControl.is_commit_id_equalc C s | j |\}}tjj|s,| j||| dS |j }| j|r| j|}| j||j rt
j d| j j
t|| | j||jst
jdt|| j | | j||| n
t
jd dS t
jd| j| j t|| d}nt
jd || j| j d}t
jd
| j| tdj|d |d }|dkr&tjd |d krZt
jdt| t| | j||| dS |d
krt|}t
jdt|| tj || | j||| dS |dkrt
jd| j t||| | j ||| dS )a
Install or update in editable mode the package represented by this
VersionControl object.
:param dest: the repository directory in which to install or update.
:param url: the repository URL starting with a vcs prefix.
Nz)%s in %s exists, and has correct URL (%s)zUpdating %s %s%sz$Skipping because already up-to-date.z %s %s in %s exists with URL %s%(s)witch, (i)gnore, (w)ipe, (b)ackup siwbz0Directory %s already exists, and is not a %s %s.(i)gnore, (w)ipe, (b)ackup z+The plan is to install the %s repository %szWhat to do? {}r r az Deleting %szBacking up %s to %szSwitching %s %s to %s%sr r r r )r r r r r )r r ) r rA rc rd r r~ is_repository_directoryr r r rf r@ repo_nametitler
r r2 inforD rg r* r r0 sysexitr r shutilmover ) rv r r r rev_display existing_urlpromptresponsedest_dirr, r, r- obtainu s
zVersionControl.obtainc C s& t jj|rt| | j||d dS )z
Clean up current location and download the url repository
(and vcs infos) into location
:param url: the repository URL starting with a vcs prefix.
)r N)rA rc rd r r )rv ri r r, r, r- unpack s zVersionControl.unpackc C s t dS )z
Return the url used at location
Raises RemoteNotFoundError if the repository does not have a remote
url configured.
N)r )r ri r, r, r- r s z VersionControl.get_remote_urlc C s t dS )zR
Return the current commit id of the files at the given location.
N)r )r ri r, r, r- r s zVersionControl.get_revisionTc C sl t | jf| }yt|||||dS tk
rf } z(|jtjkrTtdjf t n W Y dd}~X nX dS )z
Run a VCS subcommand
This is simply a wrapper around call_subprocess that adds the VCS
command name, and checks that the VCS is available
)rT rU rV zWCannot find command {cls.name!r} - do you have {cls.name!r} installed and in your PATH?N) r r* rb OSErrorerrnoENOENTr r0 locals)r rS r: rT rU rV er, r, r- run_command s zVersionControl.run_commandc C s, t jd|| j| j tjjtjj|| jS )zL
Return whether a directory path is a repository directory.
z Checking in %s for %s (%s)...)rf r@ re r* rA rc rd rR )r rc r, r, r- r s z&VersionControl.is_repository_directoryc C s | j |r|S dS )ay
Return the "root" (top-level) directory controlled by the vcs,
or `None` if the directory is not in any.
It is meant to be overridden to implement smarter detection
mechanisms for specific vcs.
This can do more than is_repository_directory() alone. For
example, the Git override checks that Git is actually available.
N)r )r ri r, r, r- r s
z"VersionControl.get_repository_root)NN)NNNT)%ro rp rq r* re r r
unset_environry classmethodr r r r staticmethodr{ r r r r r r r r r r r r rD r r r r r r r r r, r, r, r- r t sJ
^
r )N)NNNT)Fr
__future__r r loggingrA r rE r pip._vendorr Z pip._vendor.six.moves.urllibr r pip._internal.exceptionsr r r pip._internal.utils.compatr r pip._internal.utils.loggingr
pip._internal.utils.miscr r r
r r r pip._internal.utils.subprocessr r r r pip._internal.utils.typingr pip._internal.utils.urlsr typingr r r r r r r r r r r! r" r# strZAuthInfo__all__ getLoggerro rf r. r7 rb rm rJ rn objectrr r r$ r r, r, r, r- sF 4
Q I^