]> git.ipfire.org Git - thirdparty/tornado.git/commitdiff
websocket: Add resolver argument to websocket_connect
authorBen Darnell <ben@bendarnell.com>
Sat, 8 Apr 2023 18:25:08 +0000 (18:25 +0000)
committerBen Darnell <ben@bendarnell.com>
Sat, 8 Apr 2023 18:25:08 +0000 (18:25 +0000)
This is the public interface, but when the resolver argument was added
it was only added to the supporting WebSocketClientConnection class.

docs/releases/v6.3.0.rst
tornado/websocket.py

index 1a5c097497d13092a40a929ceb23325138efddfc..a5c00a7cee8df47a72709c9b3ab2263cd2531880 100644 (file)
@@ -94,7 +94,7 @@ Deprecation notices
 
 - It is now much faster (no longer quadratic) to receive large messages that
   have been split into many fragments.
-- `.WebSocketClientConnection` now accepts a ``resolver`` parameter.
+- `.websocket_connect` now accepts a ``resolver`` parameter.
 
 ``tornado.wsgi``
 ~~~~~~~~~~~~~~~~
index 1d42e10baa2a4284f97c0f530b0b7d4933bc860e..6c3315c9878edbebfe6c7231f2236db565d75bd1 100644 (file)
@@ -1589,6 +1589,7 @@ def websocket_connect(
     ping_timeout: Optional[float] = None,
     max_message_size: int = _default_max_message_size,
     subprotocols: Optional[List[str]] = None,
+    resolver: Optional[Resolver] = None,
 ) -> "Awaitable[WebSocketClientConnection]":
     """Client-side websocket support.
 
@@ -1632,6 +1633,9 @@ def websocket_connect(
 
     .. versionchanged:: 5.1
        Added the ``subprotocols`` argument.
+
+    .. versionchanged:: 6.3
+       Added the ``resolver`` argument.
     """
     if isinstance(url, httpclient.HTTPRequest):
         assert connect_timeout is None
@@ -1653,6 +1657,7 @@ def websocket_connect(
         ping_timeout=ping_timeout,
         max_message_size=max_message_size,
         subprotocols=subprotocols,
+        resolver=resolver,
     )
     if callback is not None:
         IOLoop.current().add_future(conn.connect_future, callback)