Inheritance diagram for Bazaar:

Collaboration diagram for Bazaar:

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

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 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 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 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 18 of file bazaar.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 bazaar.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"
        elif verbosity == 1:
            flag = ""
        else:
            flag = f"-{'v'*verbosity}"
        cmd_args = make_command(
            "checkout", "--lightweight", flag, rev_options.to_args(), url, dest
        )
        self.run_command(cmd_args)
 

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 bazaar.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 82 of file bazaar.py.

    def get_remote_url(cls, location: str) -> str:
        urls = cls.run_command(
            ["info"], show_stdout=False, stdout_only=True, cwd=location
        )
        for line in urls.splitlines():
            line = line.strip()
            for x in ("checkout of branch: ", "parent branch: "):
                if line.startswith(x):
                    repo = line.split(x)[1]
                    if cls._is_local_repository(repo):
                        return path_to_url(repo)
                    return repo
        raise RemoteNotFoundError
 

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

str get_revision	(		cls,
		str	location
	)

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

Reimplemented from VersionControl.

Definition at line 97 of file bazaar.py.

    def get_revision(cls, location: str) -> str:
        revision = cls.run_command(
            ["revno"],
            show_stdout=False,
            stdout_only=True,
            cwd=location,
        )
        return revision.splitlines()[-1]
 

References i, 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_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 74 of file bazaar.py.

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

References Bazaar.get_url_rev_and_auth(), and i.

Referenced by Bazaar.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:

◆ 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 107 of file bazaar.py.

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

References i.

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 57 of file bazaar.py.

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

References 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 60 of file bazaar.py.

    def update(self, dest: str, url: HiddenText, rev_options: RevOptions) -> None:
        output = self.run_command(
            make_command("info"), show_stdout=False, stdout_only=True, cwd=dest
        )
        if output.startswith("Standalone "):
            # Older versions of pip used to create standalone branches.
            # Convert the standalone branch to a checkout by calling "bzr bind".
            cmd_args = make_command("bind", "-q", url)
            self.run_command(cmd_args, 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 = ".bzr"

static

Definition at line 20 of file bazaar.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 = "bzr"

static

Definition at line 19 of file bazaar.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 = "branch"

static

Definition at line 21 of file bazaar.py.

Referenced by VersionControl.obtain().

◆ schemes

tuple schemes

static

Initial value:

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

Definition at line 22 of file bazaar.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/bazaar.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_revision()

◆ get_url_rev_and_auth()

◆ is_commit_id_equal()

◆ switch()

◆ update()

Field Documentation

◆ dirname

◆ name

◆ repo_name

◆ schemes