Inheritance diagram for VersionControl:

[legend]

Collaboration diagram for VersionControl:

[legend]

Public Member Functions
bool	should_add_vcs_url_prefix (cls, str remote_url)

Optional[str]	get_subdirectory (cls, str location)

str	get_requirement_revision (cls, str repo_dir)

str	get_src_requirement (cls, str repo_dir, str project_name)

bool	is_immutable_rev_checkout (self, str url, str dest)

RevOptions	make_rev_options (cls, Optional[str] rev=None, Optional[CommandArgs] extra_args=None)

Tuple[str, Tuple[Optional[str], Optional[str]]]	get_netloc_and_auth (cls, str netloc, str scheme)

Tuple[str, Optional[str], AuthInfo]	get_url_rev_and_auth (cls, str url)

Tuple[HiddenText, RevOptions]	get_url_rev_options (self, HiddenText url)

bool	compare_urls (cls, str url1, str url2)

None	fetch_new (self, str dest, HiddenText url, RevOptions rev_options, int verbosity)

None	switch (self, str dest, HiddenText url, RevOptions rev_options)

None	update (self, str dest, HiddenText url, RevOptions rev_options)

bool	is_commit_id_equal (cls, str dest, Optional[str] name)

None	obtain (self, str dest, HiddenText url, int verbosity)

None	unpack (self, str location, HiddenText url, int verbosity)

str	get_remote_url (cls, str location)

str	get_revision (cls, str location)

str	run_command (cls, Union[List[str], CommandArgs] cmd, bool show_stdout=True, Optional[str] cwd=None, 'Literal["raise", "warn", "ignore"]' on_returncode="raise", Optional[Iterable[int]] extra_ok_returncodes=None, Optional[str] command_desc=None, Optional[Mapping[str, Any]] extra_environ=None, Optional[SpinnerInterface] spinner=None, bool log_failed_cmd=True, bool stdout_only=False)

bool	is_repository_directory (cls, str path)

Optional[str]	get_repository_root (cls, str location)

Static Public Member Functions
List[str]	get_base_rev_args (str rev)

CommandArgs	make_rev_args (Optional[str] username, Optional[HiddenText] password)

str	normalize_url (str url)

Data Fields
	repo_name

	name

	dirname

Static Public Attributes
str	name = ""

str	dirname = ""

str	repo_name = ""

tuple	schemes = ()

tuple	unset_environ = ()

Optional	default_arg_rev = None

Protected Member Functions
bool	_is_local_repository (cls, str repo)

Detailed Description

Definition at line 274 of file versioncontrol.py.

Member Function Documentation

◆ _is_local_repository()

bool _is_local_repository	(		cls,
		str	repo
	)

protected

posix absolute paths start with os.path.sep,
win32 ones start with drive (like c:\\folder)

Definition at line 368 of file versioncontrol.py.

    def _is_local_repository(cls, repo: str) -> bool:
        """
        posix absolute paths start with os.path.sep,
        win32 ones start with drive (like c:\\folder)
        """
        drive, tail = os.path.splitdrive(repo)
        return repo.startswith(os.path.sep) or bool(drive)
 

References i.

Referenced by Bazaar.get_remote_url(), and Mercurial.get_remote_url().

Here is the caller graph for this function:

◆ compare_urls()

bool compare_urls	(		cls,
		str	url1,
		str	url2
	)

Compare two repo URLs for identity, ignoring incidental differences.

Definition at line 460 of file versioncontrol.py.

    def compare_urls(cls, url1: str, url2: str) -> bool:
        """
        Compare two repo URLs for identity, ignoring incidental differences.
        """
        return cls.normalize_url(url1) == cls.normalize_url(url2)
 

References VersionControl.normalize_url().

Referenced by VersionControl.obtain().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fetch_new()

None fetch_new	(		self,
		str	dest,
		HiddenText	url,
		RevOptions	rev_options,
		int	verbosity
	)

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.

Reimplemented in Bazaar, Mercurial, and Subversion.

Definition at line 466 of file versioncontrol.py.

    ) -> None:
        """
        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.
        """
        raise NotImplementedError
 

Referenced by VersionControl.obtain().

Here is the caller graph for this function:

◆ get_base_rev_args()

List[str] get_base_rev_args ( str rev )

static

Return the base revision arguments for a vcs command.

Args:
  rev: the name of a revision to install.  Cannot be None.

Reimplemented in Bazaar, Mercurial, and Subversion.

Definition at line 332 of file versioncontrol.py.

    def get_base_rev_args(rev: str) -> List[str]:
        """
        Return the base revision arguments for a vcs command.
 
        Args:
          rev: the name of a revision to install.  Cannot be None.
        """
        raise NotImplementedError
 

◆ get_netloc_and_auth()

Tuple[str, Tuple[Optional[str], Optional[str]]] get_netloc_and_auth	(		cls,
		str	netloc,
		str	scheme
	)

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)).

Reimplemented in Subversion.

Definition at line 377 of file versioncontrol.py.

    ) -> Tuple[str, Tuple[Optional[str], Optional[str]]]:
        """
        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)).
        """
        return netloc, (None, None)
 

Referenced by VersionControl.get_url_rev_and_auth().

Here is the caller graph for this function:

◆ get_remote_url()

str get_remote_url	(		cls,
		str	location
	)

Return the url used at location

Raises RemoteNotFoundError if the repository does not have a remote
url configured.

Reimplemented in Bazaar, Mercurial, and Subversion.

Definition at line 611 of file versioncontrol.py.

    def get_remote_url(cls, location: str) -> str:
        """
        Return the url used at location
 
        Raises RemoteNotFoundError if the repository does not have a remote
        url configured.
        """
        raise NotImplementedError
 

Referenced by VersionControl.get_src_requirement(), and VersionControl.obtain().

Here is the caller graph for this function:

◆ get_repository_root()

Optional[str] get_repository_root	(		cls,
		str	location
	)

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.

Reimplemented in Mercurial.

Definition at line 692 of file versioncontrol.py.

    def get_repository_root(cls, location: str) -> Optional[str]:
        """
        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.
        """
        if cls.is_repository_directory(location):
            return location
        return None

References VersionControl.is_repository_directory().

Here is the call graph for this function:

◆ get_requirement_revision()

str get_requirement_revision	(		cls,
		str	repo_dir
	)

Return the revision string that should be used in a requirement.

Reimplemented in Mercurial.

Definition at line 301 of file versioncontrol.py.

    def get_requirement_revision(cls, repo_dir: str) -> str:
        """
        Return the revision string that should be used in a requirement.
        """
        return cls.get_revision(repo_dir)
 

References Bazaar.get_revision(), Mercurial.get_revision(), Subversion.get_revision(), and VersionControl.get_revision().

Referenced by VersionControl.get_src_requirement().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_revision()

str get_revision	(		cls,
		str	location
	)

Return the current commit id of the files at the given location.

Reimplemented in Bazaar, Mercurial, and Subversion.

Definition at line 621 of file versioncontrol.py.

    def get_revision(cls, location: str) -> str:
        """
        Return the current commit id of the files at the given location.
        """
        raise NotImplementedError
 

Referenced by VersionControl.get_requirement_revision().

Here is the caller graph for this function:

◆ get_src_requirement()

str get_src_requirement	(		cls,
		str	repo_dir,
		str	project_name
	)

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}

Definition at line 308 of file versioncontrol.py.

    def get_src_requirement(cls, repo_dir: str, project_name: str) -> str:
        """
        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}
        """
        repo_url = cls.get_remote_url(repo_dir)
 
        if cls.should_add_vcs_url_prefix(repo_url):
            repo_url = f"{cls.name}+{repo_url}"
 
        revision = cls.get_requirement_revision(repo_dir)
        subdir = cls.get_subdirectory(repo_dir)
        req = make_vcs_requirement_url(repo_url, revision, project_name, subdir=subdir)
 
        return req
 

References Bazaar.get_remote_url(), Mercurial.get_remote_url(), Subversion.get_remote_url(), VersionControl.get_remote_url(), Mercurial.get_requirement_revision(), VersionControl.get_requirement_revision(), Mercurial.get_subdirectory(), VersionControl.get_subdirectory(), pip._internal.vcs.versioncontrol.make_vcs_requirement_url(), Subversion.should_add_vcs_url_prefix(), and VersionControl.should_add_vcs_url_prefix().

Here is the call graph for this function:

◆ get_subdirectory()

Optional[str] get_subdirectory	(		cls,
		str	location
	)

Return the path to Python project root, relative to the repo root.
Return None if the project root is in the repo root.

Reimplemented in Mercurial.

Definition at line 293 of file versioncontrol.py.

    def get_subdirectory(cls, location: str) -> Optional[str]:
        """
        Return the path to Python project root, relative to the repo root.
        Return None if the project root is in the repo root.
        """
        return None
 

Referenced by VersionControl.get_src_requirement().

Here is the caller graph for this function:

◆ get_url_rev_and_auth()

Tuple[str, Optional[str], AuthInfo] get_url_rev_and_auth	(		cls,
		str	url
	)

Parse the repository URL to use, and return the URL, revision,
and auth info to use.

Returns: (url, rev, (username, password)).

Reimplemented in Bazaar, and Subversion.

Definition at line 398 of file versioncontrol.py.

    def get_url_rev_and_auth(cls, url: str) -> Tuple[str, Optional[str], AuthInfo]:
        """
        Parse the repository URL to use, and return the URL, revision,
        and auth info to use.
 
        Returns: (url, rev, (username, password)).
        """
        scheme, netloc, path, query, frag = urllib.parse.urlsplit(url)
        if "+" not in scheme:
            raise ValueError(
                "Sorry, {!r} is a malformed VCS url. "
                "The format is <vcs>+<protocol>://<url>, "
                "e.g. svn+http://myrepo/svn/MyApp#egg=MyApp".format(url)
            )
        # Remove the vcs prefix.
        scheme = scheme.split("+", 1)[1]
        netloc, user_pass = cls.get_netloc_and_auth(netloc, scheme)
        rev = None
        if "@" in path:
            path, rev = path.rsplit("@", 1)
            if not rev:
                raise InstallationError(
                    "The URL {!r} has an empty revision (after @) "
                    "which is not supported. Include a revision after @ "
                    "or remove @ from the URL.".format(url)
                )
        url = urllib.parse.urlunsplit((scheme, netloc, path, query, ""))
        return url, rev, user_pass
 

References Subversion.get_netloc_and_auth(), VersionControl.get_netloc_and_auth(), and i.

Referenced by VersionControl.get_url_rev_options().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_url_rev_options()

Tuple[HiddenText, RevOptions] get_url_rev_options	(		self,
		HiddenText	url
	)

Return the URL and RevOptions object to use in obtain(),
as a tuple (url, rev_options).

Definition at line 436 of file versioncontrol.py.

    def get_url_rev_options(self, url: HiddenText) -> Tuple[HiddenText, RevOptions]:
        """
        Return the URL and RevOptions object to use in obtain(),
        as a tuple (url, rev_options).
        """
        secret_url, rev, user_pass = self.get_url_rev_and_auth(url.secret)
        username, secret_password = user_pass
        password: Optional[HiddenText] = None
        if secret_password is not None:
            password = hide_value(secret_password)
        extra_args = self.make_rev_args(username, password)
        rev_options = self.make_rev_options(rev, extra_args=extra_args)
 
        return hide_url(secret_url), rev_options
 

References Bazaar.get_url_rev_and_auth(), Subversion.get_url_rev_and_auth(), VersionControl.get_url_rev_and_auth(), i, Subversion.make_rev_args(), VersionControl.make_rev_args(), and VersionControl.make_rev_options().

Referenced by VersionControl.obtain().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ is_commit_id_equal()

bool is_commit_id_equal	(		cls,
		str	dest,
		Optional[str]	name
	)

Return whether the id of the current commit equals the given name.

Args:
  dest: the repository directory.
  name: a string name.

Reimplemented in Bazaar, Mercurial, and Subversion.

Definition at line 499 of file versioncontrol.py.

    def is_commit_id_equal(cls, dest: str, name: Optional[str]) -> bool:
        """
        Return whether the id of the current commit equals the given name.
 
        Args:
          dest: the repository directory.
          name: a string name.
        """
        raise NotImplementedError
 

Referenced by VersionControl.obtain().

Here is the caller graph for this function:

◆ is_immutable_rev_checkout()

bool is_immutable_rev_checkout	(		self,
		str	url,
		str	dest
	)

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.

Definition at line 341 of file versioncontrol.py.

    def is_immutable_rev_checkout(self, url: str, dest: str) -> bool:
        """
        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.
        """
        return False
 

◆ is_repository_directory()

bool is_repository_directory	(		cls,
		str	path
	)

Return whether a directory path is a repository directory.

Definition at line 684 of file versioncontrol.py.

    def is_repository_directory(cls, path: str) -> bool:
        """
        Return whether a directory path is a repository directory.
        """
        logger.debug("Checking in %s for %s (%s)...", path, cls.dirname, cls.name)
        return os.path.exists(os.path.join(path, cls.dirname))
 

Referenced by VersionControl.get_repository_root(), and VersionControl.obtain().

Here is the caller graph for this function:

◆ make_rev_args()

CommandArgs make_rev_args	(	Optional[str]	username,
		Optional[HiddenText]	password
	)

static

Return the RevOptions "extra arguments" to use in obtain().

Reimplemented in Subversion.

Definition at line 428 of file versioncontrol.py.

    ) -> CommandArgs:
        """
        Return the RevOptions "extra arguments" to use in obtain().
        """
        return []
 

Referenced by VersionControl.get_url_rev_options().

Here is the caller graph for this function:

◆ make_rev_options()

RevOptions make_rev_options	(		cls,
		Optional[str]	rev = `None`,
		Optional[CommandArgs]	extra_args = `None`
	)

Return a RevOptions object.

Args:
  rev: the name of a revision to install.
  extra_args: a list of extra options.

Definition at line 355 of file versioncontrol.py.

    ) -> RevOptions:
        """
        Return a RevOptions object.
 
        Args:
          rev: the name of a revision to install.
          extra_args: a list of extra options.
        """
        return RevOptions(cls, rev, extra_args=extra_args)
 

Referenced by VersionControl.get_url_rev_options().

Here is the caller graph for this function:

◆ normalize_url()

str normalize_url ( str url )

static

Normalize a URL for comparison by unquoting it and removing any
trailing slash.

Definition at line 452 of file versioncontrol.py.

    def normalize_url(url: str) -> str:
        """
        Normalize a URL for comparison by unquoting it and removing any
        trailing slash.
        """
        return urllib.parse.unquote(url).rstrip("/")
 

References i.

Referenced by VersionControl.compare_urls().

Here is the caller graph for this function:

◆ obtain()

None obtain	(		self,
		str	dest,
		HiddenText	url,
		int	verbosity
	)

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.

Definition at line 509 of file versioncontrol.py.

    def obtain(self, dest: str, url: HiddenText, verbosity: int) -> None:
        """
        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.
        """
        url, rev_options = self.get_url_rev_options(url)
 
        if not os.path.exists(dest):
            self.fetch_new(dest, url, rev_options, verbosity=verbosity)
            return
 
        rev_display = rev_options.to_display()
        if self.is_repository_directory(dest):
            existing_url = self.get_remote_url(dest)
            if self.compare_urls(existing_url, url.secret):
                logger.debug(
                    "%s in %s exists, and has correct URL (%s)",
                    self.repo_name.title(),
                    display_path(dest),
                    url,
                )
                if not self.is_commit_id_equal(dest, rev_options.rev):
                    logger.info(
                        "Updating %s %s%s",
                        display_path(dest),
                        self.repo_name,
                        rev_display,
                    )
                    self.update(dest, url, rev_options)
                else:
                    logger.info("Skipping because already up-to-date.")
                return
 
            logger.warning(
                "%s %s in %s exists with URL %s",
                self.name,
                self.repo_name,
                display_path(dest),
                existing_url,
            )
            prompt = ("(s)witch, (i)gnore, (w)ipe, (b)ackup ", ("s", "i", "w", "b"))
        else:
            logger.warning(
                "Directory %s already exists, and is not a %s %s.",
                dest,
                self.name,
                self.repo_name,
            )
            # https://github.com/python/mypy/issues/1174
            prompt = ("(i)gnore, (w)ipe, (b)ackup ", ("i", "w", "b"))  # type: ignore
 
        logger.warning(
            "The plan is to install the %s repository %s",
            self.name,
            url,
        )
        response = ask_path_exists("What to do?  {}".format(prompt[0]), prompt[1])
 
        if response == "a":
            sys.exit(-1)
 
        if response == "w":
            logger.warning("Deleting %s", display_path(dest))
            rmtree(dest)
            self.fetch_new(dest, url, rev_options, verbosity=verbosity)
            return
 
        if response == "b":
            dest_dir = backup_dir(dest)
            logger.warning("Backing up %s to %s", display_path(dest), dest_dir)
            shutil.move(dest, dest_dir)
            self.fetch_new(dest, url, rev_options, verbosity=verbosity)
            return
 
        # Do nothing if the response is "i".
        if response == "s":
            logger.info(
                "Switching %s %s to %s%s",
                self.repo_name,
                display_path(dest),
                url,
                rev_display,
            )
            self.switch(dest, url, rev_options)
 

References VersionControl.compare_urls(), Bazaar.fetch_new(), Mercurial.fetch_new(), Subversion.fetch_new(), VersionControl.fetch_new(), Bazaar.get_remote_url(), Mercurial.get_remote_url(), Subversion.get_remote_url(), VersionControl.get_remote_url(), VersionControl.get_url_rev_options(), i, Bazaar.is_commit_id_equal(), Mercurial.is_commit_id_equal(), Subversion.is_commit_id_equal(), VersionControl.is_commit_id_equal(), VersionControl.is_repository_directory(), Bazaar.repo_name, Mercurial.repo_name, Subversion.repo_name, and VersionControl.repo_name.

Referenced by VersionControl.unpack().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ run_command()

str run_command	(		cls,
		Union[List[str], CommandArgs]	cmd,
		bool	show_stdout = `True`,
		Optional[str]	cwd = `None`,
		'Literal["raise", "warn", "ignore"]'	on_returncode = `"raise"`,
		Optional[Iterable[int]]	extra_ok_returncodes = `None`,
		Optional[str]	command_desc = `None`,
		Optional[Mapping[str, Any]]	extra_environ = `None`,
		Optional[SpinnerInterface]	spinner = `None`,
		bool	log_failed_cmd = `True`,
		bool	stdout_only = `False`
	)

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

Definition at line 628 of file versioncontrol.py.

    ) -> str:
        """
        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
        """
        cmd = make_command(cls.name, *cmd)
        if command_desc is None:
            command_desc = format_command_args(cmd)
        try:
            return call_subprocess(
                cmd,
                show_stdout,
                cwd,
                on_returncode=on_returncode,
                extra_ok_returncodes=extra_ok_returncodes,
                command_desc=command_desc,
                extra_environ=extra_environ,
                unset_environ=cls.unset_environ,
                spinner=spinner,
                log_failed_cmd=log_failed_cmd,
                stdout_only=stdout_only,
            )
        except FileNotFoundError:
            # errno.ENOENT = no such file or directory
            # In other words, the VCS executable isn't available
            raise BadCommand(
                f"Cannot find command {cls.name!r} - do you have "
                f"{cls.name!r} installed and in your PATH?"
            )
        except PermissionError:
            # errno.EACCES = Permission denied
            # This error occurs, for instance, when the command is installed
            # only for another user. So, the current user don't have
            # permission to call the other user command.
            raise BadCommand(
                f"No permission to execute {cls.name!r} - install it "
                f"locally, globally (ask admin), or check your PATH. "
                f"See possible solutions at "
                f"https://pip.pypa.io/en/latest/reference/pip_freeze/"
                f"#fixing-permission-denied."
            )
 

References MunitParameterEnum.name, MunitParameter.name, MunitTest.name, MunitArgument_.name, Command.name, ConfigOptionParser.name, TransformedHit.name, _PackageInfo.name, InvalidWheel.name, BaseEntryPoint.name(), BasePath.name(), EntryPoint.name, InstallationCandidate.name, VcsInfo.name, ArchiveInfo.name, DirInfo.name, LinkHash.name, Wheel.name, LazyZipOverHTTP.name(), FrozenRequirement.name, InstallationResult.name, InstallRequirement.name(), InstallRequirement.name, Requirement.name(), Candidate.name(), _InstallRequirementBackedCandidate.name(), _InstallRequirementBackedCandidate.name, AlreadyInstalledCandidate.name, AlreadyInstalledCandidate.name(), ExtrasCandidate.name(), RequiresPythonCandidate.name(), ExplicitRequirement.name(), SpecifierRequirement.name(), RequiresPythonRequirement.name(), UnsatisfiableRequirement.name(), Bazaar.name, Mercurial.name, Subversion.name, VcsSupport.name, VersionControl.name, CodingStateMachineDict.name, Language.name, _Cache.name, Distribution.name, InstalledDistribution.name, EggInfoDistribution.name, LegacyMetadata.name, Metadata.name, ResourceBase.name, ExportEntry.name, Matcher.name, LinuxDistribution.name(), Formatter.name, BBCodeFormatter.name, GroffFormatter.name, HtmlFormatter.name, ImageFormatter.name, GifImageFormatter.name, JpgImageFormatter.name, BmpImageFormatter.name, IRCFormatter.name, LatexFormatter.name, NullFormatter.name, RawTokenFormatter.name, TestcaseFormatter.name, PangoMarkupFormatter.name, RtfFormatter.name, SvgFormatter.name, TerminalFormatter.name, Terminal256Formatter.name, TerminalTrueColorFormatter.name, Lexer.name, PythonLexer.name, Python2Lexer.name, _PythonConsoleLexerBase.name, PythonConsoleLexer.name, PythonTracebackLexer.name, Python2TracebackLexer.name, CythonLexer.name, DgLexer.name, NumPyLexer.name, ParserElement.name(), EditablePartial.name(), ElementState.name, LookupDict.name, Color.name, Emoji.name, Splitter.name, RowSplitter.name, ColumnSplitter.name, Layout.name, Tag.name, StockKeepingUnit.name, _Reader.name(), Frame.name, _LazyDescr.name, _SixMetaPathImporter.name, Encoding.name, and VersionControl.unset_environ.

Referenced by Subversion._get_svn_url_rev(), Subversion.call_vcs_version(), Bazaar.fetch_new(), Mercurial.fetch_new(), Subversion.fetch_new(), Bazaar.get_remote_url(), Mercurial.get_remote_url(), Mercurial.get_repository_root(), Mercurial.get_requirement_revision(), Bazaar.get_revision(), Mercurial.get_revision(), Mercurial.get_subdirectory(), PackageIndex.sign_file(), Bazaar.switch(), Mercurial.switch(), Subversion.switch(), Bazaar.update(), Mercurial.update(), Subversion.update(), and PackageIndex.verify_signature().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ should_add_vcs_url_prefix()

bool should_add_vcs_url_prefix	(		cls,
		str	remote_url
	)

Return whether the vcs prefix (e.g. "git+") should be added to a
repository's remote url when used in a requirement.

Reimplemented in Subversion.

Definition at line 285 of file versioncontrol.py.

    def should_add_vcs_url_prefix(cls, remote_url: str) -> bool:
        """
        Return whether the vcs prefix (e.g. "git+") should be added to a
        repository's remote url when used in a requirement.
        """
        return not remote_url.lower().startswith(f"{cls.name}:")
 

References i.

Referenced by VersionControl.get_src_requirement().

Here is the caller graph for this function:

◆ switch()

None switch	(		self,
		str	dest,
		HiddenText	url,
		RevOptions	rev_options
	)

Switch the repo at ``dest`` to point to ``URL``.

Args:
  rev_options: a RevOptions object.

Reimplemented in Bazaar, Mercurial, and Subversion.

Definition at line 480 of file versioncontrol.py.

    def switch(self, dest: str, url: HiddenText, rev_options: RevOptions) -> None:
        """
        Switch the repo at ``dest`` to point to ``URL``.
 
        Args:
          rev_options: a RevOptions object.
        """
        raise NotImplementedError
 

◆ unpack()

None unpack	(		self,
		str	location,
		HiddenText	url,
		int	verbosity
	)

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.

Definition at line 598 of file versioncontrol.py.

    def unpack(self, location: str, url: HiddenText, verbosity: int) -> None:
        """
        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.
        """
        if os.path.exists(location):
            rmtree(location)
        self.obtain(location, url=url, verbosity=verbosity)
 

References i, Environment.obtain(), and VersionControl.obtain().

Here is the call graph for this function:

◆ update()

None update	(		self,
		str	dest,
		HiddenText	url,
		RevOptions	rev_options
	)

Update an already-existing repo to the given ``rev_options``.

Args:
  rev_options: a RevOptions object.

Reimplemented in Bazaar, Mercurial, and Subversion.

Definition at line 489 of file versioncontrol.py.

    def update(self, dest: str, url: HiddenText, rev_options: RevOptions) -> None:
        """
        Update an already-existing repo to the given ``rev_options``.
 
        Args:
          rev_options: a RevOptions object.
        """
        raise NotImplementedError
 

Referenced by Progress.increment(), Progress.open(), Progress.start(), Progress.stop(), Progress.track(), and Progress.wrap_file().

Here is the caller graph for this function:

Field Documentation

◆ default_arg_rev

Optional default_arg_rev = None

static

Definition at line 282 of file versioncontrol.py.

◆ dirname [1/2]

str dirname = ""

static

Definition at line 276 of file versioncontrol.py.

Referenced by Wheel._get_extensions(), Subversion._get_svn_url_rev(), Wheel.exists(), Subversion.get_revision(), Wheel.info(), Wheel.install(), Wheel.metadata(), Wheel.mount(), Mercurial.switch(), Wheel.unmount(), Wheel.update(), and Wheel.verify().

◆ dirname [2/2]

dirname

Definition at line 688 of file versioncontrol.py.

Referenced by Wheel._get_extensions(), Subversion._get_svn_url_rev(), Wheel.exists(), Subversion.get_revision(), Wheel.info(), Wheel.install(), Wheel.metadata(), Wheel.mount(), Mercurial.switch(), Wheel.unmount(), Wheel.update(), and Wheel.verify().

◆ name [1/2]

str name = ""

static

Definition at line 275 of file versioncontrol.py.

Referenced by AlreadyInstalledCandidate.__eq__(), Distribution.__eq__(), ExportEntry.__eq__(), _LazyDescr.__get__(), Distribution.__hash__(), ElementState.__init__(), Requirement.__init__(), LinkHash.__post_init__(), InstallationCandidate.__repr__(), Distribution.__repr__(), Metadata.__repr__(), ExportEntry.__repr__(), Encoding.__repr__(), Color.__rich_repr__(), Layout.__rich_repr__(), InstallationCandidate.__str__(), InstalledDistribution.__str__(), EggInfoDistribution.__str__(), Requirement.__str__(), ParserElement.__str__(), Tag.__str__(), _SixMetaPathImporter._add_module(), Matcher._check_compatible(), InstallRequirement._get_archive_name(), Wheel._get_extensions(), _SixMetaPathImporter._get_module(), ConfigOptionParser._get_ordered_configuration_items(), Distribution._get_requirements(), _Cache.add(), InstallRequirement.archive(), LinkHash.as_dict(), LinkHash.as_hashes(), Wheel.build(), _Cache.clear(), Wheel.filename(), Layout.get(), InstallRequirement.get_dist(), InstalledDistribution.get_distinfo_file(), RequirementCommand.get_requirements(), Wheel.get_wheel_metadata(), InstallRequirement.install(), Wheel.install(), SpecifierRequirement.is_satisfied_by(), LinuxDistribution.linux_distribution(), Wheel.metadata(), Distribution.name_and_version(), InstallRequirement.prepare_metadata(), Distribution.provides(), Metadata.provides(), VcsSupport.register(), VersionControl.run_command(), InstallRequirement.uninstall(), Wheel.update(), and Wheel.verify().

◆ name [2/2]

name

Definition at line 548 of file versioncontrol.py.

Referenced by AlreadyInstalledCandidate.__eq__(), Distribution.__eq__(), ExportEntry.__eq__(), _LazyDescr.__get__(), Distribution.__hash__(), ElementState.__init__(), Requirement.__init__(), LinkHash.__post_init__(), InstallationCandidate.__repr__(), Distribution.__repr__(), Metadata.__repr__(), ExportEntry.__repr__(), Encoding.__repr__(), Color.__rich_repr__(), Layout.__rich_repr__(), InstallationCandidate.__str__(), InstalledDistribution.__str__(), EggInfoDistribution.__str__(), Requirement.__str__(), ParserElement.__str__(), Tag.__str__(), _SixMetaPathImporter._add_module(), Matcher._check_compatible(), InstallRequirement._get_archive_name(), Wheel._get_extensions(), _SixMetaPathImporter._get_module(), ConfigOptionParser._get_ordered_configuration_items(), Distribution._get_requirements(), _Cache.add(), InstallRequirement.archive(), LinkHash.as_dict(), LinkHash.as_hashes(), Wheel.build(), _Cache.clear(), Wheel.filename(), Layout.get(), InstallRequirement.get_dist(), InstalledDistribution.get_distinfo_file(), RequirementCommand.get_requirements(), Wheel.get_wheel_metadata(), InstallRequirement.install(), Wheel.install(), SpecifierRequirement.is_satisfied_by(), LinuxDistribution.linux_distribution(), Wheel.metadata(), Distribution.name_and_version(), InstallRequirement.prepare_metadata(), Distribution.provides(), Metadata.provides(), VcsSupport.register(), VersionControl.run_command(), InstallRequirement.uninstall(), Wheel.update(), and Wheel.verify().

◆ repo_name [1/2]

str repo_name = ""

static

Definition at line 277 of file versioncontrol.py.

Referenced by VersionControl.obtain().

◆ repo_name [2/2]

repo_name

Definition at line 538 of file versioncontrol.py.

Referenced by VersionControl.obtain().

◆ schemes

tuple schemes = ()

static

Definition at line 279 of file versioncontrol.py.

◆ unset_environ

tuple unset_environ = ()

static

Definition at line 281 of file versioncontrol.py.

Referenced by VersionControl.run_command().

The documentation for this class was generated from the following file:

/home/liwuen/projects_dev/pqc-engineering-ssec-23/venv/lib/python3.12/site-packages/pip/_internal/vcs/versioncontrol.py

Public Member Functions

Static Public Member Functions

Data Fields

Static Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

◆ _is_local_repository()

◆ compare_urls()

◆ fetch_new()

◆ get_base_rev_args()

◆ get_netloc_and_auth()

◆ get_remote_url()

◆ get_repository_root()

◆ get_requirement_revision()

◆ get_revision()

◆ get_src_requirement()

◆ get_subdirectory()

◆ get_url_rev_and_auth()

◆ get_url_rev_options()

◆ is_commit_id_equal()

◆ is_immutable_rev_checkout()

◆ is_repository_directory()

◆ make_rev_args()

◆ make_rev_options()

◆ normalize_url()

◆ obtain()

◆ run_command()

◆ should_add_vcs_url_prefix()

◆ switch()

◆ unpack()

◆ update()

Field Documentation

◆ default_arg_rev

◆ dirname [1/2]

◆ dirname [2/2]

◆ name [1/2]

◆ name [2/2]

◆ repo_name [1/2]

◆ repo_name [2/2]

◆ schemes

◆ unset_environ