pip._internal.network.auth.MultiDomainBasicAuth Class Reference

Inheritance diagram for pip._internal.network.auth.MultiDomainBasicAuth:

Collaboration diagram for pip._internal.network.auth.MultiDomainBasicAuth:

Public Member Functions
None	__init__ (self, bool prompting=True, Optional[List[str]] index_urls=None, str keyring_provider="auto")
KeyRingBaseProvider	keyring_provider (self)
None	keyring_provider (self, str provider)
bool	use_keyring (self)
Request	__call__ (self, Request req)
Response	handle_401 (self, Response resp, **Any kwargs)
None	warn_on_401 (self, Response resp, **Any kwargs)
None	save_credentials (self, Response resp, **Any kwargs)

Public Attributes
	prompting
	index_urls
	keyring_provider
	handle_401
	warn_on_401
	save_credentials

Protected Member Functions
Optional[AuthInfo]	_get_keyring_auth (self, Optional[str] url, Optional[str] username)
Optional[str]	_get_index_url (self, str url)
AuthInfo	_get_new_credentials (self, str original_url, *bool allow_netrc=True, bool allow_keyring=False)
Tuple[str, Optional[str], Optional[str]]	_get_url_and_credentials (self, str original_url)
Tuple[Optional[str], Optional[str], bool]	_prompt_for_password (self, str netloc)
bool	_should_save_password_to_keyring (self)

Protected Attributes
	_keyring_provider
	_credentials_to_save

Member Function Documentation

__call__()

Request pip._internal.network.auth.MultiDomainBasicAuth.__call__	(		self,
		Request	req
	)

Reimplemented from pip._vendor.requests.auth.AuthBase.

_get_index_url()

Optional[str] pip._internal.network.auth.MultiDomainBasicAuth._get_index_url (   self, str  url  )

protected

Return the original index URL matching the requested URL.

Cached or dynamically generated credentials may work against
the original index URL rather than just the netloc.

The provided url should have had its username and password
removed already. If the original index url had credentials then
they will be included in the return value.

Returns None if no matching index was found, or if --no-index
was specified by the user.

_get_keyring_auth()

Optional[AuthInfo] pip._internal.network.auth.MultiDomainBasicAuth._get_keyring_auth (   self, Optional[str]  url, Optional[str]  username  )

protected

Return the tuple auth for a given url from keyring.

_get_new_credentials()

AuthInfo pip._internal.network.auth.MultiDomainBasicAuth._get_new_credentials (   self, str  original_url, *bool   allow_netrc = True, bool   allow_keyring = False  )

protected

Find and return credentials for the specified URL.

_get_url_and_credentials()

Tuple[str, Optional[str], Optional[str]] pip._internal.network.auth.MultiDomainBasicAuth._get_url_and_credentials (   self, str   original_url  )

protected

Return the credentials to use for the provided URL.

If allowed, netrc and keyring may be used to obtain the
correct credentials.

Returns (url_without_credentials, username, password). Note
that even if the original URL contains credentials, this
function may return a different username and password.

save_credentials()

None pip._internal.network.auth.MultiDomainBasicAuth.save_credentials	(		self,
		Response	resp,
		**Any	kwargs
	)

Response callback to save credentials on success.

warn_on_401()

None pip._internal.network.auth.MultiDomainBasicAuth.warn_on_401	(		self,
		Response	resp,
		**Any	kwargs
	)

Response callback to warn about incorrect credentials.

---

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

• docs/help/help-venv/lib/python3.12/site-packages/pip/_internal/network/auth.py