Skip to content

Commit

Permalink
List specific timeouts for each exception (#8968)
Browse files Browse the repository at this point in the history
(cherry picked from commit 8daecf5)
  • Loading branch information
Dreamsorcerer authored and patchback[bot] committed Sep 2, 2024
1 parent 2af23ab commit c8bdac8
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
1 change: 1 addition & 0 deletions CHANGES/8968.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clarified which timeout exceptions happen on which timeouts -- by :user:`Dreamsorcerer`.
7 changes: 5 additions & 2 deletions docs/client_reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2327,17 +2327,20 @@ Connection errors

Server operation timeout: read timeout, etc.

To catch all timeouts, including the ``total`` timeout, use
:exc:`asyncio.TimeoutError`.

Derived from :exc:`ServerConnectionError` and :exc:`asyncio.TimeoutError`

.. class:: ConnectionTimeoutError

Connection timeout on request: e.g. read timeout.
Connection timeout on ``connect`` and ``sock_connect`` timeouts.

Derived from :exc:`ServerTimeoutError`

.. class:: SocketTimeoutError

Reading from socket timeout.
Reading from socket timeout on ``sock_read`` timeout.

Derived from :exc:`ServerTimeoutError`

Expand Down

0 comments on commit c8bdac8

Please sign in to comment.