pip._internal.index.package_finder.PackageFinder Class Reference

Public Member Functions
None	__init__ (self, LinkCollector link_collector, TargetPython target_python, bool allow_yanked, Optional[FormatControl] format_control=None, Optional[CandidatePreferences] candidate_prefs=None, Optional[bool] ignore_requires_python=None)
"PackageFinder"	create (cls, LinkCollector link_collector, SelectionPreferences selection_prefs, Optional[TargetPython] target_python=None)
TargetPython	target_python (self)
SearchScope	search_scope (self)
None	search_scope (self, SearchScope search_scope)
List[str]	find_links (self)
List[str]	index_urls (self)
Iterable[str]	trusted_hosts (self)
bool	allow_all_prereleases (self)
None	set_allow_all_prereleases (self)
bool	prefer_binary (self)
None	set_prefer_binary (self)
List[str]	requires_python_skipped_reasons (self)
LinkEvaluator	make_link_evaluator (self, str project_name)
Optional[InstallationCandidate]	get_install_candidate (self, LinkEvaluator link_evaluator, Link link)
List[InstallationCandidate]	evaluate_links (self, LinkEvaluator link_evaluator, Iterable[Link] links)
List[InstallationCandidate]	process_project_url (self, Link project_url, LinkEvaluator link_evaluator)
List[InstallationCandidate]	find_all_candidates (self, str project_name)
CandidateEvaluator	make_candidate_evaluator (self, str project_name, Optional[specifiers.BaseSpecifier] specifier=None, Optional[Hashes] hashes=None)
BestCandidateResult	find_best_candidate (self, str project_name, Optional[specifiers.BaseSpecifier] specifier=None, Optional[Hashes] hashes=None)
Optional[InstallationCandidate]	find_requirement (self, InstallRequirement req, bool upgrade)

Public Attributes
	format_control
	process_project_url

Protected Member Functions
List[Link]	_sort_links (self, Iterable[Link] links)
None	_log_skipped_link (self, Link link, LinkType result, str detail)

Protected Attributes
	_allow_yanked
	_candidate_prefs
	_ignore_requires_python
	_link_collector
	_target_python

Detailed Description

This finds packages.

This is meant to match easy_install's technique for looking for
packages, by reading pages and looking for appropriate links.

Constructor & Destructor Documentation

__init__()

None pip._internal.index.package_finder.PackageFinder.__init__	(		self,
		LinkCollector	link_collector,
		TargetPython	target_python,
		bool	allow_yanked,
		Optional[FormatControl]	format_control = None,
		Optional[CandidatePreferences]	candidate_prefs = None,
		Optional[bool]	ignore_requires_python = None
	)

This constructor is primarily meant to be used by the create() class
method and from tests.

:param format_control: A FormatControl object, used to control
    the selection of source packages / binary packages when consulting
    the index and links.
:param candidate_prefs: Options to use when creating a
    CandidateEvaluator object.

Member Function Documentation

_sort_links()

List[Link] pip._internal.index.package_finder.PackageFinder._sort_links (   self, Iterable[Link]  links  )

protected

Returns elements of links in order, non-egg links first, egg links
second, while eliminating duplicates

create()

"PackageFinder" pip._internal.index.package_finder.PackageFinder.create	(		cls,
		LinkCollector	link_collector,
		SelectionPreferences	selection_prefs,
		Optional[TargetPython]	target_python = None
	)

Create a PackageFinder.

:param selection_prefs: The candidate selection preferences, as a
    SelectionPreferences object.
:param target_python: The target Python interpreter to use when
    checking compatibility. If None (the default), a TargetPython
    object will be constructed from the running Python.

evaluate_links()

List[InstallationCandidate] pip._internal.index.package_finder.PackageFinder.evaluate_links	(		self,
		LinkEvaluator	link_evaluator,
		Iterable[Link]	links
	)

Convert links that are candidates to InstallationCandidate objects.

find_all_candidates()

List[InstallationCandidate] pip._internal.index.package_finder.PackageFinder.find_all_candidates	(		self,
		str	project_name
	)

Find all available InstallationCandidate for project_name

This checks index_urls and find_links.
All versions found are returned as an InstallationCandidate list.

See LinkEvaluator.evaluate_link() for details on which files
are accepted.

find_best_candidate()

BestCandidateResult pip._internal.index.package_finder.PackageFinder.find_best_candidate	(		self,
		str	project_name,
		Optional[specifiers.BaseSpecifier]	specifier = None,
		Optional[Hashes]	hashes = None
	)

Find matches for the given project and specifier.

:param specifier: An optional object implementing `filter`
    (e.g. `packaging.specifiers.SpecifierSet`) to filter applicable
    versions.

:return: A `BestCandidateResult` instance.

find_requirement()

Optional[InstallationCandidate] pip._internal.index.package_finder.PackageFinder.find_requirement	(		self,
		InstallRequirement	req,
		bool	upgrade
	)

Try to find a Link matching req

Expects req, an InstallRequirement and upgrade, a boolean
Returns a InstallationCandidate if found,
Raises DistributionNotFound or BestVersionAlreadyInstalled otherwise

get_install_candidate()

Optional[InstallationCandidate] pip._internal.index.package_finder.PackageFinder.get_install_candidate	(		self,
		LinkEvaluator	link_evaluator,
		Link	link
	)

If the link is a candidate for install, convert it to an
InstallationCandidate and return it. Otherwise, return None.

make_candidate_evaluator()

CandidateEvaluator pip._internal.index.package_finder.PackageFinder.make_candidate_evaluator	(		self,
		str	project_name,
		Optional[specifiers.BaseSpecifier]	specifier = None,
		Optional[Hashes]	hashes = None
	)

Create a CandidateEvaluator object to use.

---

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

• docs/help/help-venv/lib/python3.12/site-packages/pip/_internal/index/package_finder.py