pip._internal.index.package_finder.LinkEvaluator Class Reference

Public Member Functions
None	__init__ (self, str project_name, str canonical_name, FrozenSet[str] formats, TargetPython target_python, bool allow_yanked, Optional[bool] ignore_requires_python=None)
Tuple[LinkType, str]	evaluate_link (self, Link link)

Public Attributes
	project_name

Protected Attributes
	_allow_yanked
	_canonical_name
	_ignore_requires_python
	_formats
	_target_python

Static Protected Attributes
	_py_version_re = re.compile(r"-py([123]\.?[0-9]?)$")

Detailed Description

Responsible for evaluating links for a particular project.

Constructor & Destructor Documentation

__init__()

None pip._internal.index.package_finder.LinkEvaluator.__init__	(		self,
		str	project_name,
		str	canonical_name,
		FrozenSet[str]	formats,
		TargetPython	target_python,
		bool	allow_yanked,
		Optional[bool]	ignore_requires_python = None
	)

:param project_name: The user supplied package name.
:param canonical_name: The canonical package name.
:param formats: The formats allowed for this package. Should be a set
    with 'binary' or 'source' or both in it.
:param target_python: The target Python interpreter to use when
    evaluating link compatibility. This is used, for example, to
    check wheel compatibility, as well as when checking the Python
    version, e.g. the Python version embedded in a link filename
    (or egg fragment) and against an HTML link's optional PEP 503
    "data-requires-python" attribute.
:param allow_yanked: Whether files marked as yanked (in the sense
    of PEP 592) are permitted to be candidates for install.
:param ignore_requires_python: Whether to ignore incompatible
    PEP 503 "data-requires-python" values in HTML links. Defaults
    to False.

Member Function Documentation

evaluate_link()

Tuple[LinkType, str] pip._internal.index.package_finder.LinkEvaluator.evaluate_link	(		self,
		Link	link
	)

Determine whether a link is a candidate for installation.

:return: A tuple (result, detail), where *result* is an enum
    representing whether the evaluation found a candidate, or the reason
    why one is not found. If a candidate is found, *detail* will be the
    candidate's version string; if one is not found, it contains the
    reason the link fails to qualify.

---

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