ruff auto-fixes

Author: Kriechi

bench/connection.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import random
 import time
 from typing import List

docs/source/conf.py

@@ -10,26 +10,28 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
+from __future__ import annotations
+
 import os
-import sys
 import re
+import sys
 
-sys.path.insert(0, os.path.abspath('../..'))
+sys.path.insert(0, os.path.abspath("../.."))
 
 PROJECT_ROOT = os.path.dirname(__file__)
 # Get the version
 version_regex = r'__version__ = ["\']([^"\']*)["\']'
-with open(os.path.join(PROJECT_ROOT, '../../', 'src/wsproto/__init__.py')) as file_:
+with open(os.path.join(PROJECT_ROOT, "../../", "src/wsproto/__init__.py")) as file_:
     text = file_.read()
     match = re.search(version_regex, text)
     version = match.group(1)
 
 
 # -- Project information -----------------------------------------------------
 
-project = 'wsproto'
-copyright = '2020, Benno Rice'
-author = 'Benno Rice'
+project = "wsproto"
+copyright = "2020, Benno Rice"
+author = "Benno Rice"
 release = version
 
 # -- General configuration ---------------------------------------------------
@@ -38,13 +40,13 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.viewcode',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.viewcode",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -53,20 +55,20 @@
 
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {
-    'python': ('https://docs.python.org/', None),
+    "python": ("https://docs.python.org/", None),
 }
 
-master_doc = 'index'
+master_doc = "index"
 
 
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'default'
+html_theme = "default"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]

example/synchronous_client.py

@@ -3,6 +3,7 @@
 response. This is a poor implementation of a client. It is only intended to
 demonstrate how to use wsproto.
 """
+from __future__ import annotations
 
 import socket
 import sys
@@ -28,7 +29,7 @@ def main() -> None:
         host = sys.argv[1]
         port = int(sys.argv[2])
     except (IndexError, ValueError):
-        print("Usage: {} <HOST> <PORT>".format(sys.argv[0]))
+        print(f"Usage: {sys.argv[0]} <HOST> <PORT>")
         sys.exit(1)
 
     try:
@@ -47,7 +48,6 @@ def wsproto_demo(host: str, port: int) -> None:
     3) Send ping and display pong
     4) Negotiate WebSocket closing handshake
     """
-
     # 0) Open TCP connection
     print(f"Connecting to {host}:{port}")
     conn = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
@@ -89,7 +89,7 @@ def wsproto_demo(host: str, port: int) -> None:
 
 def net_send(out_data: bytes, conn: socket.socket) -> None:
     """Write pending data from websocket to network."""
-    print("Sending {} bytes".format(len(out_data)))
+    print(f"Sending {len(out_data)} bytes")
     conn.send(out_data)
 
 
@@ -102,7 +102,7 @@ def net_recv(ws: WSConnection, conn: socket.socket) -> None:
         print("Received 0 bytes (connection closed)")
         ws.receive_data(None)
     else:
-        print("Received {} bytes".format(len(in_data)))
+        print(f"Received {len(in_data)} bytes")
         ws.receive_data(in_data)
 
 

example/synchronous_server.py

@@ -4,6 +4,7 @@
 implementation of a server! It is only intended to demonstrate how to use
 wsproto.
 """
+from __future__ import annotations
 
 import socket
 import sys
@@ -28,7 +29,7 @@ def main() -> None:
         ip = sys.argv[1]
         port = int(sys.argv[2])
     except (IndexError, ValueError):
-        print("Usage: {} <BIND_IP> <PORT>".format(sys.argv[0]))
+        print(f"Usage: {sys.argv[0]} <BIND_IP> <PORT>")
         sys.exit(1)
 
     server = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
@@ -40,7 +41,7 @@ def main() -> None:
         while True:
             print("Waiting for connection...")
             (stream, addr) = server.accept()
-            print("Client connected: {}:{}".format(addr[0], addr[1]))
+            print(f"Client connected: {addr[0]}:{addr[1]}")
             handle_connection(stream)
             stream.shutdown(socket.SHUT_WR)
             stream.close()
@@ -67,7 +68,7 @@ def handle_connection(stream: socket.socket) -> None:
     while running:
         # 1) Read data from network
         in_data = stream.recv(RECEIVE_BYTES)
-        print("Received {} bytes".format(len(in_data)))
+        print(f"Received {len(in_data)} bytes")
         ws.receive_data(in_data)
 
         # 2) Get new events and handle them
@@ -80,9 +81,7 @@ def handle_connection(stream: socket.socket) -> None:
             elif isinstance(event, CloseConnection):
                 # Print log message and break out
                 print(
-                    "Connection closed: code={} reason={}".format(
-                        event.code, event.reason
-                    )
+                    f"Connection closed: code={event.code} reason={event.reason}",
                 )
                 out_data += ws.send(event.response())
                 running = False
@@ -100,7 +99,7 @@ def handle_connection(stream: socket.socket) -> None:
                 print(f"Unknown event: {event!r}")
 
         # 4) Send data from wsproto to network
-        print("Sending {} bytes".format(len(out_data)))
+        print(f"Sending {len(out_data)} bytes")
         stream.send(out_data)
 
 

src/wsproto/__init__.py

@@ -4,13 +4,18 @@
 
 A WebSocket implementation.
 """
+from __future__ import annotations
 
-from typing import Generator, Optional, Union
+from typing import TYPE_CHECKING, Optional, Union
 
 from .connection import Connection, ConnectionState, ConnectionType
-from .events import Event
 from .handshake import H11Handshake
-from .typing import Headers
+
+if TYPE_CHECKING:
+    from collections.abc import Generator
+
+    from .events import Event
+    from .typing import Headers
 
 __version__ = "1.2.0+dev"
 
@@ -29,7 +34,7 @@ def __init__(self, connection_type: ConnectionType) -> None:
         """
         self.client = connection_type is ConnectionType.CLIENT
         self.handshake = H11Handshake(connection_type)
-        self.connection: Optional[Connection] = None
+        self.connection: Connection | None = None
 
     @property
     def state(self) -> ConnectionState:
@@ -42,7 +47,7 @@ def state(self) -> ConnectionState:
         return self.connection.state
 
     def initiate_upgrade_connection(
-        self, headers: Headers, path: Union[bytes, str]
+        self, headers: Headers, path: bytes | str,
     ) -> None:
         self.handshake.initiate_upgrade_connection(headers, path)
 
@@ -65,7 +70,7 @@ def send(self, event: Event) -> bytes:
             data += self.connection.send(event)
         return data
 
-    def receive_data(self, data: Optional[bytes]) -> None:
+    def receive_data(self, data: bytes | None) -> None:
         """
         Feed network data into the connection instance.
 

src/wsproto/connection.py

@@ -4,10 +4,11 @@
 
 An implementation of a WebSocket connection.
 """
+from __future__ import annotations
 
 from collections import deque
 from enum import Enum
-from typing import Deque, Generator, List, Optional
+from typing import TYPE_CHECKING
 
 from .events import (
     BytesMessage,
@@ -18,10 +19,14 @@
     Pong,
     TextMessage,
 )
-from .extensions import Extension
 from .frame_protocol import CloseReason, FrameProtocol, Opcode, ParseFailed
 from .utilities import LocalProtocolError
 
+if TYPE_CHECKING:
+    from collections.abc import Generator
+
+    from .extensions import Extension
+
 
 class ConnectionState(Enum):
     """
@@ -68,7 +73,7 @@ class Connection:
     def __init__(
         self,
         connection_type: ConnectionType,
-        extensions: Optional[List[Extension]] = None,
+        extensions: list[Extension] | None = None,
         trailing_data: bytes = b"",
     ) -> None:
         """
@@ -82,7 +87,7 @@ def __init__(
             processed.
         """
         self.client = connection_type is ConnectionType.CLIENT
-        self._events: Deque[Event] = deque()
+        self._events: deque[Event] = deque()
         self._proto = FrameProtocol(self.client, extensions or [])
         self._state = ConnectionState.OPEN
         self.receive_data(trailing_data)
@@ -109,12 +114,13 @@ def send(self, event: Event) -> bytes:
             else:
                 self._state = ConnectionState.LOCAL_CLOSING
         else:
+            msg = f"Event {event} cannot be sent in state {self.state}."
             raise LocalProtocolError(
-                f"Event {event} cannot be sent in state {self.state}."
+                msg,
             )
         return data
 
-    def receive_data(self, data: Optional[bytes]) -> None:
+    def receive_data(self, data: bytes | None) -> None:
         """
         Pass some received data to the connection for handling.
 
@@ -124,7 +130,6 @@ def receive_data(self, data: Optional[bytes]) -> None:
         :param data: The data received from the remote peer on the network.
         :type data: ``bytes``
         """
-
         if data is None:
             # "If _The WebSocket Connection is Closed_ and no Close control
             # frame was received by the endpoint (such as could occur if the
@@ -137,7 +142,8 @@ def receive_data(self, data: Optional[bytes]) -> None:
         if self.state in (ConnectionState.OPEN, ConnectionState.LOCAL_CLOSING):
             self._proto.receive_bytes(data)
         elif self.state is ConnectionState.CLOSED:
-            raise LocalProtocolError("Connection already closed.")
+            msg = "Connection already closed."
+            raise LocalProtocolError(msg)
         else:
             pass  # pragma: no cover
 
@@ -154,12 +160,14 @@ def events(self) -> Generator[Event, None, None]:
         try:
             for frame in self._proto.received_frames():
                 if frame.opcode is Opcode.PING:
-                    assert frame.frame_finished and frame.message_finished
+                    assert frame.frame_finished
+                    assert frame.message_finished
                     assert isinstance(frame.payload, (bytes, bytearray))
                     yield Ping(payload=frame.payload)
 
                 elif frame.opcode is Opcode.PONG:
-                    assert frame.frame_finished and frame.message_finished
+                    assert frame.frame_finished
+                    assert frame.message_finished
                     assert isinstance(frame.payload, (bytes, bytearray))
                     yield Pong(payload=frame.payload)