API Reference

• Pool Manager
  • PoolManager
    • PoolManager.clear()
    • PoolManager.connection_from_context()
    • PoolManager.connection_from_host()
    • PoolManager.connection_from_pool_key()
    • PoolManager.connection_from_url()
    • PoolManager.proxy
    • PoolManager.proxy_config
    • PoolManager.urlopen()
  • ProxyManager
    • ProxyManager.connection_from_host()
    • ProxyManager.urlopen()
• Connection Pools
  • HTTPConnectionPool
    • HTTPConnectionPool.ConnectionCls
    • HTTPConnectionPool.ResponseCls
    • HTTPConnectionPool.close()
    • HTTPConnectionPool.is_same_host()
    • HTTPConnectionPool.scheme
    • HTTPConnectionPool.urlopen()
  • HTTPSConnectionPool
    • HTTPSConnectionPool.ConnectionCls
    • HTTPSConnectionPool.scheme
  • ConnectionPool
    • ConnectionPool.QueueCls
    • ConnectionPool.close()
    • ConnectionPool.scheme
• Connections
  • HTTPConnection
    • HTTPConnection.connect()
    • HTTPConnection.default_socket_options
    • HTTPConnection.host
    • HTTPConnection.is_verified
    • HTTPConnection.proxy_is_verified
    • HTTPConnection.request()
    • HTTPConnection.request_chunked()
    • HTTPConnection.socket_options
  • HTTPSConnection
    • HTTPSConnection.connect()
    • HTTPSConnection.set_cert()
• Exceptions
  • BodyNotHttplibCompatible
  • ClosedPoolError
  • ConnectTimeoutError
  • ConnectionError
  • DecodeError
  • DependencyWarning
  • EmptyPoolError
  • HTTPError
  • HTTPWarning
  • HeaderParsingError
  • HostChangedError
  • IncompleteRead
  • InsecurePlatformWarning
  • InsecureRequestWarning
  • InvalidChunkLength
  • InvalidHeader
  • LocationParseError
  • LocationValueError
  • MaxRetryError
  • NewConnectionError
  • PoolError
  • ProtocolError
  • ProxyError
  • ProxySchemeUnknown
  • ProxySchemeUnsupported
  • ReadTimeoutError
  • RequestError
  • ResponseError
    • ResponseError.GENERIC_ERROR
    • ResponseError.SPECIFIC_ERROR
  • ResponseNotChunked
  • SNIMissingWarning
  • SSLError
  • SecurityWarning
  • SubjectAltNameWarning
  • SystemTimeWarning
  • TimeoutError
  • TimeoutStateError
  • URLSchemeUnknown
  • UnrewindableBodyError
• Response and Decoders
  • Response
    • HTTPResponse
      • HTTPResponse.CONTENT_DECODERS
      • HTTPResponse.DECODER_ERROR_CLASSES
      • HTTPResponse.REDIRECT_STATUSES
      • HTTPResponse.close()
      • HTTPResponse.closed
      • HTTPResponse.connection
      • HTTPResponse.data
      • HTTPResponse.drain_conn()
      • HTTPResponse.fileno()
      • HTTPResponse.flush()
      • HTTPResponse.from_httplib()
      • HTTPResponse.get_redirect_location()
      • HTTPResponse.getheader()
      • HTTPResponse.getheaders()
      • HTTPResponse.geturl()
      • HTTPResponse.info()
      • HTTPResponse.isclosed()
      • HTTPResponse.read()
      • HTTPResponse.read_chunked()
      • HTTPResponse.readable()
      • HTTPResponse.readinto()
      • HTTPResponse.release_conn()
      • HTTPResponse.stream()
      • HTTPResponse.supports_chunked_reads()
      • HTTPResponse.tell()
  • Decoders
    • BrotliDecoder
    • DeflateDecoder
    • GzipDecoder
    • MultiDecoder
• Fields and Multipart Forms
  • Fields
    • RequestField
      • RequestField.from_tuples()
      • RequestField.make_multipart()
      • RequestField.render_headers()
    • format_header_param()
    • format_header_param_html5()
    • format_header_param_rfc2231()
    • guess_content_type()
  • Multipart Forms
    • encode_multipart_formdata()
    • choose_boundary()
    • iter_field_objects()
• Request Methods
  • RequestMethods
    • RequestMethods.request()
    • RequestMethods.request_encode_body()
    • RequestMethods.request_encode_url()
    • RequestMethods.urlopen()
• Utilities
  • Retry
    • Retry.DEFAULT_ALLOWED_METHODS
    • Retry.DEFAULT_BACKOFF_MAX
    • Retry.DEFAULT_REMOVE_HEADERS_ON_REDIRECT
    • Retry.RETRY_AFTER_STATUS_CODES
    • Retry.from_int()
    • Retry.get_backoff_time()
    • Retry.get_retry_after()
    • Retry.increment()
    • Retry.is_exhausted()
    • Retry.is_retry()
    • Retry.sleep()
  • SSLContext
    • SSLContext.sslobject_class
    • SSLContext.sslsocket_class
  • Timeout
    • Timeout.DEFAULT_TIMEOUT
    • Timeout.clone()
    • Timeout.connect_timeout
    • Timeout.from_float()
    • Timeout.get_connect_duration()
    • Timeout.read_timeout
    • Timeout.start_connect()
  • Url
    • Url.hostname
    • Url.netloc
    • Url.request_uri
    • Url.url
  • assert_fingerprint()
  • current_time()
  • get_host()
  • is_connection_dropped()
  • is_fp_closed()
  • make_headers()
  • parse_url()
  • resolve_cert_reqs()
  • resolve_ssl_version()
  • split_first()
  • ssl_wrap_socket()
  • wait_for_read()
  • wait_for_write()
• Third-Party Modules
  • Google App Engine
    • AppEngineManager
      • AppEngineManager.urlopen()
    • AppEnginePlatformError
    • AppEnginePlatformWarning
  • NTLM Authentication
    • NTLMConnectionPool
      • NTLMConnectionPool.scheme
      • NTLMConnectionPool.urlopen()
  • PyOpenSSL
    • extract_from_urllib3()
    • inject_into_urllib3()
  • macOS SecureTransport
  • SOCKS Proxies
    • SOCKSConnection
    • SOCKSHTTPConnectionPool
      • SOCKSHTTPConnectionPool.ConnectionCls
    • SOCKSHTTPSConnection
    • SOCKSHTTPSConnectionPool
      • SOCKSHTTPSConnectionPool.ConnectionCls
    • SOCKSProxyManager
      • SOCKSProxyManager.pool_classes_by_scheme