Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions .github/workflows/ci.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand Down
10 changes: 0 additions & 10 deletions .prospector.yml

This file was deleted.

32 changes: 7 additions & 25 deletions .readthedocs.yaml
Original file line numberDiff line numberDiff line change
@@ -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: .
14 changes: 10 additions & 4 deletions CHANGELOG.rst
Original file line numberDiff line numberDiff line change
@@ -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)
------------------
Expand Down
8 changes: 6 additions & 2 deletions MANIFEST.in
Original file line numberDiff line numberDiff line change
@@ -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
2 changes: 2 additions & 0 deletions bench/connection.py
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
from __future__ import annotations

import random
import time
from typing import List
Expand Down
30 changes: 16 additions & 14 deletions docs/source/conf.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 ---------------------------------------------------
Expand All@@ -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.
Expand All@@ -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"]
2 changes: 0 additions & 2 deletions docs/source/requirements.txt

This file was deleted.

8 changes: 4 additions & 4 deletions example/synchronous_client.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand All@@ -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:
Expand All@@ -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)
Expand DownExpand Up@@ -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)


Expand All@@ -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)


Expand Down
13 changes: 6 additions & 7 deletions example/synchronous_server.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand All@@ -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)
Expand All@@ -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()
Expand All@@ -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
Expand All@@ -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
Expand All@@ -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)


Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
main-next by Kriechi · Pull Request #193 · python-hyper/wsproto · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions .github/workflows/ci.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand Down
10 changes: 0 additions & 10 deletions .prospector.yml

This file was deleted.

32 changes: 7 additions & 25 deletions .readthedocs.yaml
Original file line numberDiff line numberDiff line change
@@ -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: .
14 changes: 10 additions & 4 deletions CHANGELOG.rst
Original file line numberDiff line numberDiff line change
@@ -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)
------------------
Expand Down
8 changes: 6 additions & 2 deletions MANIFEST.in
Original file line numberDiff line numberDiff line change
@@ -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
2 changes: 2 additions & 0 deletions bench/connection.py
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
from __future__ import annotations

import random
import time
from typing import List
Expand Down
30 changes: 16 additions & 14 deletions docs/source/conf.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 ---------------------------------------------------
Expand All@@ -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.
Expand All@@ -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"]
2 changes: 0 additions & 2 deletions docs/source/requirements.txt

This file was deleted.

8 changes: 4 additions & 4 deletions example/synchronous_client.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand All@@ -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:
Expand All@@ -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)
Expand DownExpand Up@@ -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)


Expand All@@ -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)


Expand Down
13 changes: 6 additions & 7 deletions example/synchronous_server.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand All@@ -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)
Expand All@@ -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()
Expand All@@ -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
Expand All@@ -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
Expand All@@ -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)


Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' main-next by Kriechi · Pull Request #193 · python-hyper/wsproto · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions .github/workflows/ci.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand Down
10 changes: 0 additions & 10 deletions .prospector.yml

This file was deleted.

32 changes: 7 additions & 25 deletions .readthedocs.yaml
Original file line numberDiff line numberDiff line change
@@ -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: .
14 changes: 10 additions & 4 deletions CHANGELOG.rst
Original file line numberDiff line numberDiff line change
@@ -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)
------------------
Expand Down
8 changes: 6 additions & 2 deletions MANIFEST.in
Original file line numberDiff line numberDiff line change
@@ -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
2 changes: 2 additions & 0 deletions bench/connection.py
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
from __future__ import annotations

import random
import time
from typing import List
Expand Down
30 changes: 16 additions & 14 deletions docs/source/conf.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 ---------------------------------------------------
Expand All@@ -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.
Expand All@@ -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"]
2 changes: 0 additions & 2 deletions docs/source/requirements.txt

This file was deleted.

8 changes: 4 additions & 4 deletions example/synchronous_client.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand All@@ -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:
Expand All@@ -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)
Expand DownExpand Up@@ -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)


Expand All@@ -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)


Expand Down
13 changes: 6 additions & 7 deletions example/synchronous_server.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand All@@ -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)
Expand All@@ -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()
Expand All@@ -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
Expand All@@ -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
Expand All@@ -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)


Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' main-next by Kriechi · Pull Request #193 · python-hyper/wsproto · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions .github/workflows/ci.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand Down
10 changes: 0 additions & 10 deletions .prospector.yml

This file was deleted.

32 changes: 7 additions & 25 deletions .readthedocs.yaml
Original file line numberDiff line numberDiff line change
@@ -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: .
14 changes: 10 additions & 4 deletions CHANGELOG.rst
Original file line numberDiff line numberDiff line change
@@ -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)
------------------
Expand Down
8 changes: 6 additions & 2 deletions MANIFEST.in
Original file line numberDiff line numberDiff line change
@@ -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
2 changes: 2 additions & 0 deletions bench/connection.py
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
from __future__ import annotations

import random
import time
from typing import List
Expand Down
30 changes: 16 additions & 14 deletions docs/source/conf.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 ---------------------------------------------------
Expand All@@ -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.
Expand All@@ -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"]
2 changes: 0 additions & 2 deletions docs/source/requirements.txt

This file was deleted.

8 changes: 4 additions & 4 deletions example/synchronous_client.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand All@@ -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:
Expand All@@ -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)
Expand DownExpand Up@@ -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)


Expand All@@ -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)


Expand Down
13 changes: 6 additions & 7 deletions example/synchronous_server.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand All@@ -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)
Expand All@@ -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()
Expand All@@ -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
Expand All@@ -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
Expand All@@ -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)


Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' main-next by Kriechi · Pull Request #193 · python-hyper/wsproto · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions .github/workflows/ci.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand Down
10 changes: 0 additions & 10 deletions .prospector.yml

This file was deleted.

32 changes: 7 additions & 25 deletions .readthedocs.yaml
Original file line numberDiff line numberDiff line change
@@ -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: .
14 changes: 10 additions & 4 deletions CHANGELOG.rst
Original file line numberDiff line numberDiff line change
@@ -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)
------------------
Expand Down
8 changes: 6 additions & 2 deletions MANIFEST.in
Original file line numberDiff line numberDiff line change
@@ -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
2 changes: 2 additions & 0 deletions bench/connection.py
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
from __future__ import annotations

import random
import time
from typing import List
Expand Down
30 changes: 16 additions & 14 deletions docs/source/conf.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 ---------------------------------------------------
Expand All@@ -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.
Expand All@@ -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"]
2 changes: 0 additions & 2 deletions docs/source/requirements.txt

This file was deleted.

8 changes: 4 additions & 4 deletions example/synchronous_client.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand All@@ -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:
Expand All@@ -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)
Expand DownExpand Up@@ -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)


Expand All@@ -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)


Expand Down
13 changes: 6 additions & 7 deletions example/synchronous_server.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand All@@ -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)
Expand All@@ -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()
Expand All@@ -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
Expand All@@ -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
Expand All@@ -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)


Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' main-next by Kriechi · Pull Request #193 · python-hyper/wsproto · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions .github/workflows/ci.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand Down
10 changes: 0 additions & 10 deletions .prospector.yml

This file was deleted.

32 changes: 7 additions & 25 deletions .readthedocs.yaml
Original file line numberDiff line numberDiff line change
@@ -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: .
14 changes: 10 additions & 4 deletions CHANGELOG.rst
Original file line numberDiff line numberDiff line change
@@ -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)
------------------
Expand Down
8 changes: 6 additions & 2 deletions MANIFEST.in
Original file line numberDiff line numberDiff line change
@@ -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
2 changes: 2 additions & 0 deletions bench/connection.py
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
from __future__ import annotations

import random
import time
from typing import List
Expand Down
30 changes: 16 additions & 14 deletions docs/source/conf.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 ---------------------------------------------------
Expand All@@ -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.
Expand All@@ -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"]
2 changes: 0 additions & 2 deletions docs/source/requirements.txt

This file was deleted.

8 changes: 4 additions & 4 deletions example/synchronous_client.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand All@@ -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:
Expand All@@ -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)
Expand DownExpand Up@@ -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)


Expand All@@ -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)


Expand Down
13 changes: 6 additions & 7 deletions example/synchronous_server.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand All@@ -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)
Expand All@@ -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()
Expand All@@ -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
Expand All@@ -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
Expand All@@ -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)


Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' main-next by Kriechi · Pull Request #193 · python-hyper/wsproto · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions .github/workflows/ci.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand Down
10 changes: 0 additions & 10 deletions .prospector.yml

This file was deleted.

32 changes: 7 additions & 25 deletions .readthedocs.yaml
Original file line numberDiff line numberDiff line change
@@ -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: .
14 changes: 10 additions & 4 deletions CHANGELOG.rst
Original file line numberDiff line numberDiff line change
@@ -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)
------------------
Expand Down
8 changes: 6 additions & 2 deletions MANIFEST.in
Original file line numberDiff line numberDiff line change
@@ -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
2 changes: 2 additions & 0 deletions bench/connection.py
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
from __future__ import annotations

import random
import time
from typing import List
Expand Down
30 changes: 16 additions & 14 deletions docs/source/conf.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 ---------------------------------------------------
Expand All@@ -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.
Expand All@@ -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"]
2 changes: 0 additions & 2 deletions docs/source/requirements.txt

This file was deleted.

8 changes: 4 additions & 4 deletions example/synchronous_client.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand All@@ -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:
Expand All@@ -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)
Expand DownExpand Up@@ -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)


Expand All@@ -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)


Expand Down
13 changes: 6 additions & 7 deletions example/synchronous_server.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand All@@ -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)
Expand All@@ -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()
Expand All@@ -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
Expand All@@ -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
Expand All@@ -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)


Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); main-next by Kriechi · Pull Request #193 · python-hyper/wsproto · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions .github/workflows/ci.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand Down
10 changes: 0 additions & 10 deletions .prospector.yml

This file was deleted.

32 changes: 7 additions & 25 deletions .readthedocs.yaml
Original file line numberDiff line numberDiff line change
@@ -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: .
14 changes: 10 additions & 4 deletions CHANGELOG.rst
Original file line numberDiff line numberDiff line change
@@ -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)
------------------
Expand Down
8 changes: 6 additions & 2 deletions MANIFEST.in
Original file line numberDiff line numberDiff line change
@@ -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
2 changes: 2 additions & 0 deletions bench/connection.py
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
from __future__ import annotations

import random
import time
from typing import List
Expand Down
30 changes: 16 additions & 14 deletions docs/source/conf.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 ---------------------------------------------------
Expand All@@ -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.
Expand All@@ -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"]
2 changes: 0 additions & 2 deletions docs/source/requirements.txt

This file was deleted.

8 changes: 4 additions & 4 deletions example/synchronous_client.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand All@@ -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:
Expand All@@ -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)
Expand DownExpand Up@@ -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)


Expand All@@ -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)


Expand Down
13 changes: 6 additions & 7 deletions example/synchronous_server.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand All@@ -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)
Expand All@@ -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()
Expand All@@ -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
Expand All@@ -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
Expand All@@ -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)


Expand Down
Loading