pip._internal.resolution.resolvelib.candidates Namespace Reference

Data Structures
class	_InstallRequirementBackedCandidate
class	AlreadyInstalledCandidate
class	EditableCandidate
class	ExtrasCandidate
class	LinkCandidate
class	RequiresPythonCandidate

Functions
Optional[BaseCandidate]	as_base_candidate (Candidate candidate)
InstallRequirement	make_install_req_from_link (Link link, InstallRequirement template)
InstallRequirement	make_install_req_from_editable (Link link, InstallRequirement template)
InstallRequirement	_make_install_req_from_dist (BaseDistribution dist, InstallRequirement template)

Variables
	logger = logging.getLogger(__name__)
	BaseCandidate
	REQUIRES_PYTHON_IDENTIFIER = cast(NormalizedName, "<Python from Requires-Python>")

Function Documentation

_make_install_req_from_dist()

InstallRequirement _make_install_req_from_dist ( BaseDistribution  dist, InstallRequirement   template  )

protected

Definition at line 98 of file candidates.py.

) -> InstallRequirement:
    if template.req:
        line = str(template.req)
    elif template.link:
        line = f"{dist.canonical_name} @ {template.link.url}"
    else:
        line = f"{dist.canonical_name}=={dist.version}"
    ireq = install_req_from_line(
        line,
        user_supplied=template.user_supplied,
        comes_from=template.comes_from,
        use_pep517=template.use_pep517,
        isolated=template.isolated,
        constraint=template.constraint,
        global_options=template.global_options,
        hash_options=template.hash_options,
        config_settings=template.config_settings,
    )
    ireq.satisfied_by = dist
    return ireq
 
 

References i.

as_base_candidate()

Optional[BaseCandidate] as_base_candidate

(

Candidate

candidate

)

The runtime version of BaseCandidate.

Definition at line 41 of file candidates.py.

def as_base_candidate(candidate: Candidate) -> Optional[BaseCandidate]:
    """The runtime version of BaseCandidate."""
    base_candidate_classes = (
        AlreadyInstalledCandidate,
        EditableCandidate,
        LinkCandidate,
    )
    if isinstance(candidate, base_candidate_classes):
        return candidate
    return None
 
 

References i.

make_install_req_from_editable()

InstallRequirement make_install_req_from_editable	(	Link	link,
		InstallRequirement	template
	)

Definition at line 78 of file candidates.py.

) -> InstallRequirement:
    assert template.editable, "template not editable"
    ireq = install_req_from_editable(
        link.url,
        user_supplied=template.user_supplied,
        comes_from=template.comes_from,
        use_pep517=template.use_pep517,
        isolated=template.isolated,
        constraint=template.constraint,
        permit_editable_wheels=template.permit_editable_wheels,
        global_options=template.global_options,
        hash_options=template.hash_options,
        config_settings=template.config_settings,
    )
    ireq.extras = template.extras
    return ireq
 
 

References i.

Referenced by EditableCandidate.__init__().

Here is the caller graph for this function:

make_install_req_from_link()

InstallRequirement make_install_req_from_link	(	Link	link,
		InstallRequirement	template
	)

Definition at line 53 of file candidates.py.

) -> InstallRequirement:
    assert not template.editable, "template is editable"
    if template.req:
        line = str(template.req)
    else:
        line = link.url
    ireq = install_req_from_line(
        line,
        user_supplied=template.user_supplied,
        comes_from=template.comes_from,
        use_pep517=template.use_pep517,
        isolated=template.isolated,
        constraint=template.constraint,
        global_options=template.global_options,
        hash_options=template.hash_options,
        config_settings=template.config_settings,
    )
    ireq.original_link = template.original_link
    ireq.link = link
    ireq.extras = template.extras
    return ireq
 
 

References i.

Referenced by LinkCandidate.__init__().

Here is the caller graph for this function:

Variable Documentation

BaseCandidate

BaseCandidate

Initial value:

=  Union[
    "AlreadyInstalledCandidate",
    "EditableCandidate",
    "LinkCandidate",
]

Definition at line 31 of file candidates.py.

logger

logger = logging.getLogger(__name__)

Definition at line 29 of file candidates.py.

REQUIRES_PYTHON_IDENTIFIER

REQUIRES_PYTHON_IDENTIFIER = cast(NormalizedName, "<Python from Requires-Python>")

Definition at line 38 of file candidates.py.