Exceptions
CloseError
CloseError(message: str, *, request: Request | None = None)
Bases: NetworkError
Failed to close a connection.
ConnectError
ConnectError(message: str, *, request: Request | None = None)
Bases: NetworkError
Failed to establish a connection.
ConnectTimeout
ConnectTimeout(message: str, *, request: Request | None = None)
Bases: TimeoutException
Timed out while connecting to the host.
CookieConflict
CookieConflict(message: str)
Bases: Exception
Attempted to lookup a cookie by name, but multiple cookies existed.
Can occur when calling response.cookies.get(...)
.
DecodingError
DecodingError(message: str, *, request: Request | None = None)
Bases: RequestError
Decoding of the response failed, due to a malformed encoding.
HTTPError
HTTPError(message: str)
Bases: Exception
Base class for RequestError
and HTTPStatusError
.
Useful for try...except
blocks when issuing a request,
and then calling .raise_for_status()
.
For example:
try:
response = httpx.get("https://www.example.com")
response.raise_for_status()
except httpx.HTTPError as exc:
print(f"HTTP Exception for {exc.request.url} - {exc}")
HTTPStatusError
HTTPStatusError(message: str, *, request: Request, response: Response)
Bases: HTTPError
The response had an error HTTP status of 4xx or 5xx.
May be raised when calling response.raise_for_status()
LocalProtocolError
LocalProtocolError(message: str, *, request: Request | None = None)
Bases: ProtocolError
A protocol was violated by the client.
For example if the user instantiated a Request
instance explicitly,
failed to include the mandatory Host:
header, and then issued it directly
using client.send()
.
NetworkError
NetworkError(message: str, *, request: Request | None = None)
Bases: TransportError
The base class for network-related errors.
An error occurred while interacting with the network.
PoolTimeout
PoolTimeout(message: str, *, request: Request | None = None)
Bases: TimeoutException
Timed out waiting to acquire a connection from the pool.
ProtocolError
ProtocolError(message: str, *, request: Request | None = None)
Bases: TransportError
The protocol was violated.
ProxyError
ProxyError(message: str, *, request: Request | None = None)
Bases: TransportError
An error occurred while establishing a proxy connection.
ReadError
ReadError(message: str, *, request: Request | None = None)
Bases: NetworkError
Failed to receive data from the network.
ReadTimeout
ReadTimeout(message: str, *, request: Request | None = None)
Bases: TimeoutException
Timed out while receiving data from the host.
RemoteProtocolError
RemoteProtocolError(message: str, *, request: Request | None = None)
Bases: ProtocolError
The protocol was violated by the server.
For example, returning malformed HTTP.
RequestError
RequestError(message: str, *, request: Request | None = None)
RequestNotRead
ResponseNotRead
StreamClosed
StreamConsumed
StreamError
StreamError(message: str)
Bases: RuntimeError
The base class for stream exceptions.
The developer made an error in accessing the request stream in an invalid way.
TimeoutException
TimeoutException(message: str, *, request: Request | None = None)
Bases: TransportError
The base class for timeout errors.
An operation has timed out.
TooManyRedirects
TooManyRedirects(message: str, *, request: Request | None = None)
Bases: RequestError
Too many redirects.
UnsupportedProtocol
UnsupportedProtocol(message: str, *, request: Request | None = None)
Bases: TransportError
Attempted to make a request to an unsupported protocol.
For example issuing a request to ftp://www.example.com
.
WriteError
WriteError(message: str, *, request: Request | None = None)
Bases: NetworkError
Failed to send data through the network.
WriteTimeout
WriteTimeout(message: str, *, request: Request | None = None)
Bases: TimeoutException
Timed out while sending data to the host.