Move AbortHandshake to the legacy package.

It is only used by the legacy implementation.

Author: aaugustin

src/websockets/__init__.py

@@ -14,7 +14,6 @@
     "HeadersLike",
     "MultipleValuesError",
     # .exceptions
-    "AbortHandshake",
     "ConnectionClosed",
     "ConnectionClosedError",
     "ConnectionClosedOK",
@@ -45,6 +44,7 @@
     "connect",
     "unix_connect",
     # .legacy.exceptions
+    "AbortHandshake",
     "InvalidMessage",
     "InvalidStatusCode",
     # .legacy.protocol
@@ -72,7 +72,6 @@
     from .client import ClientProtocol
     from .datastructures import Headers, HeadersLike, MultipleValuesError
     from .exceptions import (
-        AbortHandshake,
         ConnectionClosed,
         ConnectionClosedError,
         ConnectionClosedOK,
@@ -101,7 +100,11 @@
         basic_auth_protocol_factory,
     )
     from .legacy.client import WebSocketClientProtocol, connect, unix_connect
-    from .legacy.exceptions import InvalidMessage, InvalidStatusCode
+    from .legacy.exceptions import (
+        AbortHandshake,
+        InvalidMessage,
+        InvalidStatusCode,
+    )
     from .legacy.protocol import WebSocketCommonProtocol
     from .legacy.server import (
         WebSocketServer,
@@ -131,7 +134,6 @@
             "HeadersLike": ".datastructures",
             "MultipleValuesError": ".datastructures",
             # .exceptions
-            "AbortHandshake": ".exceptions",
             "ConnectionClosed": ".exceptions",
             "ConnectionClosedError": ".exceptions",
             "ConnectionClosedOK": ".exceptions",
@@ -162,6 +164,7 @@
             "connect": ".legacy.client",
             "unix_connect": ".legacy.client",
             # .legacy.exceptions
+            "AbortHandshake": ".legacy.exceptions",
             "InvalidMessage": ".legacy.exceptions",
             "InvalidStatusCode": ".legacy.exceptions",
             # .legacy.protocol

src/websockets/exceptions.py

@@ -19,7 +19,7 @@
             * :exc:`DuplicateParameter`
             * :exc:`InvalidParameterName`
             * :exc:`InvalidParameterValue`
-        * :exc:`AbortHandshake`
+        * :exc:`AbortHandshake` (legacy)
         * :exc:`RedirectHandshake`
     * :exc:`InvalidState`
     * :exc:`InvalidURI`
@@ -30,13 +30,11 @@
 
 from __future__ import annotations
 
-import http
 import typing
 import warnings
 
-from . import datastructures, frames, http11
+from . import frames, http11
 from .imports import lazy_import
-from .typing import StatusLike
 
 
 __all__ = [
@@ -302,40 +300,6 @@ def __str__(self) -> str:
             return f"invalid value for parameter {self.name}: {self.value}"
 
 
-class AbortHandshake(InvalidHandshake):
-    """
-    Raised to abort the handshake on purpose and return an HTTP response.
-
-    This exception is an implementation detail.
-
-    The public API is
-    :meth:`~websockets.legacy.server.WebSocketServerProtocol.process_request`.
-
-    Attributes:
-        status (~http.HTTPStatus): HTTP status code.
-        headers (Headers): HTTP response headers.
-        body (bytes): HTTP response body.
-    """
-
-    def __init__(
-        self,
-        status: StatusLike,
-        headers: datastructures.HeadersLike,
-        body: bytes = b"",
-    ) -> None:
-        # If a user passes an int instead of a HTTPStatus, fix it automatically.
-        self.status = http.HTTPStatus(status)
-        self.headers = datastructures.Headers(headers)
-        self.body = body
-
-    def __str__(self) -> str:
-        return (
-            f"HTTP {self.status:d}, "
-            f"{len(self.headers)} headers, "
-            f"{len(self.body)} bytes"
-        )
-
-
 class RedirectHandshake(InvalidHandshake):
     """
     Raised when a handshake gets redirected.
@@ -393,6 +357,7 @@ class ProtocolError(WebSocketException):
 # When type checking, import non-deprecated aliases eagerly. Else, import on demand.
 if typing.TYPE_CHECKING:
     from .legacy.exceptions import (
+        AbortHandshake,
         InvalidMessage,
         InvalidStatusCode,
     )
@@ -402,6 +367,7 @@ class ProtocolError(WebSocketException):
     lazy_import(
         globals(),
         aliases={
+            "AbortHandshake": ".legacy.exceptions",
             "InvalidMessage": ".legacy.exceptions",
             "InvalidStatusCode": ".legacy.exceptions",
             "WebSocketProtocolError": ".legacy.exceptions",

src/websockets/legacy/exceptions.py

@@ -1,8 +1,11 @@
+import http
+
 from .. import datastructures
 from ..exceptions import (
     InvalidHandshake,
     ProtocolError as WebSocketProtocolError,  # noqa: F401
 )
+from ..typing import StatusLike
 
 
 class InvalidMessage(InvalidHandshake):
@@ -24,3 +27,37 @@ def __init__(self, status_code: int, headers: datastructures.Headers) -> None:
 
     def __str__(self) -> str:
         return f"server rejected WebSocket connection: HTTP {self.status_code}"
+
+
+class AbortHandshake(InvalidHandshake):
+    """
+    Raised to abort the handshake on purpose and return an HTTP response.
+
+    This exception is an implementation detail.
+
+    The public API is
+    :meth:`~websockets.legacy.server.WebSocketServerProtocol.process_request`.
+
+    Attributes:
+        status (~http.HTTPStatus): HTTP status code.
+        headers (Headers): HTTP response headers.
+        body (bytes): HTTP response body.
+    """
+
+    def __init__(
+        self,
+        status: StatusLike,
+        headers: datastructures.HeadersLike,
+        body: bytes = b"",
+    ) -> None:
+        # If a user passes an int instead of a HTTPStatus, fix it automatically.
+        self.status = http.HTTPStatus(status)
+        self.headers = datastructures.Headers(headers)
+        self.body = body
+
+    def __str__(self) -> str:
+        return (
+            f"HTTP {self.status:d}, "
+            f"{len(self.headers)} headers, "
+            f"{len(self.body)} bytes"
+        )

src/websockets/legacy/server.py

@@ -24,7 +24,6 @@
 from ..asyncio.compatibility import asyncio_timeout
 from ..datastructures import Headers, HeadersLike, MultipleValuesError
 from ..exceptions import (
-    AbortHandshake,
     InvalidHandshake,
     InvalidHeader,
     InvalidOrigin,
@@ -42,7 +41,7 @@
 from ..http11 import SERVER
 from ..protocol import State
 from ..typing import ExtensionHeader, LoggerLike, Origin, StatusLike, Subprotocol
-from .exceptions import InvalidMessage
+from .exceptions import AbortHandshake, InvalidMessage
 from .handshake import build_response, check_request
 from .http import read_request
 from .protocol import WebSocketCommonProtocol, broadcast

tests/legacy/test_exceptions.py

@@ -15,6 +15,10 @@ def test_str(self):
                 InvalidStatusCode(403, Headers()),
                 "server rejected WebSocket connection: HTTP 403",
             ),
+            (
+                AbortHandshake(200, Headers(), b"OK\n"),
+                "HTTP 200, 0 headers, 3 bytes",
+            ),
         ]:
             with self.subTest(exception=exception):
                 self.assertEqual(str(exception), exception_str)

tests/test_exceptions.py

@@ -151,10 +151,6 @@ def test_str(self):
                 InvalidParameterValue("a", "|"),
                 "invalid value for parameter a: |",
             ),
-            (
-                AbortHandshake(200, Headers(), b"OK\n"),
-                "HTTP 200, 0 headers, 3 bytes",
-            ),
             (
                 RedirectHandshake("wss://example.com"),
                 "redirect to wss://example.com",