Add compatibility with websockets 11.0.

See python-websockets/websockets#1269.
sanic-org · Nov 27, 2022 · 7df55d8 · 7df55d8
1 parent ad4e526
commit 7df55d8
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 9 deletions.
diff --git a/sanic/server/protocols/websocket_protocol.py b/sanic/server/protocols/websocket_protocol.py
@@ -1,7 +1,13 @@
 from typing import TYPE_CHECKING, Optional, Sequence, cast
 
-from websockets.connection import CLOSED, CLOSING, OPEN
-from websockets.server import ServerConnection
+
+try:  # websockets < 11.0
+    from websockets.connection import CLOSED, CLOSING, OPEN
+    from websockets.server import ServerConnection as ServerProtocol
+except ImportError:  # websockets >= 11.0
+    from websockets.protocol import CLOSED, CLOSING, OPEN
+    from websockets.server import ServerProtocol
+
 from websockets.typing import Subprotocol
 
 from sanic.exceptions import ServerError
@@ -90,7 +96,7 @@ async def websocket_handshake(
         try:
             if subprotocols is not None:
                 # subprotocols can be a set or frozenset,
-                # but ServerConnection needs a list
+                # but ServerProtocol needs a list
                 subprotocols = cast(
                     Optional[Sequence[Subprotocol]],
                     list(
@@ -100,13 +106,13 @@ async def websocket_handshake(
                         ]
                     ),
                 )
-            ws_conn = ServerConnection(
+            ws_proto = ServerProtocol(
                 max_size=self.websocket_max_size,
                 subprotocols=subprotocols,
                 state=OPEN,
                 logger=logger,
             )
-            resp: "http11.Response" = ws_conn.accept(request)
+            resp: "http11.Response" = ws_proto.accept(request)
         except Exception:
             msg = (
                 "Failed to open a WebSocket connection.\n"
@@ -129,7 +135,7 @@ async def websocket_handshake(
         else:
             raise ServerError(resp.body, resp.status_code)
         self.websocket = WebsocketImplProtocol(
-            ws_conn,
+            ws_proto,
             ping_interval=self.websocket_ping_interval,
             ping_timeout=self.websocket_ping_timeout,
             close_timeout=self.websocket_timeout,

diff --git a/sanic/server/websockets/impl.py b/sanic/server/websockets/impl.py
@@ -12,14 +12,21 @@
     Union,
 )
 
-from websockets.connection import CLOSED, CLOSING, OPEN, Event
 from websockets.exceptions import (
     ConnectionClosed,
     ConnectionClosedError,
     ConnectionClosedOK,
 )
 from websockets.frames import Frame, Opcode
-from websockets.server import ServerConnection
+
+
+try:  # websockets < 11.0
+    from websockets.connection import CLOSED, CLOSING, OPEN, Event
+    from websockets.server import ServerConnection as ServerProtocol
+except ImportError:  # websockets >= 11.0
+    from websockets.protocol import CLOSED, CLOSING, OPEN, Event
+    from websockets.server import ServerProtocol
+
 from websockets.typing import Data
 
 from sanic.log import error_logger, logger
@@ -30,7 +37,7 @@
 
 
 class WebsocketImplProtocol:
-    connection: ServerConnection
+    connection: ServerProtocol
     io_proto: Optional[SanicProtocol]
     loop: Optional[asyncio.AbstractEventLoop]
     max_queue: int