PackageIndex Class Reference

Public Member Functions
None	__init__ (self, str url, str file_storage_domain)

Data Fields
	url
	netloc
	simple_url
	pypi_url
	file_storage_domain

Protected Member Functions
str	_url_for_path (self, str path)

Detailed Description

Represents a Package Index and provides easier access to endpoints

Definition at line 4 of file index.py.

Constructor & Destructor Documentation

__init__()

None __init__	(		self,
		str	url,
		str	file_storage_domain
	)

Definition at line 9 of file index.py.

    def __init__(self, url: str, file_storage_domain: str) -> None:
        super().__init__()
        self.url = url
        self.netloc = urllib.parse.urlsplit(url).netloc
        self.simple_url = self._url_for_path("simple")
        self.pypi_url = self._url_for_path("pypi")
 
        # This is part of a temporary hack used to block installs of PyPI
        # packages which depend on external urls only necessary until PyPI can
        # block such packages themselves
        self.file_storage_domain = file_storage_domain
 

References PackageIndex.__init__(), and i.

Referenced by PackageIndex.__init__(), and Protocol.__init_subclass__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

_url_for_path()

str _url_for_path (   self, str  path  )

protected

Definition at line 21 of file index.py.

    def _url_for_path(self, path: str) -> str:
        return urllib.parse.urljoin(self.url, path)
 
 

References i, IndexContent.url, DirectUrl.url, PackageIndex.url, Link.url(), Link.url, Credentials.url, RemoteNotValidError.url, PyPIRCFile.url, Requirement.url, Lexer.url, PythonLexer.url, Python2Lexer.url, CythonLexer.url, NumPyLexer.url, pyparsing_common.url, Request.url, PreparedRequest.url, Response.url, RequestError.url, and Url.url().

Here is the call graph for this function:

Field Documentation

file_storage_domain

file_storage_domain

Definition at line 19 of file index.py.

netloc

netloc

Definition at line 12 of file index.py.

Referenced by Link.filename().

pypi_url

pypi_url

Definition at line 14 of file index.py.

simple_url

simple_url

Definition at line 13 of file index.py.

url

url

Definition at line 11 of file index.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().

---

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/index.py