Avoid shadowing the socket module.

Author: aaugustin

docs/project/changelog.rst

@@ -25,14 +25,27 @@ fixing regressions shortly after a release.
 Only documented APIs are public. Undocumented, private APIs may change without
 notice.
 
+.. _17.0:
 
-.. _16.2:
-
-16.2
+17.0
 ----
 
 *In development*
 
+Backwards-incompatible changes
+..............................
+
+.. admonition:: In the :mod:`threading` implementation, the ``socket`` argument
+    is renamed to ``sock``.
+    :class: note
+
+    The first argument of :class:`~sync.client.ClientConnection` and
+    :class:`~sync.server.ServerConnection` is renamed from ``socket`` to
+    ``sock`` for consistency with :func:`~sync.client.connect` and
+    :func:`~sync.server.serve`.  The first argument of
+    :class:`~sync.server.Server` is also renamed. If you're passing it as a
+    keyword argument, you must change your code.
+
 .. _16.1:
 
 16.1

src/websockets/sync/client.py

@@ -54,7 +54,7 @@ class ClientConnection(Connection):
 
     def __init__(
         self,
-        socket: socket.socket,
+        sock: socket.socket,
         protocol: ClientProtocol,
         *,
         ping_interval: float | None = 20,
@@ -65,7 +65,7 @@ def __init__(
         self.protocol: ClientProtocol
         self.response_rcvd = threading.Event()
         super().__init__(
-            socket,
+            sock,
             protocol,
             ping_interval=ping_interval,
             ping_timeout=ping_timeout,

src/websockets/sync/connection.py

@@ -46,15 +46,15 @@ class Connection:
 
     def __init__(
         self,
-        socket: socket.socket,
+        sock: socket.socket,
         protocol: Protocol,
         *,
         ping_interval: float | None = 20,
         ping_timeout: float | None = 20,
         close_timeout: float | None = 10,
         max_queue: int | None | tuple[int | None, int | None] = 16,
     ) -> None:
-        self.socket = socket
+        self.socket = sock
         self.protocol = protocol
         self.ping_interval = ping_interval
         self.ping_timeout = ping_timeout

src/websockets/sync/server.py

@@ -6,7 +6,6 @@
 import re
 import selectors
 import socket
-import socket as socket_module  # shadowed by the socket argument in Server.__init__()
 import ssl as ssl_module
 import sys
 import threading
@@ -63,7 +62,7 @@ class ServerConnection(Connection):
 
     def __init__(
         self,
-        socket: socket.socket,
+        sock: socket.socket,
         protocol: ServerProtocol,
         *,
         ping_interval: float | None = 20,
@@ -74,7 +73,7 @@ def __init__(
         self.protocol: ServerProtocol
         self.request_rcvd = threading.Event()
         super().__init__(
-            socket,
+            sock,
             protocol,
             ping_interval=ping_interval,
             ping_timeout=ping_timeout,
@@ -235,19 +234,19 @@ class Server:
 
     def __init__(
         self,
-        socket: socket.socket,
+        sock: socket.socket,
         handler: Callable[[socket.socket, Any], None],
         logger: LoggerLike | None = None,
     ) -> None:
-        self.socket = socket
+        self.socket = sock
         self.handler = handler
         if logger is None:
             logger = logging.getLogger("websockets.server")
         self.logger = logger
         # On Windows, closing the socket wakes up the poller in serve_forever(),
         # making the notification mechanism unnecessary.
         if sys.platform != "win32":
-            self.shutdown_watcher, self.shutdown_notifier = socket_module.socketpair()
+            self.shutdown_watcher, self.shutdown_notifier = socket.socketpair()
 
     def serve_forever(self) -> None:
         """

src/websockets/version.py

@@ -20,7 +20,7 @@
 
 released = False
 
-tag = version = commit = "16.2"
+tag = version = commit = "17.0"
 
 
 if not released:  # pragma: no cover