]> git.ipfire.org Git - thirdparty/tornado.git/commitdiff
websocket: Change some Future type annotations to Awaitables
authorBen Darnell <ben@bendarnell.com>
Sun, 30 Dec 2018 17:10:20 +0000 (12:10 -0500)
committerBen Darnell <ben@bendarnell.com>
Sun, 30 Dec 2018 20:14:36 +0000 (15:14 -0500)
This conforms with usage elsewhere, that methods returning None use
Futures (self-starting in case the result is not awaited) and others
use Awaitable (reserving the option to use more efficient native
coroutines).

tornado/websocket.py

index c77b1999ba789ec4f375f1e8aedaa7cefc115713..a9a3e7fe7f39f5f5b8f032682ccd082224ad6743 100644 (file)
@@ -1496,7 +1496,7 @@ class WebSocketClientConnection(simple_httpclient._HTTPConnection):
 
     def read_message(
         self, callback: Callable[["Future[Union[None, str, bytes]]"], None] = None
-    ) -> "Future[Union[None, str, bytes]]":
+    ) -> Awaitable[Union[None, str, bytes]]:
         """Reads a message from the WebSocket server.
 
         If on_message_callback was specified at WebSocket
@@ -1513,10 +1513,12 @@ class WebSocketClientConnection(simple_httpclient._HTTPConnection):
             self.io_loop.add_future(future, callback)
         return future
 
-    def on_message(self, message: Union[str, bytes]) -> Optional["Future[None]"]:
+    def on_message(self, message: Union[str, bytes]) -> Optional[Awaitable[None]]:
         return self._on_message(message)
 
-    def _on_message(self, message: Union[None, str, bytes]) -> Optional["Future[None]"]:
+    def _on_message(
+        self, message: Union[None, str, bytes]
+    ) -> Optional[Awaitable[None]]:
         if self._on_message_callback:
             self._on_message_callback(message)
             return None
@@ -1580,7 +1582,7 @@ def websocket_connect(
     ping_timeout: float = None,
     max_message_size: int = _default_max_message_size,
     subprotocols: List[str] = None,
-) -> "Future[WebSocketClientConnection]":
+) -> "Awaitable[WebSocketClientConnection]":
     """Client-side websocket support.
 
     Takes a url and returns a Future whose result is a