pip._internal.resolution.resolvelib.candidates._InstallRequirementBackedCandidate Class Reference

Inheritance diagram for pip._internal.resolution.resolvelib.candidates._InstallRequirementBackedCandidate:

Collaboration diagram for pip._internal.resolution.resolvelib.candidates._InstallRequirementBackedCandidate:

Public Member Functions
None	__init__ (self, Link link, Link source_link, InstallRequirement ireq, "Factory" factory, Optional[NormalizedName] name=None, Optional[CandidateVersion] version=None)
str	__str__ (self)
str	__repr__ (self)
int	__hash__ (self)
bool	__eq__ (self, Any other)
Optional[Link]	source_link (self)
NormalizedName	project_name (self)
str	name (self)
CandidateVersion	version (self)
str	format_for_error (self)
Iterable[Optional[Requirement]]	iter_dependencies (self, bool with_requires)
Optional[InstallRequirement]	get_install_requirement (self)
Public Member Functions inherited from pip._internal.resolution.resolvelib.base.Candidate
bool	is_installed (self)
bool	is_editable (self)

Public Attributes
	dist
	name
	version

Static Public Attributes
BaseDistribution	dist
bool	is_installed = False

Protected Member Functions
BaseDistribution	_prepare_distribution (self)
None	_check_metadata_consistency (self, BaseDistribution dist)
BaseDistribution	_prepare (self)

Protected Attributes
	_link
	_source_link
	_factory
	_ireq
	_name
	_version

Detailed Description

A candidate backed by an ``InstallRequirement``.

This represents a package request with the target not being already
in the environment, and needs to be fetched and installed. The backing
``InstallRequirement`` is responsible for most of the leg work; this
class exposes appropriate information to the resolver.

:param link: The link passed to the ``InstallRequirement``. The backing
    ``InstallRequirement`` will use this link to fetch the distribution.
:param source_link: The link this candidate "originates" from. This is
    different from ``link`` when the link is found in the wheel cache.
    ``link`` would point to the wheel cache, while this points to the
    found remote link (e.g. from pypi.org).

Member Function Documentation

_check_metadata_consistency()

None pip._internal.resolution.resolvelib.candidates._InstallRequirementBackedCandidate._check_metadata_consistency (   self, BaseDistribution  dist  )

protected

Check for consistency of project name and version of dist.

format_for_error()

str pip._internal.resolution.resolvelib.candidates._InstallRequirementBackedCandidate.format_for_error

(

self

)

Reimplemented from pip._internal.resolution.resolvelib.base.Candidate.

get_install_requirement()

Optional[InstallRequirement] pip._internal.resolution.resolvelib.candidates._InstallRequirementBackedCandidate.get_install_requirement

(

self

)

Reimplemented from pip._internal.resolution.resolvelib.base.Candidate.

iter_dependencies()

Iterable[Optional[Requirement]] pip._internal.resolution.resolvelib.candidates._InstallRequirementBackedCandidate.iter_dependencies	(		self,
		bool	with_requires
	)

Reimplemented from pip._internal.resolution.resolvelib.base.Candidate.

name()

str pip._internal.resolution.resolvelib.candidates._InstallRequirementBackedCandidate.name

(

self

)

The name identifying this candidate in the resolver.

This is different from ``project_name`` if this candidate contains
extras, where ``project_name`` would not contain the ``[...]`` part.

Reimplemented from pip._internal.resolution.resolvelib.base.Candidate.

project_name()

NormalizedName pip._internal.resolution.resolvelib.candidates._InstallRequirementBackedCandidate.project_name

(

self

)

The normalised name of the project the candidate refers to

Reimplemented from pip._internal.resolution.resolvelib.base.Candidate.

source_link()

Optional[Link] pip._internal.resolution.resolvelib.candidates._InstallRequirementBackedCandidate.source_link

(

self

)

Reimplemented from pip._internal.resolution.resolvelib.base.Candidate.

version()

CandidateVersion pip._internal.resolution.resolvelib.candidates._InstallRequirementBackedCandidate.version

(

self

)

Reimplemented from pip._internal.resolution.resolvelib.base.Candidate.

---

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

• docs/help/help-venv/lib/python3.12/site-packages/pip/_internal/resolution/resolvelib/candidates.py