pip._vendor.urllib3.poolmanager Namespace Reference

Data Structures
class	PoolManager
class	ProxyManager

Functions
	_default_key_normalizer (key_class, request_context)
	proxy_from_url (url, **kw)

Variables
	log = logging.getLogger(__name__)
tuple	SSL_KEYWORDS
tuple	_key_fields
	PoolKey = collections.namedtuple("PoolKey", _key_fields)
tuple	_proxy_config_fields = ("ssl_context", "use_forwarding_for_https")
	ProxyConfig = collections.namedtuple("ProxyConfig", _proxy_config_fields)
dict	key_fn_by_scheme
dict	pool_classes_by_scheme = {"http": HTTPConnectionPool, "https": HTTPSConnectionPool}

Function Documentation

_default_key_normalizer()

_default_key_normalizer (   key_class,   request_context  )

protected

Create a pool key out of a request context dictionary.

According to RFC 3986, both the scheme and host are case-insensitive.
Therefore, this function normalizes both before constructing the pool
key for an HTTPS request. If you wish to change this behaviour, provide
alternate callables to ``key_fn_by_scheme``.

:param key_class:
    The class to use when constructing the key. This should be a namedtuple
    with the ``scheme`` and ``host`` keys at a minimum.
:type  key_class: namedtuple
:param request_context:
    A dictionary-like object that contain the context for a request.
:type  request_context: dict

:return: A namedtuple that can be used as a connection pool key.
:rtype:  PoolKey

Definition at line 79 of file poolmanager.py.

def _default_key_normalizer(key_class, request_context):
    """
    Create a pool key out of a request context dictionary.
 
    According to RFC 3986, both the scheme and host are case-insensitive.
    Therefore, this function normalizes both before constructing the pool
    key for an HTTPS request. If you wish to change this behaviour, provide
    alternate callables to ``key_fn_by_scheme``.
 
    :param key_class:
        The class to use when constructing the key. This should be a namedtuple
        with the ``scheme`` and ``host`` keys at a minimum.
    :type  key_class: namedtuple
    :param request_context:
        A dictionary-like object that contain the context for a request.
    :type  request_context: dict
 
    :return: A namedtuple that can be used as a connection pool key.
    :rtype:  PoolKey
    """
    # Since we mutate the dictionary, make a copy first
    context = request_context.copy()
    context["scheme"] = context["scheme"].lower()
    context["host"] = context["host"].lower()
 
    # These are both dictionaries and need to be transformed into frozensets
    for key in ("headers", "_proxy_headers", "_socks_options"):
        if key in context and context[key] is not None:
            context[key] = frozenset(context[key].items())
 
    # The socket_options key may be a list and needs to be transformed into a
    # tuple.
    socket_opts = context.get("socket_options")
    if socket_opts is not None:
        context["socket_options"] = tuple(socket_opts)
 
    # Map the kwargs to the names in the namedtuple - this is necessary since
    # namedtuples can't have fields starting with '_'.
    for key in list(context.keys()):
        context["key_" + key] = context.pop(key)
 
    # Default to ``None`` for keys missing from the context
    for field in key_class._fields:
        if field not in context:
            context[field] = None
 
    return key_class(**context)
 
 
#: A dictionary that maps a scheme to a callable that creates a pool key.
#: This can be used to alter the way pool keys are constructed, if desired.
#: Each PoolManager makes a copy of this dictionary so they can be configured
#: globally here, or individually on the instance.

References i.

proxy_from_url()

proxy_from_url	(		url,
		**	kw
	)

Definition at line 536 of file poolmanager.py.

def proxy_from_url(url, **kw):
    return ProxyManager(proxy_url=url, **kw)

Variable Documentation

_key_fields

tuple _key_fields

protected

Initial value:

=  (
    "key_scheme",  # str
    "key_host",  # str
    "key_port",  # int
    "key_timeout",  # int or float or Timeout
    "key_retries",  # int or Retry
    "key_strict",  # bool
    "key_block",  # bool
    "key_source_address",  # str
    "key_key_file",  # str
    "key_key_password",  # str
    "key_cert_file",  # str
    "key_cert_reqs",  # str
    "key_ca_certs",  # str
    "key_ssl_version",  # str
    "key_ca_cert_dir",  # str
    "key_ssl_context",  # instance of ssl.SSLContext or urllib3.util.ssl_.SSLContext
    "key_maxsize",  # int
    "key_headers",  # dict
    "key__proxy",  # parsed proxy url
    "key__proxy_headers",  # dict
    "key__proxy_config",  # class
    "key_socket_options",  # list of (level (int), optname (int), value (int or str)) tuples
    "key__socks_options",  # dict
    "key_assert_hostname",  # bool or string
    "key_assert_fingerprint",  # str
    "key_server_hostname",  # str
)

Definition at line 42 of file poolmanager.py.

_proxy_config_fields

tuple _proxy_config_fields = ("ssl_context", "use_forwarding_for_https")

protected

Definition at line 75 of file poolmanager.py.

key_fn_by_scheme

dict key_fn_by_scheme

Initial value:

=  {
    "http": functools.partial(_default_key_normalizer, PoolKey),
    "https": functools.partial(_default_key_normalizer, PoolKey),
}

Definition at line 132 of file poolmanager.py.

log

log = logging.getLogger(__name__)

Definition at line 26 of file poolmanager.py.

pool_classes_by_scheme

dict pool_classes_by_scheme = {"http": HTTPConnectionPool, "https": HTTPSConnectionPool}

Definition at line 137 of file poolmanager.py.

PoolKey

PoolKey = collections.namedtuple("PoolKey", _key_fields)

Definition at line 73 of file poolmanager.py.

ProxyConfig

ProxyConfig = collections.namedtuple("ProxyConfig", _proxy_config_fields)

Definition at line 76 of file poolmanager.py.

SSL_KEYWORDS

tuple SSL_KEYWORDS

Initial value:

=  (
    "key_file",
    "cert_file",
    "cert_reqs",
    "ca_certs",
    "ssl_version",
    "ca_cert_dir",
    "ssl_context",
    "key_password",
    "server_hostname",
)

Definition at line 28 of file poolmanager.py.