summaryrefslogtreecommitdiffstats
path: root/Doc/library/socket.rst
diff options
context:
space:
mode:
authorChristian Heimes <christian@python.org>2020-11-20 08:26:07 (GMT)
committerGitHub <noreply@github.com>2020-11-20 08:26:07 (GMT)
commit03c8ddd9e94c7bddf1f06cf785027b8d2bf00ff0 (patch)
treee293c334cb6fee7b5826b21e26ab3c56a2d2fd20 /Doc/library/socket.rst
parent7ddbaa7a1b3e61847ee99658be6a7268a049e302 (diff)
downloadcpython-03c8ddd9e94c7bddf1f06cf785027b8d2bf00ff0.zip
cpython-03c8ddd9e94c7bddf1f06cf785027b8d2bf00ff0.tar.gz
cpython-03c8ddd9e94c7bddf1f06cf785027b8d2bf00ff0.tar.bz2
bpo-42413: socket.timeout is now an alias of TimeoutError (GH-23413)
Signed-off-by: Christian Heimes <christian@python.org>
Diffstat (limited to 'Doc/library/socket.rst')
-rwxr-xr-xDoc/library/socket.rst7
1 files changed, 6 insertions, 1 deletions
diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst
index faf8a76..d52b84f 100755
--- a/Doc/library/socket.rst
+++ b/Doc/library/socket.rst
@@ -283,6 +283,8 @@ Exceptions
.. exception:: timeout
+ A deprecated alias of :exc:`TimeoutError`.
+
A subclass of :exc:`OSError`, this exception is raised when a timeout
occurs on a socket which has had timeouts enabled via a prior call to
:meth:`~socket.settimeout` (or implicitly through
@@ -292,6 +294,9 @@ Exceptions
.. versionchanged:: 3.3
This class was made a subclass of :exc:`OSError`.
+ .. versionchanged:: 3.10
+ This class was made an alias of :exc:`TimeoutError`.
+
Constants
^^^^^^^^^
@@ -1208,7 +1213,7 @@ to sockets.
address family --- see above.)
If the connection is interrupted by a signal, the method waits until the
- connection completes, or raise a :exc:`socket.timeout` on timeout, if the
+ connection completes, or raise a :exc:`TimeoutError` on timeout, if the
signal handler doesn't raise an exception and the socket is blocking or has
a timeout. For non-blocking sockets, the method raises an
:exc:`InterruptedError` exception if the connection is interrupted by a