pip._internal.resolution.resolvelib.factory.Factory Class Reference

Public Member Functions
None	__init__ (self, PackageFinder finder, RequirementPreparer preparer, InstallRequirementProvider make_install_req, Optional[WheelCache] wheel_cache, bool use_user_site, bool force_reinstall, bool ignore_installed, bool ignore_requires_python, Optional[Tuple[int,...]] py_version_info=None)
bool	force_reinstall (self)
Iterable[Candidate]	find_candidates (self, str identifier, Mapping[str, Iterable[Requirement]] requirements, Mapping[str, Iterator[Candidate]] incompatibilities, Constraint constraint, bool prefers_installed)
CollectedRootRequirements	collect_root_requirements (self, List[InstallRequirement] root_ireqs)
ExplicitRequirement	make_requirement_from_candidate (self, Candidate candidate)
Iterator[Requirement]	make_requirements_from_spec (self, str specifier, Optional[InstallRequirement] comes_from, Iterable[str] requested_extras=())
Optional[Requirement]	make_requires_python_requirement (self, SpecifierSet specifier)
Optional[CacheEntry]	get_wheel_cache_entry (self, Link link, Optional[str] name)
Optional[BaseDistribution]	get_dist_to_uninstall (self, Candidate candidate)
InstallationError	get_installation_error (self, "ResolutionImpossible[Requirement, Candidate]" e, Dict[str, Constraint] constraints)

Public Attributes
	preparer

Protected Member Functions
None	_fail_if_link_is_unsupported_wheel (self, Link link)
ExtrasCandidate	_make_extras_candidate (self, BaseCandidate base, FrozenSet[str] extras, *Optional[InstallRequirement] comes_from=None)
Candidate	_make_candidate_from_dist (self, BaseDistribution dist, FrozenSet[str] extras, InstallRequirement template)
Optional[Candidate]	_make_candidate_from_link (self, Link link, FrozenSet[str] extras, InstallRequirement template, Optional[NormalizedName] name, Optional[CandidateVersion] version)
Optional[BaseCandidate]	_make_base_candidate_from_link (self, Link link, InstallRequirement template, Optional[NormalizedName] name, Optional[CandidateVersion] version)
Iterable[Candidate]	_iter_found_candidates (self, Sequence[InstallRequirement] ireqs, SpecifierSet specifier, Hashes hashes, bool prefers_installed, Set[int] incompatible_ids)
Iterator[Candidate]	_iter_explicit_candidates_from_base (self, Iterable[Requirement] base_requirements, FrozenSet[str] extras)
Iterator[Candidate]	_iter_candidates_from_constraints (self, str identifier, Constraint constraint, InstallRequirement template)
Iterator[Requirement]	_make_requirements_from_install_req (self, InstallRequirement ireq, Iterable[str] requested_extras)
UnsupportedPythonVersion	_report_requires_python_error (self, Sequence["ConflictCause"] causes)
DistributionNotFound	_report_single_requirement_conflict (self, Requirement req, Optional[Candidate] parent)

Protected Attributes
	_finder
	_wheel_cache
	_python_candidate
	_make_install_req_from_spec
	_use_user_site
	_force_reinstall
	_ignore_requires_python
	_installed_dists
	_make_candidate_from_link

Member Function Documentation

_iter_candidates_from_constraints()

Iterator[Candidate] pip._internal.resolution.resolvelib.factory.Factory._iter_candidates_from_constraints (   self, str  identifier, Constraint  constraint, InstallRequirement  template  )

protected

Produce explicit candidates from constraints.

This creates "fake" InstallRequirement objects that are basically clones
of what "should" be the template, but with original_link set to link.

_iter_explicit_candidates_from_base()

Iterator[Candidate] pip._internal.resolution.resolvelib.factory.Factory._iter_explicit_candidates_from_base (   self, Iterable[Requirement]  base_requirements, FrozenSet[str]  extras  )

protected

Produce explicit candidates from the base given an extra-ed package.

:param base_requirements: Requirements known to the resolver. The
    requirements are guaranteed to not have extras.
:param extras: The extras to inject into the explicit requirements'
    candidates.

_make_requirements_from_install_req()

Iterator[Requirement] pip._internal.resolution.resolvelib.factory.Factory._make_requirements_from_install_req (   self, InstallRequirement  ireq, Iterable[str]   requested_extras  )

protected

Returns requirement objects associated with the given InstallRequirement. In
most cases this will be a single object but the following special cases exist:
    - the InstallRequirement has markers that do not apply -> result is empty
    - the InstallRequirement has both a constraint (or link) and extras
        -> result is split in two requirement objects: one with the constraint
        (or link) and one with the extra. This allows centralized constraint
        handling for the base, resulting in fewer candidate rejections.

get_wheel_cache_entry()

Optional[CacheEntry] pip._internal.resolution.resolvelib.factory.Factory.get_wheel_cache_entry	(		self,
		Link	link,
		Optional[str]	name
	)

Look up the link in the wheel cache.

If ``preparer.require_hashes`` is True, don't use the wheel cache,
because cached wheels, always built locally, have different hashes
than the files downloaded from the index server and thus throw false
hash mismatches. Furthermore, cached wheels at present have
nondeterministic contents due to file modification times.

make_requirements_from_spec()

Iterator[Requirement] pip._internal.resolution.resolvelib.factory.Factory.make_requirements_from_spec	(		self,
		str	specifier,
		Optional[InstallRequirement]	comes_from,
		Iterable[str]	requested_extras = ()
	)

Returns requirement objects associated with the given specifier. In most cases
this will be a single object but the following special cases exist:
    - the specifier has markers that do not apply -> result is empty
    - the specifier has both a constraint and extras -> result is split
        in two requirement objects: one with the constraint and one with the
        extra. This allows centralized constraint handling for the base,
        resulting in fewer candidate rejections.

---

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

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