urllib3.connection.HTTPConnection

class documentation

class HTTPConnection(_HTTPConnection, object): (source)

Known subclasses: urllib3.connection.HTTPSConnection, urllib3.contrib.socks.SOCKSConnection

View In Hierarchy

Based on :class:`http.client.HTTPConnection` but provides an extra constructor backwards-compatibility layer between older and newer Pythons. Additional keyword parameters are used to configure attributes of the connection. Accepted parameters include: - ``strict``: See the documentation on :class:`urllib3.connectionpool.HTTPConnectionPool` - ``source_address``: Set the source address for the current connection. - ``socket_options``: Set specific options on the underlying socket. If not specified, then defaults are loaded from ``HTTPConnection.default_socket_options`` which includes disabling Nagle's algorithm (sets TCP_NODELAY to 1) unless the connection is behind a proxy. For example, if you wish to enable TCP Keep Alive in addition to the defaults, you might pass: .. code-block:: python HTTPConnection.default_socket_options + [ (socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1), ] Or you may want to disable the defaults by passing an empty list (e.g., ``[]``).

Method __init__ Undocumented
Method connect Undocumented
Method host.setter Setter for the `host` property.
Method putheader Undocumented
Method putrequest Undocumented
Method request Undocumented
Method request_chunked Alternative to the common request method, which sends the body with chunked encoding and not as one block
Class Variable default_port Undocumented
Class Variable default_socket_options Undocumented
Class Variable is_verified Undocumented
Class Variable proxy_is_verified Undocumented
Instance Variable auto_open Undocumented
Instance Variable proxy Undocumented
Instance Variable proxy_config Undocumented
Instance Variable sock Undocumented
Instance Variable socket_options Undocumented
Instance Variable source_address Undocumented
Property host Getter method to remove any trailing dots that indicate the hostname is an FQDN.
Method _is_using_tunnel Undocumented
Method _new_conn Establish a socket connection and set nodelay settings on it.
Method _prepare_conn Undocumented
Instance Variable _dns_host Undocumented
def __init__(self, *args, **kw): (source)
overridden in urllib3.connection.HTTPSConnection, urllib3.contrib.socks.SOCKSConnection

Undocumented

def connect(self): (source)
overridden in urllib3.connection.HTTPSConnection

Undocumented

@host.setter
def host(self, value): (source)

Setter for the `host` property. We assume that only urllib3 uses the _dns_host attribute; httplib itself only uses `host`, and it seems reasonable that other libraries follow suit.

def putheader(self, header, *values): (source)

Undocumented

def putrequest(self, method, url, *args, **kwargs): (source)

Undocumented

def request(self, method, url, body=None, headers=None): (source)

Undocumented

def request_chunked(self, method, url, body=None, headers=None): (source)

Alternative to the common request method, which sends the body with chunked encoding and not as one block

default_port = (source)
overridden in urllib3.connection.HTTPSConnection

Undocumented

default_socket_options = (source)

Undocumented

is_verified: bool = (source)
overridden in urllib3.connection.HTTPSConnection

Undocumented

proxy_is_verified = (source)
overridden in urllib3.connection.HTTPSConnection

Undocumented

auto_open: int = (source)
overridden in urllib3.connection.HTTPSConnection

Undocumented

proxy = (source)

Undocumented

proxy_config = (source)

Undocumented

sock = (source)
overridden in urllib3.connection.HTTPSConnection

Undocumented

socket_options = (source)

Undocumented

source_address = (source)

Undocumented

@property
host = (source)

Getter method to remove any trailing dots that indicate the hostname is an FQDN. In general, SSL certificates don't include the trailing dot indicating a fully-qualified domain name, and thus, they don't validate properly when checked against a domain name that includes the dot. In addition, some servers may not expect to receive the trailing dot when provided. However, the hostname with trailing dot is critical to DNS resolution; doing a lookup with the trailing dot will properly only resolve the appropriate FQDN, whereas a lookup without a trailing dot will search the system's search domain list. Thus, it's important to keep the original host around for use only in those cases where it's appropriate (i.e., when doing DNS lookup to establish the actual TCP connection across which we're going to send HTTP requests).

def _is_using_tunnel(self): (source)

Undocumented

def _new_conn(self): (source)
overridden in urllib3.contrib.socks.SOCKSConnection

Establish a socket connection and set nodelay settings on it. :return: New socket connection.

def _prepare_conn(self, conn): (source)

Undocumented

_dns_host = (source)

Undocumented