From: Min RK <benjaminrk@gmail.com>
Date: Tue, 19 Oct 2021 11:25:46 +0000 (+0200)
Subject: make gen.TimeoutError asyncio.TimeoutError
X-Git-Tag: v6.2.0b1~34^2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=24be0c1ecc0f8347fbcd9f5ee80879fba54f25c1;p=thirdparty%2Ftornado.git

make gen.TimeoutError asyncio.TimeoutError

for more consistent catching of timeouts with other asyncio code
---

diff --git a/docs/util.rst b/docs/util.rst
index 0a2012942..a4e35ad65 100644
--- a/docs/util.rst
+++ b/docs/util.rst
@@ -7,3 +7,15 @@
 
 .. automodule:: tornado.util
     :members:
+
+    .. class:: TimeoutError
+
+        Exception raised by `.gen.with_timeout` and `.IOLoop.run_sync`.
+
+        .. versionchanged:: 5.0
+           Unified ``tornado.gen.TimeoutError`` and
+           ``tornado.ioloop.TimeoutError`` as ``tornado.util.TimeoutError``.
+           Both former names remain as aliases.
+
+        .. versionchanged:: 6.2
+           ``tornado.util.TimeoutError`` is an alias to :py:class:`asyncio.TimeoutError`
diff --git a/tornado/gen.py b/tornado/gen.py
index a6370259b..1946ab917 100644
--- a/tornado/gen.py
+++ b/tornado/gen.py
@@ -606,6 +606,9 @@ def with_timeout(
     .. versionchanged:: 6.0.3
        ``asyncio.CancelledError`` is now always considered "quiet".
 
+    .. versionchanged:: 6.2
+       ``tornado.util.TimeoutError`` is now an alias to ``asyncio.TimeoutError``.
+
     """
     # It's tempting to optimize this by cancelling the input future on timeout
     # instead of creating a new one, but A) we can't know if we are the only
diff --git a/tornado/ioloop.py b/tornado/ioloop.py
index 28d86f504..8976c499f 100644
--- a/tornado/ioloop.py
+++ b/tornado/ioloop.py
@@ -468,7 +468,7 @@ class IOLoop(Configurable):
 
         The keyword-only argument ``timeout`` may be used to set
         a maximum duration for the function.  If the timeout expires,
-        a `tornado.util.TimeoutError` is raised.
+        a `asyncio.TimeoutError` is raised.
 
         This method is useful to allow asynchronous calls in a
         ``main()`` function::
@@ -485,6 +485,8 @@ class IOLoop(Configurable):
         .. versionchanged:: 5.0
            If a timeout occurs, the ``func`` coroutine will be cancelled.
 
+        .. versionchanged:: 6.2
+           ``tornado.util.TimeoutError`` is now an alias to ``asyncio.TimeoutError``.
         """
         future_cell = [None]  # type: List[Optional[Future]]
 
diff --git a/tornado/test/import_test.py b/tornado/test/import_test.py
index 23450fbc6..dac1f268b 100644
--- a/tornado/test/import_test.py
+++ b/tornado/test/import_test.py
@@ -64,3 +64,4 @@ class ImportTest(unittest.TestCase):
 
         self.assertIs(tornado.ioloop.TimeoutError, tornado.util.TimeoutError)
         self.assertIs(tornado.gen.TimeoutError, tornado.util.TimeoutError)
+        self.assertIs(tornado.util.TimeoutError, asyncio.TimeoutError)
diff --git a/tornado/util.py b/tornado/util.py
index b69500e2a..3a3a52f1f 100644
--- a/tornado/util.py
+++ b/tornado/util.py
@@ -11,6 +11,7 @@ and `.Resolver`.
 """
 
 import array
+import asyncio
 import atexit
 from inspect import getfullargspec
 import os
@@ -63,14 +64,9 @@ except ImportError:
     is_finalizing = _get_emulated_is_finalizing()
 
 
-class TimeoutError(Exception):
-    """Exception raised by `.with_timeout` and `.IOLoop.run_sync`.
-
-    .. versionchanged:: 5.0:
-       Unified ``tornado.gen.TimeoutError`` and
-       ``tornado.ioloop.TimeoutError`` as ``tornado.util.TimeoutError``.
-       Both former names remain as aliases.
-    """
+# versionchanged:: 6.2
+# no longer our own TimeoutError, use standard asyncio class
+TimeoutError = asyncio.TimeoutError
 
 
 class ObjectDict(Dict[str, Any]):