Inheritance diagram for Subversion:

Collaboration diagram for Subversion:

[legend]

Public Member Functions
bool	should_add_vcs_url_prefix (cls, str remote_url)

str	get_revision (cls, str location)

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)

str	get_remote_url (cls, str location)

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

None	__init__ (self, Optional[bool] use_interactive=None)

Tuple[int,...]	call_vcs_version (self)

Tuple[int,...]	get_vcs_version (self)

CommandArgs	get_remote_call_options (self)

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)

Public Member Functions inherited from VersionControl
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[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)

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)

Static Public Member Functions inherited from VersionControl
str	normalize_url (str url)

Data Fields
	dirname

	use_interactive

Data Fields inherited from VersionControl
	repo_name

	name

	dirname

Static Public Attributes
str	name = "svn"

str	dirname = ".svn"

str	repo_name = "checkout"

tuple	schemes = ("svn+ssh", "svn+http", "svn+https", "svn+svn", "svn+file")

Static Public Attributes inherited from VersionControl
str	name = ""

str	dirname = ""

str	repo_name = ""

tuple	schemes = ()

tuple	unset_environ = ()

Optional	default_arg_rev = None

Protected Member Functions
Tuple[Optional[str], int]	_get_svn_url_rev (cls, str location)

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

Protected Attributes
	_vcs_version

Detailed Description

Definition at line 30 of file subversion.py.

Constructor & Destructor Documentation

◆ init()

None __init__	(		self,
		Optional[bool]	use_interactive = `None`
	)

Definition at line 187 of file subversion.py.

    def __init__(self, use_interactive: Optional[bool] = None) -> None:
        if use_interactive is None:
            use_interactive = is_console_interactive()
        self.use_interactive = use_interactive
 
        # This member is used to cache the fetched version of the current
        # ``svn`` client.
        # Special value definitions:
        #   None: Not evaluated yet.
        #   Empty tuple: Could not parse version.
        self._vcs_version: Optional[Tuple[int, ...]] = None
 
        super().__init__()
 

Referenced by Protocol.__init_subclass__().

Here is the caller graph for this function:

Member Function Documentation

◆ _get_svn_url_rev()

Tuple[Optional[str], int] _get_svn_url_rev	(		cls,
		str	location
	)

protected

Definition at line 133 of file subversion.py.

    def _get_svn_url_rev(cls, location: str) -> Tuple[Optional[str], int]:
        from pip._internal.exceptions import InstallationError
 
        entries_path = os.path.join(location, cls.dirname, "entries")
        if os.path.exists(entries_path):
            with open(entries_path) as f:
                data = f.read()
        else:  # subversion >= 1.7 does not have the 'entries' file
            data = ""
 
        url = None
        if data.startswith("8") or data.startswith("9") or data.startswith("10"):
            entries = list(map(str.splitlines, data.split("\n\x0c\n")))
            del entries[0][0]  # get rid of the '8'
            url = entries[0][3]
            revs = [int(d[9]) for d in entries if len(d) > 9 and d[9]] + [0]
        elif data.startswith("<?xml"):
            match = _svn_xml_url_re.search(data)
            if not match:
                raise ValueError(f"Badly formatted data: {data!r}")
            url = match.group(1)  # get repository URL
            revs = [int(m.group(1)) for m in _svn_rev_re.finditer(data)] + [0]
        else:
            try:
                # subversion >= 1.7
                # Note that using get_remote_call_options is not necessary here
                # because `svn info` is being run against a local directory.
                # We don't need to worry about making sure interactive mode
                # is being used to prompt for passwords, because passwords
                # are only potentially needed for remote server requests.
                xml = cls.run_command(
                    ["info", "--xml", location],
                    show_stdout=False,
                    stdout_only=True,
                )
                match = _svn_info_xml_url_re.search(xml)
                assert match is not None
                url = match.group(1)
                revs = [int(m.group(1)) for m in _svn_info_xml_rev_re.finditer(xml)]
            except InstallationError:
                url, revs = None, []
 
        if revs:
            rev = max(revs)
        else:
            rev = 0
 
        return url, rev
 

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

Referenced by Subversion.get_remote_url().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ call_vcs_version()

Tuple[int, ...] call_vcs_version ( self )

Query the version of the currently installed Subversion client.

:return: A tuple containing the parts of the version information or
    ``()`` if the version returned from ``svn`` could not be parsed.
:raises: BadCommand: If ``svn`` is not installed.

Definition at line 201 of file subversion.py.

    def call_vcs_version(self) -> Tuple[int, ...]:
        """Query the version of the currently installed Subversion client.
 
        :return: A tuple containing the parts of the version information or
            ``()`` if the version returned from ``svn`` could not be parsed.
        :raises: BadCommand: If ``svn`` is not installed.
        """
        # Example versions:
        #   svn, version 1.10.3 (r1842928)
        #      compiled Feb 25 2019, 14:20:39 on x86_64-apple-darwin17.0.0
        #   svn, version 1.7.14 (r1542130)
        #      compiled Mar 28 2018, 08:49:13 on x86_64-pc-linux-gnu
        #   svn, version 1.12.0-SlikSvn (SlikSvn/1.12.0)
        #      compiled May 28 2019, 13:44:56 on x86_64-microsoft-windows6.2
        version_prefix = "svn, version "
        version = self.run_command(["--version"], show_stdout=False, stdout_only=True)
        if not version.startswith(version_prefix):
            return ()
 
        version = version[len(version_prefix) :].split()[0]
        version_list = version.partition("-")[0].split(".")
        try:
            parsed_version = tuple(map(int, version_list))
        except ValueError:
            return ()
 
        return parsed_version
 

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

Referenced by Subversion.get_vcs_version().

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

Definition at line 280 of file subversion.py.

    ) -> None:
        rev_display = rev_options.to_display()
        logger.info(
            "Checking out %s%s to %s",
            url,
            rev_display,
            display_path(dest),
        )
        if verbosity <= 0:
            flag = "--quiet"
        else:
            flag = ""
        cmd_args = make_command(
            "checkout",
            flag,
            self.get_remote_call_options(),
            rev_options.to_args(),
            url,
            dest,
        )
        self.run_command(cmd_args)
 

References Subversion.get_remote_call_options(), 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 41 of file subversion.py.

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

◆ get_netloc_and_auth()

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

This override allows the auth information to be passed to svn via the
--username and --password options instead of via the URL.

Reimplemented from VersionControl.

Definition at line 74 of file subversion.py.

    ) -> Tuple[str, Tuple[Optional[str], Optional[str]]]:
        """
        This override allows the auth information to be passed to svn via the
        --username and --password options instead of via the URL.
        """
        if scheme == "ssh":
            # The --username and --password options can't be used for
            # svn+ssh URLs, so keep the auth information in the URL.
            return super().get_netloc_and_auth(netloc, scheme)
 
        return split_auth_from_netloc(netloc)
 

References Subversion.get_netloc_and_auth(), and i.

Referenced by Subversion.get_netloc_and_auth(), and VersionControl.get_url_rev_and_auth().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_remote_call_options()

CommandArgs get_remote_call_options ( self )

Return options to be used on calls to Subversion that contact the server.

These options are applicable for the following ``svn`` subcommands used
in this class.

    - checkout
    - switch
    - update

:return: A list of command line arguments to pass to ``svn``.

Definition at line 249 of file subversion.py.

    def get_remote_call_options(self) -> CommandArgs:
        """Return options to be used on calls to Subversion that contact the server.
 
        These options are applicable for the following ``svn`` subcommands used
        in this class.
 
            - checkout
            - switch
            - update
 
        :return: A list of command line arguments to pass to ``svn``.
        """
        if not self.use_interactive:
            # --non-interactive switch is available since Subversion 0.14.4.
            # Subversion < 1.8 runs in interactive mode by default.
            return ["--non-interactive"]
 
        svn_version = self.get_vcs_version()
        # By default, Subversion >= 1.8 runs in non-interactive mode if
        # stdin is not a TTY. Since that is how pip invokes SVN, in
        # call_subprocess(), pip must pass --force-interactive to ensure
        # the user can be prompted for a password, if required.
        #   SVN added the --force-interactive option in SVN 1.8. Since
        # e.g. RHEL/CentOS 7, which is supported until 2024, ships with
        # SVN 1.7, pip should continue to support SVN 1.7. Therefore, pip
        # can't safely add the option if the SVN version is < 1.8 (or unknown).
        if svn_version >= (1, 8):
            return ["--force-interactive"]
 
        return []
 

References Subversion.get_vcs_version(), and Subversion.use_interactive.

Referenced by Subversion.fetch_new(), Subversion.switch(), and Subversion.update().

Here is the call graph for this function:

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

Definition at line 109 of file subversion.py.

    def get_remote_url(cls, location: str) -> str:
        # In cases where the source is in a subdirectory, we have to look up in
        # the location until we find a valid project root.
        orig_location = location
        while not is_installable_dir(location):
            last_location = location
            location = os.path.dirname(location)
            if location == last_location:
                # We've traversed up to the root of the filesystem without
                # finding a Python project.
                logger.warning(
                    "Could not find Python project for directory %s (tried all "
                    "parent directories)",
                    orig_location,
                )
                raise RemoteNotFoundError
 
        url, _rev = cls._get_svn_url_rev(location)
        if url is None:
            raise RemoteNotFoundError
 
        return url
 

References Subversion._get_svn_url_rev(), and i.

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_revision()

str get_revision	(		cls,
		str	location
	)

Return the maximum revision for all files under a given location

Reimplemented from VersionControl.

Definition at line 45 of file subversion.py.

    def get_revision(cls, location: str) -> str:
        """
        Return the maximum revision for all files under a given location
        """
        # Note: taken from setuptools.command.egg_info
        revision = 0
 
        for base, dirs, _ in os.walk(location):
            if cls.dirname not in dirs:
                dirs[:] = []
                continue  # no sense walking uncontrolled subdirs
            dirs.remove(cls.dirname)
            entries_fn = os.path.join(base, cls.dirname, "entries")
            if not os.path.exists(entries_fn):
                # FIXME: should we warn?
                continue
 
            dirurl, localrev = cls._get_svn_url_rev(base)
 
            if base == location:
                assert dirurl is not None
                base = dirurl + "/"  # save the root url
            elif not dirurl or not dirurl.startswith(base):
                dirs[:] = []
                continue  # not part of the same svn tree, skip it
            revision = max(revision, localrev)
        return str(revision)
 

References Bazaar.dirname, Mercurial.dirname, Subversion.dirname, VersionControl.dirname, Wheel.dirname, and i.

Referenced by VersionControl.get_requirement_revision().

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

Definition at line 89 of file subversion.py.

    def get_url_rev_and_auth(cls, url: str) -> Tuple[str, Optional[str], AuthInfo]:
        # hotfix the URL scheme after removing svn+ from svn+ssh:// re-add it
        url, rev, user_pass = super().get_url_rev_and_auth(url)
        if url.startswith("ssh://"):
            url = "svn+" + url
        return url, rev, user_pass
 

References Subversion.get_url_rev_and_auth(), and i.

Referenced by Subversion.get_url_rev_and_auth(), and VersionControl.get_url_rev_options().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_vcs_version()

Tuple[int, ...] get_vcs_version ( self )

Return the version of the currently installed Subversion client.

If the version of the Subversion client has already been queried,
a cached value will be used.

:return: A tuple containing the parts of the version information or
    ``()`` if the version returned from ``svn`` could not be parsed.
:raises: BadCommand: If ``svn`` is not installed.

Definition at line 229 of file subversion.py.

    def get_vcs_version(self) -> Tuple[int, ...]:
        """Return the version of the currently installed Subversion client.
 
        If the version of the Subversion client has already been queried,
        a cached value will be used.
 
        :return: A tuple containing the parts of the version information or
            ``()`` if the version returned from ``svn`` could not be parsed.
        :raises: BadCommand: If ``svn`` is not installed.
        """
        if self._vcs_version is not None:
            # Use cached version, if available.
            # If parsing the version failed previously (empty tuple),
            # do not attempt to parse it again.
            return self._vcs_version
 
        vcs_version = self.call_vcs_version()
        self._vcs_version = vcs_version
        return vcs_version
 

References Subversion._vcs_version, and Subversion.call_vcs_version().

Referenced by Subversion.get_remote_call_options().

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 183 of file subversion.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:

◆ make_rev_args()

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

static

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

Reimplemented from VersionControl.

Definition at line 97 of file subversion.py.

    ) -> CommandArgs:
        extra_args: CommandArgs = []
        if username:
            extra_args += ["--username", username]
        if password:
            extra_args += ["--password", password]
 
        return extra_args
 

Referenced by VersionControl.get_url_rev_options().

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

Definition at line 37 of file subversion.py.

    def should_add_vcs_url_prefix(cls, remote_url: str) -> bool:
        return True
 

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

Definition at line 304 of file subversion.py.

    def switch(self, dest: str, url: HiddenText, rev_options: RevOptions) -> None:
        cmd_args = make_command(
            "switch",
            self.get_remote_call_options(),
            rev_options.to_args(),
            url,
            dest,
        )
        self.run_command(cmd_args)
 

References Subversion.get_remote_call_options(), 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 314 of file subversion.py.

    def update(self, dest: str, url: HiddenText, rev_options: RevOptions) -> None:
        cmd_args = make_command(
            "update",
            self.get_remote_call_options(),
            rev_options.to_args(),
            dest,
        )
        self.run_command(cmd_args)
 
 

References Subversion.get_remote_call_options(), 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

◆ _vcs_version

_vcs_version

protected

Definition at line 246 of file subversion.py.

Referenced by Subversion.get_vcs_version().

◆ dirname [1/2]

str dirname = ".svn"

static

Definition at line 32 of file subversion.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 56 of file subversion.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 = "svn"

static

Definition at line 31 of file subversion.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 = "checkout"

static

Definition at line 33 of file subversion.py.

Referenced by VersionControl.obtain().

◆ schemes

tuple schemes = ("svn+ssh", "svn+http", "svn+https", "svn+svn", "svn+file")

static

Definition at line 34 of file subversion.py.

◆ use_interactive

use_interactive

Definition at line 190 of file subversion.py.

Referenced by Subversion.get_remote_call_options().

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

Public Member Functions

Static Public Member Functions

Data Fields

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _get_svn_url_rev()

◆ call_vcs_version()

◆ fetch_new()

◆ get_base_rev_args()

◆ get_netloc_and_auth()

◆ get_remote_call_options()

◆ get_remote_url()

◆ get_revision()

◆ get_url_rev_and_auth()

◆ get_vcs_version()

◆ is_commit_id_equal()

◆ make_rev_args()

◆ should_add_vcs_url_prefix()

◆ switch()

◆ update()

Field Documentation

◆ _vcs_version

◆ dirname [1/2]

◆ dirname [2/2]

◆ name

◆ repo_name

◆ schemes

◆ use_interactive

◆ init()