123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318 |
- from __future__ import annotations
-
- import socket
- import typing
- import warnings
- from email.errors import MessageDefect
- from http.client import IncompleteRead as httplib_IncompleteRead
-
- if typing.TYPE_CHECKING:
- from .connection import HTTPConnection
- from .connectionpool import ConnectionPool
- from .response import HTTPResponse
- from .util.retry import Retry
-
- # Base Exceptions
-
-
- class HTTPError(Exception):
- """Base exception used by this module."""
-
-
- class HTTPWarning(Warning):
- """Base warning used by this module."""
-
-
- _TYPE_REDUCE_RESULT = typing.Tuple[
- typing.Callable[..., object], typing.Tuple[object, ...]
- ]
-
-
- class PoolError(HTTPError):
- """Base exception for errors caused within a pool."""
-
- def __init__(self, pool: ConnectionPool, message: str) -> None:
- self.pool = pool
- super().__init__(f"{pool}: {message}")
-
- def __reduce__(self) -> _TYPE_REDUCE_RESULT:
- # For pickling purposes.
- return self.__class__, (None, None)
-
-
- class RequestError(PoolError):
- """Base exception for PoolErrors that have associated URLs."""
-
- def __init__(self, pool: ConnectionPool, url: str, message: str) -> None:
- self.url = url
- super().__init__(pool, message)
-
- def __reduce__(self) -> _TYPE_REDUCE_RESULT:
- # For pickling purposes.
- return self.__class__, (None, self.url, None)
-
-
- class SSLError(HTTPError):
- """Raised when SSL certificate fails in an HTTPS connection."""
-
-
- class ProxyError(HTTPError):
- """Raised when the connection to a proxy fails."""
-
- # The original error is also available as __cause__.
- original_error: Exception
-
- def __init__(self, message: str, error: Exception) -> None:
- super().__init__(message, error)
- self.original_error = error
-
-
- class DecodeError(HTTPError):
- """Raised when automatic decoding based on Content-Type fails."""
-
-
- class ProtocolError(HTTPError):
- """Raised when something unexpected happens mid-request/response."""
-
-
- #: Renamed to ProtocolError but aliased for backwards compatibility.
- ConnectionError = ProtocolError
-
-
- # Leaf Exceptions
-
-
- class MaxRetryError(RequestError):
- """Raised when the maximum number of retries is exceeded.
-
- :param pool: The connection pool
- :type pool: :class:`~urllib3.connectionpool.HTTPConnectionPool`
- :param str url: The requested Url
- :param reason: The underlying error
- :type reason: :class:`Exception`
-
- """
-
- def __init__(
- self, pool: ConnectionPool, url: str, reason: Exception | None = None
- ) -> None:
- self.reason = reason
-
- message = f"Max retries exceeded with url: {url} (Caused by {reason!r})"
-
- super().__init__(pool, url, message)
-
-
- class HostChangedError(RequestError):
- """Raised when an existing pool gets a request for a foreign host."""
-
- def __init__(
- self, pool: ConnectionPool, url: str, retries: Retry | int = 3
- ) -> None:
- message = f"Tried to open a foreign host with url: {url}"
- super().__init__(pool, url, message)
- self.retries = retries
-
-
- class TimeoutStateError(HTTPError):
- """Raised when passing an invalid state to a timeout"""
-
-
- class TimeoutError(HTTPError):
- """Raised when a socket timeout error occurs.
-
- Catching this error will catch both :exc:`ReadTimeoutErrors
- <ReadTimeoutError>` and :exc:`ConnectTimeoutErrors <ConnectTimeoutError>`.
- """
-
-
- class ReadTimeoutError(TimeoutError, RequestError):
- """Raised when a socket timeout occurs while receiving data from a server"""
-
-
- # This timeout error does not have a URL attached and needs to inherit from the
- # base HTTPError
- class ConnectTimeoutError(TimeoutError):
- """Raised when a socket timeout occurs while connecting to a server"""
-
-
- class NewConnectionError(ConnectTimeoutError, HTTPError):
- """Raised when we fail to establish a new connection. Usually ECONNREFUSED."""
-
- def __init__(self, conn: HTTPConnection, message: str) -> None:
- self.conn = conn
- super().__init__(f"{conn}: {message}")
-
- @property
- def pool(self) -> HTTPConnection:
- warnings.warn(
- "The 'pool' property is deprecated and will be removed "
- "in urllib3 v2.1.0. Use 'conn' instead.",
- DeprecationWarning,
- stacklevel=2,
- )
-
- return self.conn
-
-
- class NameResolutionError(NewConnectionError):
- """Raised when host name resolution fails."""
-
- def __init__(self, host: str, conn: HTTPConnection, reason: socket.gaierror):
- message = f"Failed to resolve '{host}' ({reason})"
- super().__init__(conn, message)
-
-
- class EmptyPoolError(PoolError):
- """Raised when a pool runs out of connections and no more are allowed."""
-
-
- class FullPoolError(PoolError):
- """Raised when we try to add a connection to a full pool in blocking mode."""
-
-
- class ClosedPoolError(PoolError):
- """Raised when a request enters a pool after the pool has been closed."""
-
-
- class LocationValueError(ValueError, HTTPError):
- """Raised when there is something wrong with a given URL input."""
-
-
- class LocationParseError(LocationValueError):
- """Raised when get_host or similar fails to parse the URL input."""
-
- def __init__(self, location: str) -> None:
- message = f"Failed to parse: {location}"
- super().__init__(message)
-
- self.location = location
-
-
- class URLSchemeUnknown(LocationValueError):
- """Raised when a URL input has an unsupported scheme."""
-
- def __init__(self, scheme: str):
- message = f"Not supported URL scheme {scheme}"
- super().__init__(message)
-
- self.scheme = scheme
-
-
- class ResponseError(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"
-
-
- class SecurityWarning(HTTPWarning):
- """Warned when performing security reducing actions"""
-
-
- class InsecureRequestWarning(SecurityWarning):
- """Warned when making an unverified HTTPS request."""
-
-
- class NotOpenSSLWarning(SecurityWarning):
- """Warned when using unsupported SSL library"""
-
-
- class SystemTimeWarning(SecurityWarning):
- """Warned when system time is suspected to be wrong"""
-
-
- class InsecurePlatformWarning(SecurityWarning):
- """Warned when certain TLS/SSL configuration is not available on a platform."""
-
-
- class DependencyWarning(HTTPWarning):
- """
- Warned when an attempt is made to import a module with missing optional
- dependencies.
- """
-
-
- class ResponseNotChunked(ProtocolError, ValueError):
- """Response needs to be chunked in order to read it as chunks."""
-
-
- class BodyNotHttplibCompatible(HTTPError):
- """
- Body should be :class:`http.client.HTTPResponse` like
- (have an fp attribute which returns raw chunks) for read_chunked().
- """
-
-
- class IncompleteRead(HTTPError, httplib_IncompleteRead):
- """
- Response length doesn't match expected Content-Length
-
- Subclass of :class:`http.client.IncompleteRead` to allow int value
- for ``partial`` to avoid creating large objects on streamed reads.
- """
-
- def __init__(self, partial: int, expected: int) -> None:
- self.partial = partial # type: ignore[assignment]
- self.expected = expected
-
- def __repr__(self) -> str:
- return "IncompleteRead(%i bytes read, %i more expected)" % (
- self.partial, # type: ignore[str-format]
- self.expected,
- )
-
-
- class InvalidChunkLength(HTTPError, httplib_IncompleteRead):
- """Invalid chunk length in a chunked response."""
-
- def __init__(self, response: HTTPResponse, length: bytes) -> None:
- self.partial: int = response.tell() # type: ignore[assignment]
- self.expected: int | None = response.length_remaining
- self.response = response
- self.length = length
-
- def __repr__(self) -> str:
- return "InvalidChunkLength(got length %r, %i bytes read)" % (
- self.length,
- self.partial,
- )
-
-
- class InvalidHeader(HTTPError):
- """The header provided was somehow invalid."""
-
-
- class ProxySchemeUnknown(AssertionError, URLSchemeUnknown):
- """ProxyManager does not support the supplied scheme"""
-
- # TODO(t-8ch): Stop inheriting from AssertionError in v2.0.
-
- def __init__(self, scheme: str | None) -> None:
- # 'localhost' is here because our URL parser parses
- # localhost:8080 -> scheme=localhost, remove if we fix this.
- if scheme == "localhost":
- scheme = None
- if scheme is None:
- message = "Proxy URL had no scheme, should start with http:// or https://"
- else:
- message = f"Proxy URL had unsupported scheme {scheme}, should use http:// or https://"
- super().__init__(message)
-
-
- class ProxySchemeUnsupported(ValueError):
- """Fetching HTTPS resources through HTTPS proxies is unsupported"""
-
-
- class HeaderParsingError(HTTPError):
- """Raised by assert_header_parsing, but we convert it to a log.warning statement."""
-
- def __init__(
- self, defects: list[MessageDefect], unparsed_data: bytes | str | None
- ) -> None:
- message = f"{defects or 'Unknown'}, unparsed data: {unparsed_data!r}"
- super().__init__(message)
-
-
- class UnrewindableBodyError(HTTPError):
- """urllib3 encountered an error when trying to rewind a body"""
|