BaseEnvironment Class Reference

Inheritance diagram for BaseEnvironment:

Public Member Functions
"BaseEnvironment"	default (cls)
"BaseEnvironment"	from_paths (cls, Optional[List[str]] paths)
Optional["BaseDistribution"]	get_distribution (self, str name)
Iterator[BaseDistribution]	iter_all_distributions (self)
Iterator[BaseDistribution]	iter_installed_distributions (self, bool local_only=True, Container[str] skip=stdlib_pkgs, bool include_editables=True, bool editables_only=False, bool user_only=False)

Protected Member Functions
Iterator["BaseDistribution"]	_iter_distributions (self)

Detailed Description

An environment containing distributions to introspect.

Definition at line 582 of file base.py.

Member Function Documentation

_iter_distributions()

Iterator["BaseDistribution"] _iter_distributions (   self )

protected

Iterate through installed distributions.

This function should be implemented by subclass, but never called
directly. Use the public ``iter_distribution()`` instead, which
implements additional logic to make sure the distributions are valid.

Reimplemented in Environment, and Environment.

Definition at line 601 of file base.py.

    def _iter_distributions(self) -> Iterator["BaseDistribution"]:
        """Iterate through installed distributions.
 
        This function should be implemented by subclass, but never called
        directly. Use the public ``iter_distribution()`` instead, which
        implements additional logic to make sure the distributions are valid.
        """
        raise NotImplementedError()
 

References i.

Referenced by BaseEnvironment.iter_all_distributions().

Here is the caller graph for this function:

default()

"BaseEnvironment" default

(

cls

)

Reimplemented in Environment, and Environment.

Definition at line 586 of file base.py.

    def default(cls) -> "BaseEnvironment":
        raise NotImplementedError()
 

References i.

from_paths()

"BaseEnvironment" from_paths	(		cls,
		Optional[List[str]]	paths
	)

Reimplemented in Environment, and Environment.

Definition at line 590 of file base.py.

    def from_paths(cls, paths: Optional[List[str]]) -> "BaseEnvironment":
        raise NotImplementedError()
 

References i.

get_distribution()

Optional["BaseDistribution"] get_distribution	(		self,
		str	name
	)

Given a requirement name, return the installed distributions.

The name may not be normalized. The implementation must canonicalize
it for lookup.

Reimplemented in Environment, and Environment.

Definition at line 593 of file base.py.

    def get_distribution(self, name: str) -> Optional["BaseDistribution"]:
        """Given a requirement name, return the installed distributions.
 
        The name may not be normalized. The implementation must canonicalize
        it for lookup.
        """
        raise NotImplementedError()
 

References i.

Referenced by DistributionPath.get_file_path().

Here is the caller graph for this function:

iter_all_distributions()

Iterator[BaseDistribution] iter_all_distributions

(

self

)

Iterate through all installed distributions without any filtering.

Definition at line 610 of file base.py.

    def iter_all_distributions(self) -> Iterator[BaseDistribution]:
        """Iterate through all installed distributions without any filtering."""
        for dist in self._iter_distributions():
            # Make sure the distribution actually comes from a valid Python
            # packaging distribution. Pip's AdjacentTempDirectory leaves folders
            # e.g. ``~atplotlib.dist-info`` if cleanup was interrupted. The
            # valid project name pattern is taken from PEP 508.
            project_name_valid = re.match(
                r"^([A-Z0-9]|[A-Z0-9][A-Z0-9._-]*[A-Z0-9])$",
                dist.canonical_name,
                flags=re.IGNORECASE,
            )
            if not project_name_valid:
                logger.warning(
                    "Ignoring invalid distribution %s (%s)",
                    dist.canonical_name,
                    dist.location,
                )
                continue
            yield dist
 

References BaseEnvironment._iter_distributions(), Environment._iter_distributions(), and i.

Referenced by Environment._search_distribution(), Environment.get_distribution(), and BaseEnvironment.iter_installed_distributions().

Here is the call graph for this function:

Here is the caller graph for this function:

iter_installed_distributions()

Iterator[BaseDistribution] iter_installed_distributions	(		self,
		bool	local_only = True,
		Container[str]	skip = stdlib_pkgs,
		bool	include_editables = True,
		bool	editables_only = False,
		bool	user_only = False
	)

Return a list of installed distributions.

This is based on ``iter_all_distributions()`` with additional filtering
options. Note that ``iter_installed_distributions()`` without arguments
is *not* equal to ``iter_all_distributions()``, since some of the
configurations exclude packages by default.

:param local_only: If True (default), only return installations
local to the current virtualenv, if in a virtualenv.
:param skip: An iterable of canonicalized project names to ignore;
    defaults to ``stdlib_pkgs``.
:param include_editables: If False, don't report editables.
:param editables_only: If True, only report editables.
:param user_only: If True, only report installations in the user
site directory.

Definition at line 631 of file base.py.

    ) -> Iterator[BaseDistribution]:
        """Return a list of installed distributions.
 
        This is based on ``iter_all_distributions()`` with additional filtering
        options. Note that ``iter_installed_distributions()`` without arguments
        is *not* equal to ``iter_all_distributions()``, since some of the
        configurations exclude packages by default.
 
        :param local_only: If True (default), only return installations
        local to the current virtualenv, if in a virtualenv.
        :param skip: An iterable of canonicalized project names to ignore;
            defaults to ``stdlib_pkgs``.
        :param include_editables: If False, don't report editables.
        :param editables_only: If True, only report editables.
        :param user_only: If True, only report installations in the user
        site directory.
        """
        it = self.iter_all_distributions()
        if local_only:
            it = (d for d in it if d.local)
        if not include_editables:
            it = (d for d in it if not d.editable)
        if editables_only:
            it = (d for d in it if d.editable)
        if user_only:
            it = (d for d in it if d.in_usersite)
        return (d for d in it if d.canonical_name not in skip)
 
 

References i, and BaseEnvironment.iter_all_distributions().

Here is the call graph for this function:

---

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/metadata/base.py