Inheritance diagram for Mercurial:

Collaboration diagram for Mercurial:

[legend]

Public Member Functions
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)

str	get_remote_url (cls, str location)

str	get_revision (cls, str location)

str	get_requirement_revision (cls, str location)

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

Optional[str]	get_subdirectory (cls, str location)

Optional[str]	get_repository_root (cls, str location)

Public Member Functions inherited from VersionControl
bool	should_add_vcs_url_prefix (cls, str remote_url)

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	obtain (self, str dest, HiddenText url, int verbosity)

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

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)

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

Static Public Member Functions inherited from VersionControl
CommandArgs	make_rev_args (Optional[str] username, Optional[HiddenText] password)

str	normalize_url (str url)

Static Public Attributes
str	name = "hg"

str	dirname = ".hg"

str	repo_name = "clone"

tuple	schemes

Static Public Attributes inherited from VersionControl
str	name = ""

str	dirname = ""

str	repo_name = ""

tuple	schemes = ()

tuple	unset_environ = ()

Optional	default_arg_rev = None

Additional Inherited Members
Data Fields inherited from VersionControl
	repo_name

	name

	dirname

Protected Member Functions inherited from VersionControl
bool	_is_local_repository (cls, str repo)

Detailed Description

Definition at line 20 of file mercurial.py.

Member Function Documentation

◆ 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 from VersionControl.

Definition at line 36 of file mercurial.py.

    ) -> None:
        rev_display = rev_options.to_display()
        logger.info(
            "Cloning hg %s%s to %s",
            url,
            rev_display,
            display_path(dest),
        )
        if verbosity <= 0:
            flags: Tuple[str, ...] = ("--quiet",)
        elif verbosity == 1:
            flags = ()
        elif verbosity == 2:
            flags = ("--verbose",)
        else:
            flags = ("--verbose", "--debug")
        self.run_command(make_command("clone", "--noupdate", *flags, url, dest))
        self.run_command(
            make_command("update", *flags, rev_options.to_args()),
            cwd=dest,
        )
 

References i, VersionControl.run_command(), SubprocessMixin.run_command(), and PackageIndex.run_command().

Referenced by VersionControl.obtain().

Here is the call graph for this function:

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 from VersionControl.

Definition at line 33 of file mercurial.py.

    def get_base_rev_args(rev: str) -> List[str]:
        return ["-r", rev]
 

◆ 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 from VersionControl.

Definition at line 80 of file mercurial.py.

    def get_remote_url(cls, location: str) -> str:
        url = cls.run_command(
            ["showconfig", "paths.default"],
            show_stdout=False,
            stdout_only=True,
            cwd=location,
        ).strip()
        if cls._is_local_repository(url):
            url = path_to_url(url)
        return url.strip()
 

References VersionControl._is_local_repository(), i, VersionControl.run_command(), SubprocessMixin.run_command(), and PackageIndex.run_command().

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

Here is the call graph for this function:

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 from VersionControl.

Definition at line 138 of file mercurial.py.

    def get_repository_root(cls, location: str) -> Optional[str]:
        loc = super().get_repository_root(location)
        if loc:
            return loc
        try:
            r = cls.run_command(
                ["root"],
                cwd=location,
                show_stdout=False,
                stdout_only=True,
                on_returncode="raise",
                log_failed_cmd=False,
            )
        except BadCommand:
            logger.debug(
                "could not determine if %s is under hg control "
                "because hg is not available",
                location,
            )
            return None
        except InstallationError:
            return None
        return os.path.normpath(r.rstrip("\r\n"))
 
 

References Mercurial.get_repository_root(), i, VersionControl.run_command(), SubprocessMixin.run_command(), and PackageIndex.run_command().

Referenced by Mercurial.get_repository_root().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_requirement_revision()

str get_requirement_revision	(		cls,
		str	location
	)

Return the changeset identification hash, as a 40-character
hexadecimal string

Reimplemented from VersionControl.

Definition at line 105 of file mercurial.py.

    def get_requirement_revision(cls, location: str) -> str:
        """
        Return the changeset identification hash, as a 40-character
        hexadecimal string
        """
        current_rev_hash = cls.run_command(
            ["parents", "--template={node}"],
            show_stdout=False,
            stdout_only=True,
            cwd=location,
        ).strip()
        return current_rev_hash
 

References VersionControl.run_command(), SubprocessMixin.run_command(), and PackageIndex.run_command().

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 repository-local changeset revision number, as an integer.

Reimplemented from VersionControl.

Definition at line 92 of file mercurial.py.

    def get_revision(cls, location: str) -> str:
        """
        Return the repository-local changeset revision number, as an integer.
        """
        current_revision = cls.run_command(
            ["parents", "--template={rev}"],
            show_stdout=False,
            stdout_only=True,
            cwd=location,
        ).strip()
        return current_revision
 

References VersionControl.run_command(), SubprocessMixin.run_command(), and PackageIndex.run_command().

Referenced by VersionControl.get_requirement_revision().

Here is the call graph for this function:

Here is the caller 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 from VersionControl.

Definition at line 124 of file mercurial.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.
        """
        # find the repo root
        repo_root = cls.run_command(
            ["root"], show_stdout=False, stdout_only=True, cwd=location
        ).strip()
        if not os.path.isabs(repo_root):
            repo_root = os.path.abspath(os.path.join(location, repo_root))
        return find_path_to_project_root_from_repo_root(location, repo_root)
 

References i, VersionControl.run_command(), SubprocessMixin.run_command(), and PackageIndex.run_command().

Referenced by VersionControl.get_src_requirement().

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
	)

Always assume the versions don't match

Reimplemented from VersionControl.

Definition at line 119 of file mercurial.py.

    def is_commit_id_equal(cls, dest: str, name: Optional[str]) -> bool:
        """Always assume the versions don't match"""
        return False
 

Referenced by VersionControl.obtain().

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 from VersionControl.

Definition at line 60 of file mercurial.py.

    def switch(self, dest: str, url: HiddenText, rev_options: RevOptions) -> None:
        repo_config = os.path.join(dest, self.dirname, "hgrc")
        config = configparser.RawConfigParser()
        try:
            config.read(repo_config)
            config.set("paths", "default", url.secret)
            with open(repo_config, "w") as config_file:
                config.write(config_file)
        except (OSError, configparser.NoSectionError) as exc:
            logger.warning("Could not switch Mercurial repository to %s: %s", url, exc)
        else:
            cmd_args = make_command("update", "-q", rev_options.to_args())
            self.run_command(cmd_args, cwd=dest)
 

References Bazaar.dirname, Mercurial.dirname, Subversion.dirname, VersionControl.dirname, Wheel.dirname, i, VersionControl.run_command(), SubprocessMixin.run_command(), and PackageIndex.run_command().

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 from VersionControl.

Definition at line 74 of file mercurial.py.

    def update(self, dest: str, url: HiddenText, rev_options: RevOptions) -> None:
        self.run_command(["pull", "-q"], cwd=dest)
        cmd_args = make_command("update", "-q", rev_options.to_args())
        self.run_command(cmd_args, cwd=dest)
 

References i, VersionControl.run_command(), SubprocessMixin.run_command(), and PackageIndex.run_command().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ dirname

str dirname = ".hg"

static

Definition at line 22 of file mercurial.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

str name = "hg"

static

Definition at line 21 of file mercurial.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

str repo_name = "clone"

static

Definition at line 23 of file mercurial.py.

Referenced by VersionControl.obtain().

◆ schemes

tuple schemes

static

Initial value:

=  (
        "hg+file",
        "hg+http",
        "hg+https",
        "hg+ssh",
        "hg+static-http",
    )

Definition at line 24 of file mercurial.py.

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/mercurial.py

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ fetch_new()

◆ get_base_rev_args()

◆ get_remote_url()

◆ get_repository_root()

◆ get_requirement_revision()

◆ get_revision()

◆ get_subdirectory()

◆ is_commit_id_equal()

◆ switch()

◆ update()

Field Documentation

◆ dirname

◆ name

◆ repo_name

◆ schemes