urllib3.HTTPSConnectionPool

class documentation

class HTTPSConnectionPool(HTTPConnectionPool): (source)

Known subclasses: urllib3.contrib.ntlmpool.NTLMConnectionPool

View In Hierarchy

Same as :class:`.HTTPConnectionPool`, but HTTPS. :class:`.HTTPSConnection` uses one of ``assert_fingerprint``, ``assert_hostname`` and ``host`` in this order to verify connections. If ``assert_hostname`` is False, no verification is done. The ``key_file``, ``cert_file``, ``cert_reqs``, ``ca_certs``, ``ca_cert_dir``, ``ssl_version``, ``key_password`` are only used if :mod:`ssl` is available and are fed into :meth:`urllib3.util.ssl_wrap_socket` to upgrade the connection socket into an SSL socket.

Method __init__ Undocumented
Class Variable scheme Undocumented
Instance Variable assert_fingerprint Undocumented
Instance Variable assert_hostname Undocumented
Instance Variable ca_cert_dir Undocumented
Instance Variable ca_certs Undocumented
Instance Variable cert_file Undocumented
Instance Variable cert_reqs Undocumented
Instance Variable key_file Undocumented
Instance Variable key_password Undocumented
Instance Variable ssl_version Undocumented
Method _new_conn Return a fresh :class:`http.client.HTTPSConnection`.
Method _prepare_conn Prepare the ``connection`` for :meth:`urllib3.util.ssl_wrap_socket` and establish the tunnel if proxy is used.
Method _prepare_proxy Establishes a tunnel connection through HTTP CONNECT.
Method _validate_conn Called right before a request is made, after the socket is created.

Inherited from HTTPConnectionPool:

Method close Close all pooled connections and disable the pool.
Method is_same_host Check if the given ``url`` is a member of the same host as this connection pool.
Method urlopen Get a connection from the pool and perform an HTTP request. This is the lowest level call for making a request, so you'll need to specify all the raw details.
Instance Variable block Undocumented
Instance Variable conn_kw Undocumented
Instance Variable num_connections Undocumented
Instance Variable num_requests Undocumented
Instance Variable pool Undocumented
Instance Variable proxy Undocumented
Instance Variable proxy_config Undocumented
Instance Variable proxy_headers Undocumented
Instance Variable retries Undocumented
Instance Variable strict Undocumented
Instance Variable timeout Undocumented
Method _absolute_url Undocumented
Method _get_conn Get a connection. Will return a pooled connection if one is available.
Method _get_timeout Helper that always returns a :class:`urllib3.util.Timeout`
Method _make_request Perform a request on a given urllib connection object taken from our pool.
Method _put_conn Put a connection back into the pool.
Method _raise_timeout Is the error actually a timeout? Will raise a ReadTimeout or pass

Inherited from ConnectionPool (via HTTPConnectionPool):

Method __enter__ Undocumented
Method __exit__ Undocumented
Method __str__ Undocumented
Instance Variable host Undocumented
Instance Variable port Undocumented
Instance Variable _proxy_host Undocumented

Inherited from RequestMethods (via HTTPConnectionPool, ConnectionPool):

Method request Make a request using :meth:`urlopen` with the appropriate encoding of ``fields`` based on the ``method`` used.
Method request_encode_body Make a request using :meth:`urlopen` with the ``fields`` encoded in the body. This is useful for request methods like POST, PUT, PATCH, etc.
Method request_encode_url Make a request using :meth:`urlopen` with the ``fields`` encoded in the url. This is useful for request methods like GET, HEAD, DELETE, etc.
Instance Variable headers Undocumented
Class Variable _encode_url_methods Undocumented
def __init__(self, host, port=None, strict=False, timeout=Timeout.DEFAULT_TIMEOUT, maxsize=1, block=False, headers=None, retries=None, _proxy=None, _proxy_headers=None, key_file=None, cert_file=None, cert_reqs=None, key_password=None, ca_certs=None, ssl_version=None, assert_hostname=None, assert_fingerprint=None, ca_cert_dir=None, **conn_kw): (source)
overrides urllib3.HTTPConnectionPool.__init__
overridden in urllib3.contrib.ntlmpool.NTLMConnectionPool

Undocumented

scheme: str = (source)
overrides urllib3.HTTPConnectionPool.scheme
overridden in urllib3.contrib.ntlmpool.NTLMConnectionPool

Undocumented

assert_fingerprint = (source)

Undocumented

assert_hostname = (source)

Undocumented

ca_cert_dir = (source)

Undocumented

ca_certs = (source)

Undocumented

cert_file = (source)

Undocumented

cert_reqs = (source)

Undocumented

key_file = (source)

Undocumented

key_password = (source)

Undocumented

ssl_version = (source)

Undocumented

def _new_conn(self): (source)
overrides urllib3.HTTPConnectionPool._new_conn
overridden in urllib3.contrib.ntlmpool.NTLMConnectionPool

Return a fresh :class:`http.client.HTTPSConnection`.

def _prepare_conn(self, conn): (source)

Prepare the ``connection`` for :meth:`urllib3.util.ssl_wrap_socket` and establish the tunnel if proxy is used.

def _prepare_proxy(self, conn): (source)
overrides urllib3.HTTPConnectionPool._prepare_proxy

Establishes a tunnel connection through HTTP CONNECT. Tunnel connection is established early because otherwise httplib would improperly set Host: header to proxy's IP:port.

def _validate_conn(self, conn): (source)
overrides urllib3.HTTPConnectionPool._validate_conn

Called right before a request is made, after the socket is created.