From 4ab76943efb509032fb7d599c47b60cd6f8a6a1f Mon Sep 17 00:00:00 2001 From: Kenneth Reitz Date: Sat, 12 Nov 2011 18:34:27 -0500 Subject: [PATCH] document timeouts --- docs/user/quickstart.rst | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/docs/user/quickstart.rst b/docs/user/quickstart.rst index b77bd29..4ead875 100644 --- a/docs/user/quickstart.rst +++ b/docs/user/quickstart.rst @@ -283,6 +283,38 @@ If you're using POST, PUT, PATCH, *&c*, you can also explicitly enable redirecti [] +Timeouts +-------- + +You can tell requests to stop waiting for a response after a given number of seconds with the ``timeout`` parameter:: + + >>> requests.get('http://github.com', timeout=0.001) + Traceback (most recent call last): + File "", line 1, in + requests.exceptions.Timeout: Request timed out. + +.. admonition:: Note + + ``timeout`` only effects the connection process itself, not the downloading of the respone body. + + +Note + +Errors and Exceptions +--------------------- + +In the event of a network problem (e.g. DNS failure, refused connection, etc), +Requests will raise a :class:`ConnectionError` exception. + +In the event of the rare invalid HTTP response, Requests will raise +an :class:`HTTPError` exception. + +If a request times out, a :class:`Timeout` exception is raised. + +If a request exceeds the configured number of maximum redirections, a :class:`TooManyRedirects` exception is raised. + +All exceptions that Requests explicitly raises inherit from +:class:`requests.exceptions.RequestException`. ----------------------- -- 2.34.1