Websocket sansio implementataion

docs/deployment.md

@@ -60,7 +60,7 @@ Options:
   --loop [auto|asyncio|uvloop]    Event loop implementation.  [default: auto]
   --http [auto|h11|httptools]     HTTP protocol implementation.  [default:
                                   auto]
-  --ws [auto|none|websockets|wsproto]
+  --ws [auto|none|websockets|websockets-sansio|wsproto]
                                   WebSocket protocol implementation.
                                   [default: auto]
   --ws-max-size INTEGER           WebSocket max size message in bytes

docs/index.md

@@ -130,7 +130,7 @@ Options:
   --loop [auto|asyncio|uvloop]    Event loop implementation.  [default: auto]
   --http [auto|h11|httptools]     HTTP protocol implementation.  [default:
                                   auto]
-  --ws [auto|none|websockets|wsproto]
+  --ws [auto|none|websockets|websockets-sansio|wsproto]
                                   WebSocket protocol implementation.
                                   [default: auto]
   --ws-max-size INTEGER           WebSocket max size message in bytes

docs/settings.md

@@ -67,7 +67,7 @@ Using Uvicorn with watchfiles will enable the following options (which are other
 
 * `--loop <str>` - Set the event loop implementation. The uvloop implementation provides greater performance, but is not compatible with Windows or PyPy. **Options:** *'auto', 'asyncio', 'uvloop'.* **Default:** *'auto'*.
 * `--http <str>` - Set the HTTP protocol implementation. The httptools implementation provides greater performance, but it not compatible with PyPy. **Options:** *'auto', 'h11', 'httptools'.* **Default:** *'auto'*.
-* `--ws <str>` - Set the WebSockets protocol implementation. Either of the `websockets` and `wsproto` packages are supported. Use `'none'` to ignore all websocket requests. **Options:** *'auto', 'none', 'websockets', 'wsproto'.* **Default:** *'auto'*.
+* `--ws <str>` - Set the WebSockets protocol implementation. Either of the `websockets` and `wsproto` packages are supported. Use `'none'` to ignore all websocket requests. **Options:** *'auto', 'none', 'websockets', 'websockets-sansio', 'wsproto'.* **Default:** *'auto'*.
 * `--ws-max-size <int>` - Set the WebSockets max message size, in bytes. Please note that this can be used only with the default `websockets` protocol.
 * `--ws-max-queue <int>` - Set the maximum length of the WebSocket incoming message queue. Please note that this can be used only with the default `websockets` protocol.
 * `--ws-ping-interval <float>` - Set the WebSockets ping interval, in seconds. Please note that this can be used only with the default `websockets` protocol. **Default:** *20.0*

pyproject.toml

@@ -100,7 +100,7 @@ omit = [
 
 [tool.coverage.report]
 precision = 2
-fail_under = 98.35
+fail_under = 98.65
 show_missing = true
 skip_covered = true
 exclude_lines = [

tests/conftest.py

@@ -255,6 +255,7 @@ def unused_tcp_port() -> int:
             ),
         ),
         "uvicorn.protocols.websockets.websockets_impl:WebSocketProtocol",
+        "uvicorn.protocols.websockets.websockets_sansio_impl:WebSocketsSansIOProtocol",
     ]
 )
 def ws_protocol_cls(request: pytest.FixtureRequest):

tests/middleware/test_logging.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import contextlib
 import logging
 import socket
@@ -14,8 +16,13 @@
 
 if typing.TYPE_CHECKING:
     from uvicorn.protocols.websockets.websockets_impl import WebSocketProtocol
+    from uvicorn.protocols.websockets.websockets_sansio_impl import (
+        WebSocketsSansIOProtocol,
+    )
     from uvicorn.protocols.websockets.wsproto_impl import WSProtocol
 
+    WSType = typing.Type["WSProtocol | WebSocketProtocol | WebSocketsSansIOProtocol"]
+
 
 @contextlib.contextmanager
 def caplog_for_logger(caplog, logger_name):
@@ -87,7 +94,7 @@ async def test_trace_logging_on_http_protocol(
 
 @pytest.mark.anyio
 async def test_trace_logging_on_ws_protocol(
-    ws_protocol_cls: "typing.Type[WSProtocol | WebSocketProtocol]",
+    ws_protocol_cls: WSType,
     caplog,
     logging_config,
     unused_tcp_port: int,