HEX

File: //usr/local/lib/python3.7/site-packages/pip/_internal/vcs/__pycache__/versioncontrol.cpython-37.pyc
B

L��gY�@s�dZddlZddlZddlZddlZddlZddlmZm	Z	m
Z
mZmZm
Z
mZmZmZmZmZddlmZddlmZmZddlmZmZmZmZmZmZmZm Z ddl!m"Z"m#Z#m$Z$m%Z%ddl&m'Z'er�dd	lm(Z(d
gZ)e�*e+�Z,eee-ee-fZ.e-e/d�dd
�Z0de-e-e-ee-e-d�dd�Z1e-e-ee-d�dd�Z2Gdd�de3�Z4Gdd�de3�Z5Gdd�d�Z6Gdd�d�Z7e7�Z8Gdd�d�Z9dS)z)Handles all VCS (version control) support�N)�
TYPE_CHECKING�Any�Dict�Iterable�Iterator�List�Mapping�Optional�Tuple�Type�Union)�SpinnerInterface)�
BadCommand�InstallationError)�
HiddenText�ask_path_exists�
backup_dir�display_path�hide_url�
hide_value�is_installable_dir�rmtree)�CommandArgs�call_subprocess�format_command_args�make_command)�get_url_scheme)�Literal�vcs)�name�returncCs*t|�}|dkrdS|ddddgtjkS)z3
    Return true if the name looks like a URL.
    NF�http�https�file�ftp)rr�all_schemes)r�scheme�r'�D/tmp/pip-unpacked-wheel-hv55ucu3/pip/_internal/vcs/versioncontrol.py�is_url9sr))�repo_url�rev�project_name�subdirr cCs6|�dd�}|�d|�d|��}|r2|d|��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=)�replace)r*r+r,r-�egg_project_name�reqr'r'r(�make_vcs_requirement_urlCs

r4)�location�	repo_rootr cCsZ|}x4t|�s8|}tj�|�}||krt�d|�dSqWtj�||�rLdStj�||�S)z�
    Find the the Python project's root by searching up the filesystem from
    `location`. Return the path to project root relative to `repo_root`.
    Return None if the project root is `repo_root`, or cannot be found.
    zOCould not find a Python project for directory %s (tried all parent directories)N)r�os�path�dirname�logger�warning�samefile�relpath)r5r6�
orig_location�
last_locationr'r'r(�(find_path_to_project_root_from_repo_rootUs	
r@c@seZdZdS)�RemoteNotFoundErrorN)�__name__�
__module__�__qualname__r'r'r'r(rArsrAcs"eZdZed��fdd�Z�ZS)�RemoteNotValidError)�urlcst��|�||_dS)N)�super�__init__rF)�selfrF)�	__class__r'r(rHwszRemoteNotValidError.__init__)rBrCrD�strrH�
__classcell__r'r')rJr(rEvsrEc@s�eZdZdZdedeeeedd�dd�Zed�dd	�Z	e
eed�d
d��Zed�dd
�Zed�dd�Z
edd�dd�ZdS)�
RevOptionsz�
    Encapsulates a VCS-specific revision to install, along with any VCS
    install options.

    Instances of this class should be treated as if immutable.
    N�VersionControl)�vc_classr+�
extra_argsr cCs(|dkrg}||_||_||_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)rPr+rO�branch_name)rIrOr+rPr'r'r(rH�szRevOptions.__init__)r cCsd|jj�d|j�d�S)Nz<RevOptions z: rev=�>)rOrr+)rIr'r'r(�__repr__�szRevOptions.__repr__cCs|jdkr|jjS|jS)N)r+rO�default_arg_rev)rIr'r'r(�arg_rev�s
zRevOptions.arg_revcCs0g}|j}|dk	r"||j�|�7}||j7}|S)z<
        Return the VCS-specific command arguments.
        N)rUrO�get_base_rev_argsrP)rI�argsr+r'r'r(�to_args�s
zRevOptions.to_argscCs|js
dSd|j�d�S)N�z (to revision �))r+)rIr'r'r(�
to_display�szRevOptions.to_display)r+r cCs|jj||jd�S)z�
        Make a copy of the current instance, but with a new rev.

        Args:
          rev: the name of the revision for the new object.
        )rP)rO�make_rev_optionsrP)rIr+r'r'r(�make_new�szRevOptions.make_new)NN)rBrCrD�__doc__rr	rKrrHrS�propertyrUrXr[r]r'r'r'r(rM|srMcs�eZdZUiZeedfed<ddddddgZd	d
��fdd�Ze	ed
�d
d�Z
eedd
�dd��Z
eeed
�dd��Zeeed
�dd��Zedd	d�dd�Zed	d�dd�Zeedd�dd�Zeedd�dd �Zeedd�d!d"�Z�ZS)#�
VcsSupportrN�	_registry�ssh�git�hg�bzr�sftp�svnN)r cstjj�|j�t���dS)N)�urllib�parse�uses_netloc�extend�schemesrGrH)rI)rJr'r(rH�szVcsSupport.__init__cCs
|j��S)N)ra�__iter__)rIr'r'r(rm�szVcsSupport.__iter__cCst|j���S)N)�listra�values)rIr'r'r(�backends�szVcsSupport.backendscCsdd�|jD�S)NcSsg|]
}|j�qSr')r9)�.0�backendr'r'r(�
<listcomp>�sz'VcsSupport.dirnames.<locals>.<listcomp>)rp)rIr'r'r(�dirnames�szVcsSupport.dirnamescCs$g}x|jD]}|�|j�qW|S)N)rprkrl)rIrlrrr'r'r(r%�szVcsSupport.all_schemes)�clsr cCsHt|d�st�d|j�dS|j|jkrD|�|j|j<t�d|j�dS)NrzCannot register VCS %szRegistered VCS backend: %s)�hasattrr:r;rBrra�debug)rIrur'r'r(�register�s
zVcsSupport.register)rr cCs||jkr|j|=dS)N)ra)rIrr'r'r(�
unregister�s
zVcsSupport.unregister)r5r cCs\i}x:|j��D],}|�|�}|s$qt�d||j�|||<qW|sHdSt|td�}||S)zv
        Return a VersionControl object if a repository of that type is found
        at the given directory.
        zDetermine that %s uses VCS: %sN)�key)raro�get_repository_rootr:rwr�max�len)rIr5�vcs_backends�vcs_backend�	repo_path�inner_most_repo_pathr'r'r(�get_backend_for_dir�s
zVcsSupport.get_backend_for_dir)r&r cCs&x |j��D]}||jkr|SqWdS)z9
        Return a VersionControl object or None.
        N)rarorl)rIr&rr'r'r(�get_backend_for_scheme�s
z!VcsSupport.get_backend_for_schemecCs|��}|j�|�S)z9
        Return a VersionControl object or None.
        )�lowerra�get)rIrr'r'r(�get_backendszVcsSupport.get_backend)rBrCrDrarrK�__annotations__rlrHrrmr_rrprtr%rrxryr	r�r�r�rLr'r')rJr(r`�s
	r`c@s�eZdZUdZdZdZdZeedfe	d<dZ
eedfe	d<dZeee	d<e
eed�d	d
��Ze
eeed�dd
��Ze
eed�dd��Ze
eeed�dd��Zeeeed�dd��Zeeed�dd�Ze
dQeeeeed�dd��Ze
eed�dd��Ze
eeeeeeeeeffd �d!d"��Ze
eeeeeefd#�d$d%��Zeeeeeed&�d'd(��Zeeeefd#�d)d*�Z eeed#�d+d,��Z!e
eeed-�d.d/��Z"eeee#dd0�d1d2�Z$eeedd3�d4d5�Z%eeedd3�d6d7�Z&e
eeeed8�d9d:��Z'eee#dd;�d<d=�Z(eee#dd>�d?d@�Z)e
eed�dAdB��Z*e
eed�dCdD��Z+e
dRe,eeefeeedHee-e#eeee.ee/fee0eeedI�dJdK��Z1e
eedL�dMdN��Z2e
eeed�dOdP��Z3dS)SrNrYr'.rl�
unset_environNrT)�
remote_urlr cCs|���|j�d��S)z�
        Return whether the vcs prefix (e.g. "git+") should be added to a
        repository's remote url when used in a requirement.
        �:)r��
startswithr)rur�r'r'r(�should_add_vcs_url_prefixsz(VersionControl.should_add_vcs_url_prefix)r5r cCsdS)z�
        Return the path to Python project root, relative to the repo root.
        Return None if the project root is in the repo root.
        Nr')rur5r'r'r(�get_subdirectory$szVersionControl.get_subdirectory)�repo_dirr cCs
|�|�S)zR
        Return the revision string that should be used in a requirement.
        )�get_revision)rur�r'r'r(�get_requirement_revision,sz'VersionControl.get_requirement_revision)r�r,r cCsL|�|�}|�|�r$|j�d|��}|�|�}|�|�}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}
        �+)r-)�get_remote_urlr�rr�r�r4)rur�r,r*�revisionr-r3r'r'r(�get_src_requirement3s



z"VersionControl.get_src_requirement)r+r cCst�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)r+r'r'r(rVKsz VersionControl.get_base_rev_args)rF�destr cCsdS)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')rIrFr�r'r'r(�is_immutable_rev_checkoutUsz(VersionControl.is_immutable_rev_checkout)r+rPr cCst|||d�S)z�
        Return a RevOptions object.

        Args:
          rev: the name of a revision to install.
          extra_args: a list of extra options.
        )rP)rM)rur+rPr'r'r(r\bszVersionControl.make_rev_options)�repor cCs&tj�|�\}}|�tjj�p$t|�S)zs
        posix absolute paths start with os.path.sep,
        win32 ones start with drive (like c:\folder)
        )r7r8�
splitdriver��sep�bool)rur��drive�tailr'r'r(�_is_local_repositoryosz#VersionControl._is_local_repository)�netlocr&r cCs|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)).
        )NNr')rur�r&r'r'r(�get_netloc_and_authxsz"VersionControl.get_netloc_and_auth)rFr c	Cs�tj�|�\}}}}}d|kr.td|�d���|�dd�d}|�||�\}}d}d|kr~|�dd�\}}|s~td|�d���tj�||||d	f�}|||fS)
z�
        Parse the repository URL to use, and return the URL, revision,
        and auth info to use.

        Returns: (url, rev, (username, password)).
        r�zSorry, zk is a malformed VCS url. The format is <vcs>+<protocol>://<url>, e.g. svn+http://myrepo/svn/MyApp#egg=MyApp�Nr0zThe URL zm has an empty revision (after @) which is not supported. Include a revision after @ or remove @ from the URL.rY)	rhri�urlsplit�
ValueError�splitr��rsplitr�
urlunsplit)	rurFr&r�r8�query�frag�	user_passr+r'r'r(�get_url_rev_and_auth�sz#VersionControl.get_url_rev_and_auth)�username�passwordr cCsgS)zM
        Return the RevOptions "extra arguments" to use in obtain().
        r')r�r�r'r'r(�
make_rev_args�szVersionControl.make_rev_argsc
CsT|�|j�\}}}|\}}d}|dk	r.t|�}|�||�}|j||d�}	t|�|	fS)zq
        Return the URL and RevOptions object to use in obtain(),
        as a tuple (url, rev_options).
        N)rP)r��secretrr�r\r)
rIrF�
secret_urlr+r�r��secret_passwordr�rP�rev_optionsr'r'r(�get_url_rev_options�sz"VersionControl.get_url_rev_optionscCstj�|��d�S)zi
        Normalize a URL for comparison by unquoting it and removing any
        trailing slash.
        �/)rhri�unquote�rstrip)rFr'r'r(�
normalize_url�szVersionControl.normalize_url)�url1�url2r cCs|�|�|�|�kS)zV
        Compare two repo URLs for identity, ignoring incidental differences.
        )r�)rur�r�r'r'r(�compare_urls�szVersionControl.compare_urls)r�rFr��	verbosityr cCst�dS)a
        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.
          verbosity: verbosity level.
        N)r�)rIr�rFr�r�r'r'r(�	fetch_new�szVersionControl.fetch_new)r�rFr�r cCst�dS)z}
        Switch the repo at ``dest`` to point to ``URL``.

        Args:
          rev_options: a RevOptions object.
        N)r�)rIr�rFr�r'r'r(�switch�szVersionControl.switchcCst�dS)z�
        Update an already-existing repo to the given ``rev_options``.

        Args:
          rev_options: a RevOptions object.
        N)r�)rIr�rFr�r'r'r(�update�szVersionControl.update)r�rr cCst�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�)rur�rr'r'r(�is_commit_id_equal�s	z!VersionControl.is_commit_id_equal)r�rFr�r c
Cs�|�|�\}}tj�|�s0|j||||d�dS|��}|�|�r�|�|�}|�||j	�r�t
�d|j�
�t|�|�|�||j�s�t
�dt|�|j|�|�|||�n
t
�d�dSt
�d|j|jt|�|�d}nt
�d||j|j�d	}t
�d
|j|�td|d��|d
�}|dk�r*t�d�|dk�rbt
�dt|��t|�|j||||d�dS|dk�r�t|�}	t
�dt|�|	�t�||	�|j||||d�dS|dk�r�t
�d|jt|�||�|�|||�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.
        :param verbosity: verbosity level.
        )r�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)z%(s)witch, (i)gnore, (w)ipe, (b)ackup )�s�i�w�bz0Directory %s already exists, and is not a %s %s.)z(i)gnore, (w)ipe, (b)ackup )r�r�r�z+The plan is to install the %s repository %sz
What to do?  rr��a���r�zDeleting %sr�zBacking up %s to %sr�zSwitching %s %s to %s%s)r�r7r8�existsr�r[�is_repository_directoryr�r�r�r:rw�	repo_name�titlerr�r+�infor�r;rr�sys�exitrr�shutil�mover�)
rIr�rFr�r��rev_display�existing_url�prompt�response�dest_dirr'r'r(�obtain�sz	







zVersionControl.obtain)r5rFr�r cCs(tj�|�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.
        :param verbosity: verbosity level.
        )rFr�N)r7r8r�rr�)rIr5rFr�r'r'r(�unpackVszVersionControl.unpackcCst�dS)z�
        Return the url used at location

        Raises RemoteNotFoundError if the repository does not have a remote
        url configured.
        N)r�)rur5r'r'r(r�bszVersionControl.get_remote_urlcCst�dS)zR
        Return the current commit id of the files at the given location.
        N)r�)rur5r'r'r(r�lszVersionControl.get_revisionT�raiseFz"Literal["raise", "warn", "ignore"])�cmd�show_stdout�cwd�
on_returncode�extra_ok_returncodes�command_desc�
extra_environ�spinner�log_failed_cmd�stdout_onlyr c
Cs�t|jf|��}|dkr t|�}y t||||||||j||	|
d�Stk
rntd|j�d|j�d���Yn&tk
r�td|j�d���YnXdS)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
        N)r�r�r�r�r�r�r�r�zCannot find command z - do you have z installed and in your PATH?zNo permission to execute z� - install it locally, globally (ask admin), or check your PATH. See possible solutions at https://pip.pypa.io/en/latest/reference/pip_freeze/#fixing-permission-denied.)rrrrr��FileNotFoundErrorr�PermissionError)rur�r�r�r�r�r�r�r�r�r�r'r'r(�run_commandss,zVersionControl.run_command)r8r cCs,t�d||j|j�tj�tj�||j��S)zL
        Return whether a directory path is a repository directory.
        zChecking in %s for %s (%s)...)r:rwr9rr7r8r��join)rur8r'r'r(r��sz&VersionControl.is_repository_directorycCs|�|�r|SdS)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�)rur5r'r'r(r{�s
z"VersionControl.get_repository_root)NN)	TNr�NNNNTF)4rBrCrDrr9r�rlr
rKr�r�rTr	�classmethodr�r�r�r�r��staticmethodrrVr�rrMr\r�r��AuthInfor�rr�r�r�r��intr�r�r�r�r�r�r�r�rrrrr
r�r�r{r'r'r'r(rNs|
	

( 		
Y	B+rN)N):r^�loggingr7r�r��urllib.parserh�typingrrrrrrrr	r
rr�pip._internal.cli.spinnersr
�pip._internal.exceptionsrr�pip._internal.utils.miscrrrrrrrr�pip._internal.utils.subprocessrrrr�pip._internal.utils.urlsrr�__all__�	getLoggerrBr:rKr�r�r)r4r@�	ExceptionrArErMr`rrNr'r'r'r(�<module>s64(

CP