main-next

.github/workflows/ci.yml

@@ -8,21 +8,20 @@ on:
 
 jobs:
   tox:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     strategy:
-      max-parallel: 5
       matrix:
         python-version:
-        - "3.9"
         - "3.10"
         - "3.11"
         - "3.12"
         - "3.13"
-        - "pypy3.9"
+        - "3.14"
+        - "pypy3.11"
 
     steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-python@v5
+    - uses: actions/checkout@v5
+    - uses: actions/setup-python@v6
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install tox

.readthedocs.yaml

@@ -1,34 +1,16 @@
-# .readthedocs.yaml
-# Read the Docs configuration file
+# Read the Docs configuration file for Sphinx projects
 # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
 
-# Required
 version: 2
 
-# Set the OS, Python version and other tools you might need
 build:
-  os: ubuntu-22.04
+  os: ubuntu-24.04
   tools:
-    python: "3.11"
-    # You can also specify other tool versions:
-    # nodejs: "19"
-    # rust: "1.64"
-    # golang: "1.19"
+    python: "3.14"
+  jobs:
+    install:
+      - pip install -U pip
+      - pip install --group 'docs' .
 
-# Build documentation in the "docs/" directory with Sphinx
 sphinx:
   configuration: docs/source/conf.py
-
-# Optionally build your docs in additional formats such as PDF and ePub
-# formats:
-#    - pdf
-#    - epub
-
-# Optional but recommended, declare the Python requirements required
-# to build your documentation
-# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
-python:
-   install:
-   - requirements: docs/source/requirements.txt
-   - method: pip
-     path: .

CHANGELOG.rst

@@ -1,11 +1,17 @@
 Release History
 ===============
 
-Unreleased
-----------
-
-- <ToDo: add new entries here>
+1.3.0 (2025-06-XX)
+------------------
 
+- Require h11>=0.16 dependency.
+- Fix "Upgrade" header value to match RFC.
+- Add reason "Switching Protocols" to handshake response.
+- Add docs for `wsproto.Connection`
+- Add support for Python 3.12, 3.13, and 3.14.
+- Drop support for Python 3.7, 3.8, and 3.9.
+- Improve Python typing, specifically bytes vs. bytearray.
+- Various linting, styling, and packaging improvements.
 
 1.2.0 (2022-08-23)
 ------------------

MANIFEST.in

@@ -1,8 +1,12 @@
 graft src/wsproto
 graft example
 graft docs
-graft test
+graft tests
 graft bench
+
 prune docs/build
-include README.rst LICENSE CHANGELOG.rst tox.ini .readthedocs.yaml
+
+include README.rst LICENSE CHANGELOG.rst pyproject.toml
+
 global-exclude *.pyc *.pyo *.swo *.swp *.map *.yml *.DS_Store .coverage
+exclude .readthedocs.yaml

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 = 'sphinx_rtd_theme'
+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)