pip._internal.vcs.bazaar.Bazaar Class Reference

Inheritance diagram for pip._internal.vcs.bazaar.Bazaar:

Collaboration diagram for pip._internal.vcs.bazaar.Bazaar:

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)
Tuple[str, Optional[str], AuthInfo]	get_url_rev_and_auth (cls, str url)
str	get_remote_url (cls, str location)
str	get_revision (cls, str location)
bool	is_commit_id_equal (cls, str dest, Optional[str] name)
Public Member Functions inherited from pip._internal.vcs.versioncontrol.VersionControl
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[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)
Static Public Member Functions inherited from pip._internal.vcs.versioncontrol.VersionControl
CommandArgs	make_rev_args (Optional[str] username, Optional[HiddenText] password)
str	normalize_url (str url)

Static Public Attributes
str	name = "bzr"
str	dirname = ".bzr"
str	repo_name = "branch"
tuple	schemes
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

Additional Inherited Members
Public Attributes inherited from pip._internal.vcs.versioncontrol.VersionControl
	repo_name
	name
	dirname
Protected Member Functions inherited from pip._internal.vcs.versioncontrol.VersionControl
bool	_is_local_repository (cls, str repo)

Member Function Documentation

fetch_new()

None pip._internal.vcs.bazaar.Bazaar.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.bazaar.Bazaar.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_remote_url()

str pip._internal.vcs.bazaar.Bazaar.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.bazaar.Bazaar.get_revision	(		cls,
		str	location
	)

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

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

get_url_rev_and_auth()

Tuple[str, Optional[str], AuthInfo] pip._internal.vcs.bazaar.Bazaar.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.

is_commit_id_equal()

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

Always assume the versions don't match

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

switch()

None pip._internal.vcs.bazaar.Bazaar.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.bazaar.Bazaar.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.

Member Data Documentation

schemes

tuple pip._internal.vcs.bazaar.Bazaar.schemes

static

Initial value:

=  (
        "bzr+http",
        "bzr+https",
        "bzr+ssh",
        "bzr+sftp",
        "bzr+ftp",
        "bzr+lp",
        "bzr+file",
    )

---

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

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