From: Ben Darnell Date: Sun, 30 Dec 2018 17:10:20 +0000 (-0500) Subject: websocket: Change some Future type annotations to Awaitables X-Git-Tag: v6.0.0b1~9^2~10 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b8192ecad7ee67ea06a7ffcf10329a5d3c6dae81;p=thirdparty%2Ftornado.git websocket: Change some Future type annotations to Awaitables 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). --- diff --git a/tornado/websocket.py b/tornado/websocket.py index c77b1999b..a9a3e7fe7 100644 --- a/tornado/websocket.py +++ b/tornado/websocket.py @@ -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