Move RedirectHandshake to the legacy package.

It is only used by the legacy implementation.

Author: aaugustin

src/websockets/__init__.py

@@ -32,7 +32,6 @@
     "NegotiationError",
     "PayloadTooBig",
     "ProtocolError",
-    "RedirectHandshake",
     "SecurityError",
     "WebSocketException",
     "WebSocketProtocolError",
@@ -47,6 +46,7 @@
     "AbortHandshake",
     "InvalidMessage",
     "InvalidStatusCode",
+    "RedirectHandshake",
     # .legacy.protocol
     "WebSocketCommonProtocol",
     # .legacy.server
@@ -90,7 +90,6 @@
         NegotiationError,
         PayloadTooBig,
         ProtocolError,
-        RedirectHandshake,
         SecurityError,
         WebSocketException,
         WebSocketProtocolError,
@@ -104,6 +103,7 @@
         AbortHandshake,
         InvalidMessage,
         InvalidStatusCode,
+        RedirectHandshake,
     )
     from .legacy.protocol import WebSocketCommonProtocol
     from .legacy.server import (
@@ -152,7 +152,6 @@
             "NegotiationError": ".exceptions",
             "PayloadTooBig": ".exceptions",
             "ProtocolError": ".exceptions",
-            "RedirectHandshake": ".exceptions",
             "SecurityError": ".exceptions",
             "WebSocketException": ".exceptions",
             "WebSocketProtocolError": ".exceptions",
@@ -167,6 +166,7 @@
             "AbortHandshake": ".legacy.exceptions",
             "InvalidMessage": ".legacy.exceptions",
             "InvalidStatusCode": ".legacy.exceptions",
+            "RedirectHandshake": ".legacy.exceptions",
             # .legacy.protocol
             "WebSocketCommonProtocol": ".legacy.protocol",
             # .legacy.server

src/websockets/exceptions.py

@@ -20,7 +20,7 @@
             * :exc:`InvalidParameterName`
             * :exc:`InvalidParameterValue`
         * :exc:`AbortHandshake` (legacy)
-        * :exc:`RedirectHandshake`
+        * :exc:`RedirectHandshake` (legacy)
     * :exc:`InvalidState`
     * :exc:`InvalidURI`
     * :exc:`PayloadTooBig`
@@ -300,21 +300,6 @@ def __str__(self) -> str:
             return f"invalid value for parameter {self.name}: {self.value}"
 
 
-class RedirectHandshake(InvalidHandshake):
-    """
-    Raised when a handshake gets redirected.
-
-    This exception is an implementation detail.
-
-    """
-
-    def __init__(self, uri: str) -> None:
-        self.uri = uri
-
-    def __str__(self) -> str:
-        return f"redirect to {self.uri}"
-
-
 class InvalidState(WebSocketException, AssertionError):
     """
     Raised when an operation is forbidden in the current state.
@@ -360,6 +345,7 @@ class ProtocolError(WebSocketException):
         AbortHandshake,
         InvalidMessage,
         InvalidStatusCode,
+        RedirectHandshake,
     )
 
     WebSocketProtocolError = ProtocolError
@@ -370,6 +356,7 @@ class ProtocolError(WebSocketException):
             "AbortHandshake": ".legacy.exceptions",
             "InvalidMessage": ".legacy.exceptions",
             "InvalidStatusCode": ".legacy.exceptions",
+            "RedirectHandshake": ".legacy.exceptions",
             "WebSocketProtocolError": ".legacy.exceptions",
         },
     )

src/websockets/legacy/client.py

@@ -22,7 +22,7 @@
     InvalidHandshake,
     InvalidHeader,
     NegotiationError,
-    RedirectHandshake,
+
     SecurityError,
 )
 from ..extensions import ClientExtensionFactory, Extension
@@ -39,7 +39,7 @@
 from ..http11 import USER_AGENT
 from ..typing import ExtensionHeader, LoggerLike, Origin, Subprotocol
 from ..uri import WebSocketURI, parse_uri
-from .exceptions import InvalidMessage, InvalidStatusCode
+from .exceptions import InvalidMessage, InvalidStatusCode, RedirectHandshake
 from .handshake import build_request, check_response
 from .http import read_response
 from .protocol import WebSocketCommonProtocol

src/websockets/legacy/exceptions.py

@@ -61,3 +61,18 @@ def __str__(self) -> str:
             f"{len(self.headers)} headers, "
             f"{len(self.body)} bytes"
         )
+
+
+class RedirectHandshake(InvalidHandshake):
+    """
+    Raised when a handshake gets redirected.
+
+    This exception is an implementation detail.
+
+    """
+
+    def __init__(self, uri: str) -> None:
+        self.uri = uri
+
+    def __str__(self) -> str:
+        return f"redirect to {self.uri}"

tests/legacy/test_exceptions.py

@@ -19,6 +19,10 @@ def test_str(self):
                 AbortHandshake(200, Headers(), b"OK\n"),
                 "HTTP 200, 0 headers, 3 bytes",
             ),
+            (
+                RedirectHandshake("wss://example.com"),
+                "redirect to wss://example.com",
+            ),
         ]:
             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: |",
             ),
-            (
-                RedirectHandshake("wss://example.com"),
-                "redirect to wss://example.com",
-            ),
             (
                 InvalidState("WebSocket connection isn't established yet"),
                 "WebSocket connection isn't established yet",