pip._internal.metadata.pkg_resources.Environment Class Reference

Inheritance diagram for pip._internal.metadata.pkg_resources.Environment:

Collaboration diagram for pip._internal.metadata.pkg_resources.Environment:

Public Member Functions
None	__init__ (self, pkg_resources.WorkingSet ws)
BaseEnvironment	default (cls)
BaseEnvironment	from_paths (cls, Optional[List[str]] paths)
Optional[BaseDistribution]	get_distribution (self, str name)
Public Member Functions inherited from pip._internal.metadata.base.BaseEnvironment
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)
Optional[BaseDistribution]	_search_distribution (self, str name)

Protected Attributes
	_ws

Member Function Documentation

_iter_distributions()

Iterator[BaseDistribution] pip._internal.metadata.pkg_resources.Environment._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 from pip._internal.metadata.base.BaseEnvironment.

_search_distribution()

Optional[BaseDistribution] pip._internal.metadata.pkg_resources.Environment._search_distribution (   self, str  name  )

protected

Find a distribution matching the ``name`` in the environment.

This searches from *all* distributions available in the environment, to
match the behavior of ``pkg_resources.get_distribution()``.

default()

BaseEnvironment pip._internal.metadata.pkg_resources.Environment.default

(

cls

)

Reimplemented from pip._internal.metadata.base.BaseEnvironment.

from_paths()

BaseEnvironment pip._internal.metadata.pkg_resources.Environment.from_paths	(		cls,
		Optional[List[str]]	paths
	)

Reimplemented from pip._internal.metadata.base.BaseEnvironment.

get_distribution()

Optional[BaseDistribution] pip._internal.metadata.pkg_resources.Environment.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 from pip._internal.metadata.base.BaseEnvironment.

---

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

• docs/help/help-venv/lib/python3.12/site-packages/pip/_internal/metadata/pkg_resources.py