Exceptions and Warnings

exception urllib3.exceptions.BodyNotHttplibCompatible

Bases: HTTPError

Body should be http.client.HTTPResponse like (have an fp attribute which returns raw chunks) for read_chunked().

exception urllib3.exceptions.ClosedPoolError(pool, message)

Bases: PoolError

Raised when a request enters a pool after the pool has been closed.

Parameters:
Return type:

None

exception urllib3.exceptions.ConnectTimeoutError

Bases: TimeoutError

Raised when a socket timeout occurs while connecting to a server

urllib3.exceptions.ConnectionError

Renamed to ProtocolError but aliased for backwards compatibility.

exception urllib3.exceptions.DecodeError

Bases: HTTPError

Raised when automatic decoding based on Content-Type fails.

exception urllib3.exceptions.DependencyWarning

Bases: HTTPWarning

Warned when an attempt is made to import a module with missing optional dependencies.

exception urllib3.exceptions.EmptyPoolError(pool, message)

Bases: PoolError

Raised when a pool runs out of connections and no more are allowed.

Parameters:
Return type:

None

exception urllib3.exceptions.FullPoolError(pool, message)

Bases: PoolError

Raised when we try to add a connection to a full pool in blocking mode.

Parameters:
Return type:

None

exception urllib3.exceptions.HTTPError

Bases: Exception

Base exception used by this module.

exception urllib3.exceptions.HTTPWarning

Bases: Warning

Base warning used by this module.

exception urllib3.exceptions.HeaderParsingError(defects, unparsed_data)

Bases: HTTPError

Raised by assert_header_parsing, but we convert it to a log.warning statement.

Parameters:

  • defects (list[MessageDefect])

  • unparsed_data (bytes | str | None)

Return type:

None

exception urllib3.exceptions.HostChangedError(pool, url, retries=3)

Bases: RequestError

Raised when an existing pool gets a request for a foreign host.

Parameters:
Return type:

None

exception urllib3.exceptions.IncompleteRead(partial, expected)

Bases: HTTPError, IncompleteRead

Response length doesn’t match expected Content-Length

Subclass of http.client.IncompleteRead to allow int value for partial to avoid creating large objects on streamed reads.

Parameters:

  • partial (int)

  • expected (int)

Return type:

None

expected: int
partial: int
exception urllib3.exceptions.InsecurePlatformWarning

Bases: SecurityWarning

Warned when certain TLS/SSL configuration is not available on a platform.

exception urllib3.exceptions.InsecureRequestWarning

Bases: SecurityWarning

Warned when making an unverified HTTPS request.

exception urllib3.exceptions.InvalidChunkLength(response, length)

Bases: HTTPError, IncompleteRead

Invalid chunk length in a chunked response.

Parameters:
Return type:

None

exception urllib3.exceptions.InvalidHeader

Bases: HTTPError

The header provided was somehow invalid.

exception urllib3.exceptions.LocationParseError(location)

Bases: LocationValueError

Raised when get_host or similar fails to parse the URL input.

Parameters:

location (str)

Return type:

None

exception urllib3.exceptions.LocationValueError

Bases: ValueError, HTTPError

Raised when there is something wrong with a given URL input.

exception urllib3.exceptions.MaxRetryError(pool, url, reason=None)

Bases: RequestError

Raised when the maximum number of retries is exceeded.

Parameters:
Return type:

None

exception urllib3.exceptions.NameResolutionError(host, conn, reason)

Bases: NewConnectionError

Raised when host name resolution fails.

Parameters:
exception urllib3.exceptions.NewConnectionError(conn, message)

Bases: ConnectTimeoutError, HTTPError

Raised when we fail to establish a new connection. Usually ECONNREFUSED.

Parameters:
Return type:

None

property pool: HTTPConnection
exception urllib3.exceptions.NotOpenSSLWarning

Bases: SecurityWarning

Warned when using unsupported SSL library

exception urllib3.exceptions.PoolError(pool, message)

Bases: HTTPError

Base exception for errors caused within a pool.

Parameters:
Return type:

None

exception urllib3.exceptions.ProtocolError

Bases: HTTPError

Raised when something unexpected happens mid-request/response.

exception urllib3.exceptions.ProxyError(message, error)

Bases: HTTPError

Raised when the connection to a proxy fails.

Parameters:
Return type:

None

original_error: Exception
exception urllib3.exceptions.ProxySchemeUnknown(scheme)

Bases: AssertionError, URLSchemeUnknown

ProxyManager does not support the supplied scheme

Parameters:

scheme (str | None)

Return type:

None

exception urllib3.exceptions.ProxySchemeUnsupported

Bases: ValueError

Fetching HTTPS resources through HTTPS proxies is unsupported

exception urllib3.exceptions.ReadTimeoutError(pool, url, message)

Bases: TimeoutError, RequestError

Raised when a socket timeout occurs while receiving data from a server

Parameters:
Return type:

None

exception urllib3.exceptions.RequestError(pool, url, message)

Bases: PoolError

Base exception for PoolErrors that have associated URLs.

Parameters:
Return type:

None

exception urllib3.exceptions.ResponseError

Bases: HTTPError

Used as a container for an error reason supplied in a MaxRetryError.

GENERIC_ERROR = 'too many error responses'
SPECIFIC_ERROR = 'too many {status_code} error responses'
exception urllib3.exceptions.ResponseNotChunked

Bases: ProtocolError, ValueError

Response needs to be chunked in order to read it as chunks.

exception urllib3.exceptions.SSLError

Bases: HTTPError

Raised when SSL certificate fails in an HTTPS connection.

exception urllib3.exceptions.SecurityWarning

Bases: HTTPWarning

Warned when performing security reducing actions

exception urllib3.exceptions.SystemTimeWarning

Bases: SecurityWarning

Warned when system time is suspected to be wrong

exception urllib3.exceptions.TimeoutError

Bases: HTTPError

Raised when a socket timeout error occurs.

Catching this error will catch both ReadTimeoutErrors and ConnectTimeoutErrors.

exception urllib3.exceptions.TimeoutStateError

Bases: HTTPError

Raised when passing an invalid state to a timeout

exception urllib3.exceptions.URLSchemeUnknown(scheme)

Bases: LocationValueError

Raised when a URL input has an unsupported scheme.

Parameters:

scheme (str)

exception urllib3.exceptions.UnrewindableBodyError

Bases: HTTPError

urllib3 encountered an error when trying to rewind a body

urllib3.disable_warnings(category=<class 'urllib3.exceptions.HTTPWarning'>)

Helper for quickly disabling all urllib3 warnings.

Parameters:

category (type[Warning])

Return type:

None