Inheritance diagram for Link:

Collaboration diagram for Link:

Public Member Functions
None	__init__ (self, str url, Optional[Union[str, "IndexContent"]] comes_from=None, Optional[str] requires_python=None, Optional[str] yanked_reason=None, Optional[MetadataFile] metadata_file_data=None, bool cache_link_parsing=True, Optional[Mapping[str, str]] hashes=None)

Optional["Link"]	from_json (cls, Dict[str, Any] file_data, str page_url)

Optional["Link"]	from_element (cls, Dict[str, Optional[str]] anchor_attribs, str page_url, str base_url)

str	__str__ (self)

str	__repr__ (self)

str	url (self)

str	filename (self)

str	file_path (self)

str	scheme (self)

str	netloc (self)

str	path (self)

Tuple[str, str]	splitext (self)

str	ext (self)

str	url_without_fragment (self)

Optional[str]	subdirectory_fragment (self)

Optional["Link"]	metadata_link (self)

Hashes	as_hashes (self)

Optional[str]	hash (self)

Optional[str]	hash_name (self)

str	show_url (self)

bool	is_file (self)

bool	is_existing_dir (self)

bool	is_wheel (self)

bool	is_vcs (self)

bool	is_yanked (self)

bool	has_hash (self)

bool	is_hash_allowed (self, Optional[Hashes] hashes)

Public Member Functions inherited from KeyBasedCompareMixin
int	__hash__ (self)

bool	__lt__ (self, Any other)

bool	__le__ (self, Any other)

bool	__gt__ (self, Any other)

bool	__ge__ (self, Any other)

bool	__eq__ (self, Any other)

Data Fields
	comes_from

	requires_python

	yanked_reason

	metadata_file_data

	cache_link_parsing

	egg_fragment

	url

	scheme

	file_path

	ext

Protected Member Functions
Optional[str]	_egg_fragment (self)

Protected Member Functions inherited from KeyBasedCompareMixin
bool	_compare (self, Any other, Callable[[Any, Any], bool] method)

Protected Attributes
	_parsed_url

	_url

	_hashes

Protected Attributes inherited from KeyBasedCompareMixin
	_compare_key

	_defining_class

Static Protected Attributes
	_egg_fragment_re = re.compile(r"[#&]egg=([^&]*)")

	_project_name_re

	_subdirectory_fragment_re = re.compile(r"[#&]subdirectory=([^&]*)")

Detailed Description

Represents a parsed link from a Package Index's simple URL

Definition at line 182 of file link.py.

Constructor & Destructor Documentation

◆ init()

None __init__	(		self,
		str	url,
		Optional[Union[str, "IndexContent"]]	comes_from = `None`,
		Optional[str]	requires_python = `None`,
		Optional[str]	yanked_reason = `None`,
		Optional[MetadataFile]	metadata_file_data = `None`,
		bool	cache_link_parsing = `True`,
		Optional[Mapping[str, str]]	hashes = `None`
	)

:param url: url of the resource pointed to (href of the link)
:param comes_from: instance of IndexContent where the link was found,
    or string.
:param requires_python: String containing the `Requires-Python`
    metadata field, specified in PEP 345. This may be specified by
    a data-requires-python attribute in the HTML link tag, as
    described in PEP 503.
:param yanked_reason: the reason the file has been yanked, if the
    file has been yanked, or None if the file hasn't been yanked.
    This is the value of the "data-yanked" attribute, if present, in
    a simple repository HTML link. If the file has been yanked but
    no reason was provided, this should be the empty string. See
    PEP 592 for more information and the specification.
:param metadata_file_data: the metadata attached to the file, or None if
    no such metadata is provided. This argument, if not None, indicates
    that a separate metadata file exists, and also optionally supplies
    hashes for that file.
:param cache_link_parsing: A flag that is used elsewhere to determine
    whether resources retrieved from this link should be cached. PyPI
    URLs should generally have this set to False, for example.
:param hashes: A mapping of hash names to digests to allow us to
    determine the validity of a download.

Reimplemented from KeyBasedCompareMixin.

Definition at line 197 of file link.py.

    ) -> None:
        """
        :param url: url of the resource pointed to (href of the link)
        :param comes_from: instance of IndexContent where the link was found,
            or string.
        :param requires_python: String containing the `Requires-Python`
            metadata field, specified in PEP 345. This may be specified by
            a data-requires-python attribute in the HTML link tag, as
            described in PEP 503.
        :param yanked_reason: the reason the file has been yanked, if the
            file has been yanked, or None if the file hasn't been yanked.
            This is the value of the "data-yanked" attribute, if present, in
            a simple repository HTML link. If the file has been yanked but
            no reason was provided, this should be the empty string. See
            PEP 592 for more information and the specification.
        :param metadata_file_data: the metadata attached to the file, or None if
            no such metadata is provided. This argument, if not None, indicates
            that a separate metadata file exists, and also optionally supplies
            hashes for that file.
        :param cache_link_parsing: A flag that is used elsewhere to determine
            whether resources retrieved from this link should be cached. PyPI
            URLs should generally have this set to False, for example.
        :param hashes: A mapping of hash names to digests to allow us to
            determine the validity of a download.
        """
 
        # The comes_from, requires_python, and metadata_file_data arguments are
        # only used by classmethods of this class, and are not used in client
        # code directly.
 
        # url can be a UNC windows share
        if url.startswith("\\\\"):
            url = path_to_url(url)
 
        self._parsed_url = urllib.parse.urlsplit(url)
        # Store the url as a private attribute to prevent accidentally
        # trying to set a new value.
        self._url = url
 
        link_hash = LinkHash.find_hash_url_fragment(url)
        hashes_from_link = {} if link_hash is None else link_hash.as_dict()
        if hashes is None:
            self._hashes = hashes_from_link
        else:
            self._hashes = {**hashes, **hashes_from_link}
 
        self.comes_from = comes_from
        self.requires_python = requires_python if requires_python else None
        self.yanked_reason = yanked_reason
        self.metadata_file_data = metadata_file_data
 
        super().__init__(key=url, defining_class=Link)
 
        self.cache_link_parsing = cache_link_parsing
        self.egg_fragment = self._egg_fragment()
 

References i.

Referenced by Protocol.__init_subclass__().

Here is the caller graph for this function:

Member Function Documentation

◆ repr()

str __repr__ ( self )

Definition at line 377 of file link.py.

    def __repr__(self) -> str:
        return f"<Link {self}>"
 

◆ str()

str __str__ ( self )

Definition at line 365 of file link.py.

    def __str__(self) -> str:
        if self.requires_python:
            rp = f" (requires-python:{self.requires_python})"
        else:
            rp = ""
        if self.comes_from:
            return "{} (from {}){}".format(
                redact_auth_from_url(self._url), self.comes_from, rp
            )
        else:
            return redact_auth_from_url(str(self._url))
 

References Link._url, LazyZipOverHTTP._url, Link.comes_from, ParsedRequirement.comes_from, InstallRequirement.comes_from, BaseDistribution.requires_python(), and Link.requires_python.

Here is the call graph for this function:

◆ _egg_fragment()

Optional[str] _egg_fragment ( self )

protected

Definition at line 436 of file link.py.

    def _egg_fragment(self) -> Optional[str]:
        match = self._egg_fragment_re.search(self._url)
        if not match:
            return None
 
        # An egg fragment looks like a PEP 508 project name, along with
        # an optional extras specifier. Anything else is invalid.
        project_name = match.group(1)
        if not self._project_name_re.match(project_name):
            deprecated(
                reason=f"{self} contains an egg fragment with a non-PEP 508 name",
                replacement="to use the req @ url syntax, and remove the egg fragment",
                gone_in="25.0",
                issue=11617,
            )
 
        return project_name
 

References Link._egg_fragment_re, Link._project_name_re, Link._url, LazyZipOverHTTP._url, and i.

◆ as_hashes()

Hashes as_hashes ( self )

Definition at line 472 of file link.py.

    def as_hashes(self) -> Hashes:
        return Hashes({k: [v] for k, v in self._hashes.items()})
 

References CandidateEvaluator._hashes, and Link._hashes.

◆ ext()

str ext ( self )

Definition at line 421 of file link.py.

    def ext(self) -> str:
        return self.splitext()[1]
 

References Link.splitext().

Here is the call graph for this function:

◆ file_path()

str file_path ( self )

Definition at line 399 of file link.py.

    def file_path(self) -> str:
        return url_to_path(self.url)
 

◆ filename()

str filename ( self )

Definition at line 385 of file link.py.

    def filename(self) -> str:
        path = self.path.rstrip("/")
        name = posixpath.basename(path)
        if not name:
            # Make sure we don't leak auth information if the netloc
            # includes a username and password.
            netloc, user_pass = split_auth_from_netloc(self.netloc)
            return netloc
 
        name = urllib.parse.unquote(name)
        assert name, f"URL {self._url!r} produced no filename"
        return name
 

References i, PackageIndex.netloc, Link.netloc(), Url.netloc(), _Prefix.path, Link.path(), File.path, TempDirectory.path(), _Cache.path, DistributionPath.path, BaseInstalledDistribution.path, InstalledDistribution.path, EggInfoDistribution.path, and FileMetadata.path.

Referenced by Wheel._get_extensions(), HtmlFormatter._wrap_pre(), HtmlFormatter._wrap_tablelinenos(), Wheel.exists(), Wheel.info(), Wheel.install(), Wheel.metadata(), Wheel.mount(), PyPIRCFile.read(), Wheel.unmount(), Wheel.update(), PyPIRCFile.update(), and Wheel.verify().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ from_element()

Optional["Link"] from_element	(		cls,
		Dict[str, Optional[str]]	anchor_attribs,
		str	page_url,
		str	base_url
	)

Convert an anchor element's attributes in a simple repository page to a Link.

Definition at line 314 of file link.py.

    ) -> Optional["Link"]:
        """
        Convert an anchor element's attributes in a simple repository page to a Link.
        """
        href = anchor_attribs.get("href")
        if not href:
            return None
 
        url = _ensure_quoted_url(urllib.parse.urljoin(base_url, href))
        pyrequire = anchor_attribs.get("data-requires-python")
        yanked_reason = anchor_attribs.get("data-yanked")
 
        # PEP 714: Indexes must use the name data-core-metadata, but
        # clients should support the old name as a fallback for compatibility.
        metadata_info = anchor_attribs.get("data-core-metadata")
        if metadata_info is None:
            metadata_info = anchor_attribs.get("data-dist-info-metadata")
        # The metadata info value may be the string "true", or a string of
        # the form "hashname=hashval"
        if metadata_info == "true":
            # The file exists, but there are no hashes
            metadata_file_data = MetadataFile(None)
        elif metadata_info is None:
            # The file does not exist
            metadata_file_data = None
        else:
            # The file exists, and hashes have been supplied
            hashname, sep, hashval = metadata_info.partition("=")
            if sep == "=":
                metadata_file_data = MetadataFile(supported_hashes({hashname: hashval}))
            else:
                # Error - data is wrong. Treat as no hashes supplied.
                logger.debug(
                    "Index returned invalid data-dist-info-metadata value: %s",
                    metadata_info,
                )
                metadata_file_data = MetadataFile(None)
 
        return cls(
            url,
            comes_from=page_url,
            requires_python=pyrequire,
            yanked_reason=yanked_reason,
            metadata_file_data=metadata_file_data,
        )
 

References pip._internal.models.link._ensure_quoted_url(), i, and pip._internal.models.link.supported_hashes().

Here is the call graph for this function:

◆ from_json()

Optional["Link"] from_json	(		cls,
		Dict[str, Any]	file_data,
		str	page_url
	)

Convert an pypi json document from a simple repository page into a Link.

Definition at line 263 of file link.py.

    ) -> Optional["Link"]:
        """
        Convert an pypi json document from a simple repository page into a Link.
        """
        file_url = file_data.get("url")
        if file_url is None:
            return None
 
        url = _ensure_quoted_url(urllib.parse.urljoin(page_url, file_url))
        pyrequire = file_data.get("requires-python")
        yanked_reason = file_data.get("yanked")
        hashes = file_data.get("hashes", {})
 
        # PEP 714: Indexes must use the name core-metadata, but
        # clients should support the old name as a fallback for compatibility.
        metadata_info = file_data.get("core-metadata")
        if metadata_info is None:
            metadata_info = file_data.get("dist-info-metadata")
 
        # The metadata info value may be a boolean, or a dict of hashes.
        if isinstance(metadata_info, dict):
            # The file exists, and hashes have been supplied
            metadata_file_data = MetadataFile(supported_hashes(metadata_info))
        elif metadata_info:
            # The file exists, but there are no hashes
            metadata_file_data = MetadataFile(None)
        else:
            # False or not present: the file does not exist
            metadata_file_data = None
 
        # The Link.yanked_reason expects an empty string instead of a boolean.
        if yanked_reason and not isinstance(yanked_reason, str):
            yanked_reason = ""
        # The Link.yanked_reason expects None instead of False.
        elif not yanked_reason:
            yanked_reason = None
 
        return cls(
            url,
            comes_from=page_url,
            requires_python=pyrequire,
            yanked_reason=yanked_reason,
            hashes=hashes,
            metadata_file_data=metadata_file_data,
        )
 

References pip._internal.models.link._ensure_quoted_url(), i, and pip._internal.models.link.supported_hashes().

Here is the call graph for this function:

◆ has_hash()

bool has_hash ( self )

Definition at line 509 of file link.py.

    def has_hash(self) -> bool:
        return bool(self._hashes)
 

References CandidateEvaluator._hashes, and Link._hashes.

◆ hash()

Optional[str] hash ( self )

Definition at line 476 of file link.py.

    def hash(self) -> Optional[str]:
        return next(iter(self._hashes.values()), None)
 

References CandidateEvaluator._hashes, and Link._hashes.

Referenced by ArchiveInfo._to_dict().

Here is the caller graph for this function:

◆ hash_name()

Optional[str] hash_name ( self )

Definition at line 480 of file link.py.

    def hash_name(self) -> Optional[str]:
        return next(iter(self._hashes), None)
 

References CandidateEvaluator._hashes, and Link._hashes.

◆ is_existing_dir()

bool is_existing_dir ( self )

Definition at line 491 of file link.py.

    def is_existing_dir(self) -> bool:
        return self.is_file and os.path.isdir(self.file_path)
 

◆ is_file()

bool is_file ( self )

Definition at line 488 of file link.py.

    def is_file(self) -> bool:
        return self.scheme == "file"
 

Referenced by BaseDistribution.requested().

Here is the caller graph for this function:

◆ is_hash_allowed()

bool is_hash_allowed	(		self,
		Optional[Hashes]	hashes
	)

Return True if the link has a hash and it is allowed by `hashes`.

Definition at line 512 of file link.py.

    def is_hash_allowed(self, hashes: Optional[Hashes]) -> bool:
        """
        Return True if the link has a hash and it is allowed by `hashes`.
        """
        if hashes is None:
            return False
        return any(hashes.is_hash_allowed(k, v) for k, v in self._hashes.items())
 
 

References CandidateEvaluator._hashes, Link._hashes, and i.

Referenced by Hashes.has_one_of().

Here is the caller graph for this function:

◆ is_vcs()

bool is_vcs ( self )

Definition at line 499 of file link.py.

    def is_vcs(self) -> bool:
        from pip._internal.vcs import vcs
 
        return self.scheme in vcs.all_schemes
 

References i, Link.scheme(), Link.scheme, Locator.scheme, AggregatingLocator.scheme, LegacyMetadata.scheme, Metadata.scheme, ConnectionPool.scheme, HTTPConnectionPool.scheme, HTTPSConnectionPool.scheme, NTLMConnectionPool.scheme, and URLSchemeUnknown.scheme.

Here is the call graph for this function:

◆ is_wheel()

bool is_wheel ( self )

Definition at line 495 of file link.py.

    def is_wheel(self) -> bool:
        return self.ext == WHEEL_EXTENSION
 

Referenced by InstallRequirement.get_dist(), and InstallRequirement.install().

Here is the caller graph for this function:

◆ is_yanked()

bool is_yanked ( self )

Definition at line 505 of file link.py.

    def is_yanked(self) -> bool:
        return self.yanked_reason is not None
 

References Link.yanked_reason.

◆ metadata_link()

Optional["Link"] metadata_link ( self )

Return a link to the associated core metadata file (if any).

Definition at line 463 of file link.py.

    def metadata_link(self) -> Optional["Link"]:
        """Return a link to the associated core metadata file (if any)."""
        if self.metadata_file_data is None:
            return None
        metadata_url = f"{self.url_without_fragment}.metadata"
        if self.metadata_file_data.hashes is None:
            return Link(metadata_url)
        return Link(metadata_url, hashes=self.metadata_file_data.hashes)
 

References Link.metadata_file_data.

◆ netloc()

str netloc ( self )

This can contain auth information.

Definition at line 407 of file link.py.

    def netloc(self) -> str:
        """
        This can contain auth information.
        """
        return self._parsed_url.netloc
 

References Link._parsed_url.

Referenced by Link.filename().

Here is the caller graph for this function:

◆ path()

str path ( self )

Definition at line 414 of file link.py.

    def path(self) -> str:
        return urllib.parse.unquote(self._parsed_url.path)
 

References Link._parsed_url, and i.

Here is the caller graph for this function:

◆ scheme()

str scheme ( self )

Definition at line 403 of file link.py.

    def scheme(self) -> str:
        return self._parsed_url.scheme
 

References Link._parsed_url.

Referenced by HTTPConnectionPool._absolute_url(), PyPIRPCLocator._get_project(), PyPIJSONLocator._get_project(), JSONLocator._get_project(), Locator._update_version_data(), Metadata._validate_value(), LegacyMetadata.check(), AggregatingLocator.get_distribution_names(), HTTPConnectionPool.is_same_host(), Link.is_vcs(), Locator.locate(), LegacyMetadata.set(), and Metadata.validate().

Here is the caller graph for this function:

◆ show_url()

str show_url ( self )

Definition at line 484 of file link.py.

    def show_url(self) -> str:
        return posixpath.basename(self._url.split("#", 1)[0].split("?", 1)[0])
 

References Link._url, LazyZipOverHTTP._url, and i.

◆ splitext()

Tuple[str, str] splitext ( self )

Definition at line 417 of file link.py.

    def splitext(self) -> Tuple[str, str]:
        return splitext(posixpath.basename(self.path.rstrip("/")))
 

References i, _Prefix.path, Link.path(), File.path, TempDirectory.path(), _Cache.path, DistributionPath.path, BaseInstalledDistribution.path, InstalledDistribution.path, EggInfoDistribution.path, and FileMetadata.path.

Referenced by Link.ext().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ subdirectory_fragment()

Optional[str] subdirectory_fragment ( self )

Definition at line 457 of file link.py.

    def subdirectory_fragment(self) -> Optional[str]:
        match = self._subdirectory_fragment_re.search(self._url)
        if not match:
            return None
        return match.group(1)
 

References Link._subdirectory_fragment_re, Link._url, LazyZipOverHTTP._url, and i.

◆ url()

str url ( self )

Definition at line 381 of file link.py.

    def url(self) -> str:
        return self._url
 

References Link._url, and LazyZipOverHTTP._url.

Referenced by Requirement.__init__(), HTMLLinkParser.__init__(), RequestError.__reduce__(), IndexContent.__str__(), Url.__str__(), PackageIndex._url_for_path(), PackageIndex.check_credentials(), PreparedRequest.copy(), PackageIndex.encode_request(), RequestEncodingMixin.path_url(), Request.prepare(), PreparedRequest.prepare_auth(), PreparedRequest.prepare_url(), PyPIRCFile.read(), DirectUrl.redacted_url(), and PackageIndex.search().

Here is the caller graph for this function:

◆ url_without_fragment()

str url_without_fragment ( self )

Definition at line 425 of file link.py.

    def url_without_fragment(self) -> str:
        scheme, netloc, path, query, fragment = self._parsed_url
        return urllib.parse.urlunsplit((scheme, netloc, path, query, ""))
 

References Link._parsed_url, and i.

Field Documentation

◆ _egg_fragment_re

_egg_fragment_re = re.compile(r"[#&]egg=([^&]*)")

staticprotected

Definition at line 429 of file link.py.

Referenced by Link._egg_fragment().

◆ _hashes

_hashes

protected

Definition at line 248 of file link.py.

Referenced by CandidateEvaluator._sort_key(), Link.as_hashes(), CandidateEvaluator.get_applicable_candidates(), Link.has_hash(), Link.hash(), Link.hash_name(), and Link.is_hash_allowed().

◆ _parsed_url

_parsed_url

protected

Definition at line 240 of file link.py.

Referenced by Link.netloc(), Link.path(), Link.scheme(), and Link.url_without_fragment().

◆ _project_name_re

_project_name_re

staticprotected

Initial value:

=  re.compile(
        r"^([A-Z0-9]|[A-Z0-9][A-Z0-9._-]*[A-Z0-9])$", re.IGNORECASE
    )

Definition at line 432 of file link.py.

Referenced by Link._egg_fragment().

◆ _subdirectory_fragment_re

_subdirectory_fragment_re = re.compile(r"[#&]subdirectory=([^&]*)")

staticprotected

Definition at line 454 of file link.py.

Referenced by Link.subdirectory_fragment().

◆ _url

_url

protected

Definition at line 243 of file link.py.

Referenced by Link.__str__(), Link._egg_fragment(), LazyZipOverHTTP._stream_response(), Link.show_url(), Link.subdirectory_fragment(), and Link.url().

◆ cache_link_parsing

cache_link_parsing

Definition at line 259 of file link.py.

◆ comes_from

comes_from

Definition at line 252 of file link.py.

Referenced by Link.__str__(), InstallRequirement.__str__(), and InstallRequirement.from_path().

◆ egg_fragment

egg_fragment

Definition at line 260 of file link.py.

◆ ext

ext

Definition at line 496 of file link.py.

◆ file_path

file_path

Definition at line 492 of file link.py.

◆ metadata_file_data

metadata_file_data

Definition at line 255 of file link.py.

Referenced by Link.metadata_link().

◆ requires_python

requires_python

Definition at line 253 of file link.py.

Referenced by Link.__str__().

◆ scheme

scheme

Definition at line 489 of file link.py.

Referenced by HTTPConnectionPool._absolute_url(), PyPIRPCLocator._get_project(), PyPIJSONLocator._get_project(), JSONLocator._get_project(), Locator._update_version_data(), Metadata._validate_value(), LegacyMetadata.check(), AggregatingLocator.get_distribution_names(), HTTPConnectionPool.is_same_host(), Link.is_vcs(), Locator.locate(), LegacyMetadata.set(), and Metadata.validate().

◆ url

url

Definition at line 400 of file link.py.

Referenced by Requirement.__init__(), HTMLLinkParser.__init__(), RequestError.__reduce__(), IndexContent.__str__(), Url.__str__(), PackageIndex._url_for_path(), PackageIndex.check_credentials(), PreparedRequest.copy(), PackageIndex.encode_request(), RequestEncodingMixin.path_url(), Request.prepare(), PreparedRequest.prepare_auth(), PreparedRequest.prepare_url(), PyPIRCFile.read(), DirectUrl.redacted_url(), and PackageIndex.search().

◆ yanked_reason

yanked_reason

Definition at line 254 of file link.py.

Referenced by Link.is_yanked().

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

/home/liwuen/projects_dev/pqc-engineering-ssec-23/venv/lib/python3.12/site-packages/pip/_internal/models/link.py

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __repr__()

◆ __str__()

◆ _egg_fragment()

◆ as_hashes()

◆ ext()

◆ file_path()

◆ filename()

◆ from_element()

◆ from_json()

◆ has_hash()

◆ hash()

◆ hash_name()

◆ is_existing_dir()

◆ is_file()

◆ is_hash_allowed()

◆ is_vcs()

◆ is_wheel()

◆ is_yanked()

◆ metadata_link()

◆ netloc()

◆ path()

◆ scheme()

◆ show_url()

◆ splitext()

◆ subdirectory_fragment()

◆ url()

◆ url_without_fragment()

Field Documentation

◆ _egg_fragment_re

◆ _hashes

◆ _parsed_url

◆ _project_name_re

◆ _subdirectory_fragment_re

◆ _url

◆ cache_link_parsing

◆ comes_from

◆ egg_fragment

◆ ext

◆ file_path

◆ metadata_file_data

◆ requires_python

◆ scheme

◆ url

◆ yanked_reason

◆ init()

◆ repr()

◆ str()