pip._internal.vcs.subversion.Subversion Class Reference

Inheritance diagram for pip._internal.vcs.subversion.Subversion:

Collaboration diagram for pip._internal.vcs.subversion.Subversion:

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 pip._internal.vcs.versioncontrol.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 pip._internal.vcs.versioncontrol.VersionControl
str	normalize_url (str url)

Public Attributes
	dirname
	use_interactive
Public Attributes inherited from pip._internal.vcs.versioncontrol.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 pip._internal.vcs.versioncontrol.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 pip._internal.vcs.versioncontrol.VersionControl
bool	_is_local_repository (cls, str repo)

Protected Attributes
	_vcs_version

Member Function Documentation

call_vcs_version()

Tuple[int, ...] pip._internal.vcs.subversion.Subversion.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.

fetch_new()

None pip._internal.vcs.subversion.Subversion.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 pip._internal.vcs.versioncontrol.VersionControl.

get_base_rev_args()

List[str] pip._internal.vcs.subversion.Subversion.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 pip._internal.vcs.versioncontrol.VersionControl.

get_netloc_and_auth()

Tuple[str, Tuple[Optional[str], Optional[str]]] pip._internal.vcs.subversion.Subversion.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 pip._internal.vcs.versioncontrol.VersionControl.

get_remote_call_options()

CommandArgs pip._internal.vcs.subversion.Subversion.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``.

get_remote_url()

str pip._internal.vcs.subversion.Subversion.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 pip._internal.vcs.versioncontrol.VersionControl.

get_revision()

str pip._internal.vcs.subversion.Subversion.get_revision	(		cls,
		str	location
	)

Return the maximum revision for all files under a given location

Reimplemented from pip._internal.vcs.versioncontrol.VersionControl.

get_url_rev_and_auth()

Tuple[str, Optional[str], AuthInfo] pip._internal.vcs.subversion.Subversion.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 pip._internal.vcs.versioncontrol.VersionControl.

get_vcs_version()

Tuple[int, ...] pip._internal.vcs.subversion.Subversion.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.

is_commit_id_equal()

bool pip._internal.vcs.subversion.Subversion.is_commit_id_equal	(		cls,
		str	dest,
		Optional[str]	name
	)

Always assume the versions don't match

Reimplemented from pip._internal.vcs.versioncontrol.VersionControl.

make_rev_args()

CommandArgs pip._internal.vcs.subversion.Subversion.make_rev_args ( Optional[str]  username, Optional[HiddenText]   password  )

static

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

Reimplemented from pip._internal.vcs.versioncontrol.VersionControl.

should_add_vcs_url_prefix()

bool pip._internal.vcs.subversion.Subversion.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 pip._internal.vcs.versioncontrol.VersionControl.

switch()

None pip._internal.vcs.subversion.Subversion.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 pip._internal.vcs.versioncontrol.VersionControl.

update()

None pip._internal.vcs.subversion.Subversion.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 pip._internal.vcs.versioncontrol.VersionControl.

---

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

• docs/help/help-venv/lib/python3.12/site-packages/pip/_internal/vcs/subversion.py