pip._vendor.requests.auth Namespace Reference

Data Structures
class	AuthBase
class	HTTPBasicAuth
class	HTTPDigestAuth
class	HTTPProxyAuth

Functions
	_basic_auth_str (username, password)

Variables
str	CONTENT_TYPE_FORM_URLENCODED = "application/x-www-form-urlencoded"
str	CONTENT_TYPE_MULTI_PART = "multipart/form-data"

Detailed Description

requests.auth
~~~~~~~~~~~~~

This module contains the authentication handlers for Requests.

Function Documentation

_basic_auth_str()

_basic_auth_str (   username,   password  )

protected

Returns a Basic Auth string.

Definition at line 25 of file auth.py.

def _basic_auth_str(username, password):
    """Returns a Basic Auth string."""
 
    # "I want us to put a big-ol' comment on top of it that
    # says that this behaviour is dumb but we need to preserve
    # it because people are relying on it."
    #    - Lukasa
    #
    # These are here solely to maintain backwards compatibility
    # for things like ints. This will be removed in 3.0.0.
    if not isinstance(username, basestring):
        warnings.warn(
            "Non-string usernames will no longer be supported in Requests "
            "3.0.0. Please convert the object you've passed in ({!r}) to "
            "a string or bytes object in the near future to avoid "
            "problems.".format(username),
            category=DeprecationWarning,
        )
        username = str(username)
 
    if not isinstance(password, basestring):
        warnings.warn(
            "Non-string passwords will no longer be supported in Requests "
            "3.0.0. Please convert the object you've passed in ({!r}) to "
            "a string or bytes object in the near future to avoid "
            "problems.".format(type(password)),
            category=DeprecationWarning,
        )
        password = str(password)
    # -- End Removal --
 
    if isinstance(username, str):
        username = username.encode("latin1")
 
    if isinstance(password, str):
        password = password.encode("latin1")
 
    authstr = "Basic " + to_native_string(
        b64encode(b":".join((username, password))).strip()
    )
 
    return authstr
 
 

References i.

Variable Documentation

CONTENT_TYPE_FORM_URLENCODED

str CONTENT_TYPE_FORM_URLENCODED = "application/x-www-form-urlencoded"

Definition at line 21 of file auth.py.

CONTENT_TYPE_MULTI_PART

str CONTENT_TYPE_MULTI_PART = "multipart/form-data"

Definition at line 22 of file auth.py.