High-performance QUIC/HTTP3 library — picoquic-backed, qh3-compatible asyncio API
Project description
aiopquic - Async QUIC + WebTransport (picoquic)
aiopquic is a Python/Cython binding to picoquic, providing high-performance QUIC transport and WebTransport for asyncio applications.
Overview
aiopquic exposes picoquic's QUIC implementation through a lock-free SPSC ring buffer architecture that bridges the picoquic network thread with Python's asyncio event loop. It provides an asyncio QUIC/HTTP3 transport API in the spirit of aioquic (and its fork qh3) — similar shapes for QuicConfiguration, QuicConnection, connect / serve, and event types — plus a native WebTransport client/server layered on picoquic's H3 + h3zero. Not a drop-in replacement: semantics differ around backpressure (send_stream_data raises BufferError on full per-stream ring) and flow-control sizing.
Architecture
- SPSC Ring Buffers -- Lock-free single producer/single consumer rings for event passing between threads, separate TX and RX rings per
TransportContext. - TX path -- Asyncio pushes into per-stream byte ring; picoquic pulls at wire rate via
prepare_to_send. - RX path -- picoquic pushes per-event
StreamChunks; ownership transfers at pop for 1-copy delivery. - Cross-platform wake fd -- Linux
eventfdfor efficient asyncioadd_reader()notification;pipe()self-pipe fallback on macOS / BSD. - Dedicated Network Thread -- picoquic runs in its own thread via
picoquic_start_network_thread(). - Cython Bridge -- Thin Cython layer over C callbacks, minimal overhead.
- WebTransport --
asyncio.webtransport.WebTransportSession(client + server) over picoquic'spicowt_*API and h3zero.
Features
- QUIC client and server:
connect,serve,QuicConnectionProtocol - Stream data send/receive with FIN signaling, stream reset, stop_sending
- WebTransport client + server:
serve_webtransport,WebTransportSession - QUIC datagram TX + RX (note: WebTransport datagram TX not yet wired)
- Connection migration / 0-RTT (inherited from picoquic)
- Connection management: create, close, idle timeout, application close codes
- Per-cnx multiplexing on the server side via
QuicEngine - TLS keylog (NSS Key Log Format) for pcap decryption
- Native picoquic_ct / picohttp_ct subprocess smoke (catches upstream regressions on every submodule update)
Test Results
Tests pass on Linux and macOS. The interop suite is opt-in (network-dependent).
| Suite | Coverage |
|---|---|
test_spsc_ring |
per-event malloc ring lifecycle |
test_buffer |
Cython Buffer |
test_transport |
Transport lifecycle, wake fd, wake-up, connection management |
test_loopback |
17 tests — handshake, streams, FIN, reset, datagrams, ALPN mismatch, idle timeout, app-close codes, stop_sending, many-streams stress, TX-ring overflow |
test_asyncio |
client/server stream + datagram exchange via connect / serve |
test_baton_pattern |
Pure-QUIC baton-style stream multiplexing (UNI ↔ BIDI) |
test_native_picoquic |
picoquic_ct / picohttp_ct subprocess driver |
test_interop |
Real public endpoints (opt-in) |
tests/bench/ |
microbenches: ring push/pop, single-shot/sustained/parallel/bidirectional throughput, datagrams, RTT latency, handshake rate, byte-verifying object stress + stream churn + concurrent streams (opt-in via pytest tests/bench) |
Performance
Single-host loopback on AMD Ryzen 7 PRO 7840U (Zen 4), Linux, Python 3.14, against the released wheel (manylinux_2_34, OpenSSL 3.5.1). Byte-perfect across every run.
Single-stream sustained (30s, lowlevel SPSC ring):
| obj | obj/s | throughput | latency p50 | latency p99 |
|---|---|---|---|---|
| 1 KiB | 293K | 2,400 Mbps | 98 µs | 834 µs |
| 4 KiB | 83K | 2,732 Mbps | 3,139 µs | 4,798 µs |
| 16 KiB | 21K | 2,746 Mbps | 3,142 µs | 5,029 µs |
High-level API (QuicConnection.send_stream_data, what client libraries see, 30s):
| obj | obj/s | throughput | latency p50 |
|---|---|---|---|
| 1 KiB | 229K | 1,875 Mbps | 370 µs |
| 4 KiB | 74K | 2,439 Mbps | 3,488 µs |
| 16 KiB | 18K | 2,424 Mbps | 3,509 µs |
Multi-stream (concurrent streams on one connection, line rate):
| P × obj | streams complete | obj/s | throughput |
|---|---|---|---|
| 64 × 4 KiB | 64/64 | 97K | 3,190 Mbps |
| 256 × 4 KiB | 256/256 | 91K | 2,983 Mbps |
| 64 × 16 KiB | 64/64 | 42K | 5,481 Mbps |
Stream churn (open/send/FIN, byte-verifying):
| streams × obj | streams/s | throughput |
|---|---|---|
| 1000 × 4 obj × 256 B | 48,654 | 399 Mbps |
| 100 × 16 obj × 1 KiB | 12,600 | 1,651 Mbps |
| 200 × 64 obj × 4 KiB | 1,723 | 3,614 Mbps |
Installation
Wheels for cp312 / cp313 / cp314 on Linux (manylinux_2_34, glibc 2.34+) and macOS arm64 are published to PyPI:
uv pip install aiopquic # or: pip install aiopquic
For older Linux (glibc 2.28–2.33) install via sdist; build toolchain required.
From source
git clone https://github.com/gmarzot/aiopquic.git
cd aiopquic
git submodule update --init --recursive
./bootstrap_python.sh # creates .venv with uv-managed Python 3.14t and pins cython 3.2+
source .venv/bin/activate
./build_picoquic.sh # builds picotls, picoquic, native test drivers
uv pip install -e '.[dev]' # or: pip install -e '.[dev]'
On macOS, set OPENSSL_ROOT_DIR if Homebrew OpenSSL is not auto-detected (the build script tries openssl@3 then openssl@1.1).
Usage
Low-level Transport API
from aiopquic._binding._transport import TransportContext
server = TransportContext()
server.start(port=4433, cert_file="cert.pem", key_file="key.pem", alpn="moq-00", is_client=False)
client = TransportContext()
client.start(port=0, alpn="moq-00", is_client=True)
client.create_client_connection("127.0.0.1", 4433, sni="localhost", alpn="moq-00")
Asyncio API
from aiopquic.asyncio.client import connect
from aiopquic.quic.configuration import QuicConfiguration
configuration = QuicConfiguration(alpn_protocols=["myproto"], is_client=True)
async with connect("server", 4433, configuration=configuration) as protocol:
quic = protocol._quic
stream_id = quic.get_next_available_stream_id()
quic.send_stream_data(stream_id, payload, end_stream=True)
protocol.transmit()
payload is opaque bytes; the library doesn't impose framing. Consumers
that want HTTP/3 layer on top of aiopquic's picowt-backed h3zero
plumbing; consumers that want WebTransport use serve_webtransport /
connect_webtransport. Most direct users of the asyncio API ship their
own protocol bytes (MoQT, custom binary frames, etc.).
WebTransport
from aiopquic.asyncio.webtransport import (
serve_webtransport, WebTransportSession,
)
# See src/aiopquic/asyncio/webtransport.py and tests/ for full examples.
Development
uv pip install -e '.[dev]' # or: pip install -e '.[dev]'
python -m pytest tests/ -v -m "not interop and not native"
# Microbenches (opt-in)
python -m pytest tests/bench
Known Limitations
- Free-threaded Python (3.14t) not yet supported -- the TX-ring producer side,
TransportContextlifecycle, and the WebTransport engine state currently rely on the GIL for serialization. FT support deferred until a per-context locking audit lands. - STOP_SENDING error codes surface as 0 today: picoquic's public stream-error getter only returns the RESET_STREAM code. STOP_SENDING's code lives in
stream->remote_stop_errorinpicoquic_internal.h(no public getter). A small helper that pulls the field is straightforward future work — see TODO insrc/aiopquic/_binding/c/callback.h. - Per-stream wrapper cleanup before connection close -- per-stream
aiopquic_stream_ctx_t*wrappers are freed at connection close rather than at stream RESET/FIN. Bounded leak per cnx; flagged for follow-up.
TODO
- Windows support (eventfd alternative — IOCP / WSAEventSelect on the wake-fd path)
- Free-threaded Python (3.14t) support after producer-side locking audit
- STOP_SENDING error-code surfacing helper (read
remote_stop_errorfrom picoquic_internal.h) - Per-stream wrapper cleanup on RESET/FIN before connection close
- WebTransport datagram TX path through the C bridge
- Datagram benches: latency percentiles, payload-size sweep, loss / jitter under load (today's
bench_datagramis fire-and-count throughput only) - Pure stream open/close microbench (lifecycle rate without payload, separate from
bench_stream_churn_highlevelwhich bundles writes + FIN) - Submit aiopquic to the QUIC interop runner for cross-implementation coverage
Resources
- picoquic -- QUIC implementation by Christian Huitema
- picotls -- TLS 1.3 implementation
- Media Over QUIC Working Group
A Marz Research project.
Author: G. S. Marzot <gmarzot@marzresearch.net>
License
MIT License -- see LICENSE
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file aiopquic-0.2.4.tar.gz.
File metadata
- Download URL: aiopquic-0.2.4.tar.gz
- Upload date:
- Size: 405.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d793a8d45cf030359ed45d4aacce547c1a7e4c87d7ffdc0675683bc1fe03bca7
|
|
| MD5 |
80bf628c0951c863b1c60f9028c97b71
|
|
| BLAKE2b-256 |
26cf9b3b4ba96899b32ca3176e9875b9a88930a555a24f296dba02a2e0e0e553
|
File details
Details for the file aiopquic-0.2.4-cp314-cp314-manylinux_2_34_x86_64.whl.
File metadata
- Download URL: aiopquic-0.2.4-cp314-cp314-manylinux_2_34_x86_64.whl
- Upload date:
- Size: 4.2 MB
- Tags: CPython 3.14, manylinux: glibc 2.34+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
12edc59900c44c9a6b3bd50b0f3a7b1b9076f3bee8c628faa252dd6c2dd8ce18
|
|
| MD5 |
99e4ed251825ec14ed58c8b60891e9b1
|
|
| BLAKE2b-256 |
a4d471441836608f2ecff2b34cdace58bee3c16fc4cc5b4d16d512e02f31f579
|
File details
Details for the file aiopquic-0.2.4-cp314-cp314-macosx_14_0_arm64.whl.
File metadata
- Download URL: aiopquic-0.2.4-cp314-cp314-macosx_14_0_arm64.whl
- Upload date:
- Size: 3.6 MB
- Tags: CPython 3.14, macOS 14.0+ ARM64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e9b97b3aed00605f5062d22300cf33b8fe44cc7ef4bfaa3862ee3d3312aa8405
|
|
| MD5 |
36c464d47601f6090c3c69861e56aeb0
|
|
| BLAKE2b-256 |
785e58862279e9692058768687a5ffec2e50f48eb42a993b9720a734cf64eb00
|
File details
Details for the file aiopquic-0.2.4-cp313-cp313-manylinux_2_34_x86_64.whl.
File metadata
- Download URL: aiopquic-0.2.4-cp313-cp313-manylinux_2_34_x86_64.whl
- Upload date:
- Size: 4.2 MB
- Tags: CPython 3.13, manylinux: glibc 2.34+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f88eba90f7decd36f7e185c45cd0eac2a9d83368c7cc15802eb85feafe193f30
|
|
| MD5 |
bfc301825b371f7c84a96c2e4fe289f2
|
|
| BLAKE2b-256 |
b6b95fc15f2ad63216f45e7a631f460b3faca456798e0ff190f4d271de57794d
|
File details
Details for the file aiopquic-0.2.4-cp313-cp313-macosx_14_0_arm64.whl.
File metadata
- Download URL: aiopquic-0.2.4-cp313-cp313-macosx_14_0_arm64.whl
- Upload date:
- Size: 3.6 MB
- Tags: CPython 3.13, macOS 14.0+ ARM64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8f2079e0fd176c9a1f154a020660dc1e699e969df10a8c7e948be9da37bbeb6e
|
|
| MD5 |
c35a91b7a1fe4836f206317ddfbcfc41
|
|
| BLAKE2b-256 |
0581cf456e051560631d8b21db762790d4370633f9be71f12c65174e088c5e28
|
File details
Details for the file aiopquic-0.2.4-cp312-cp312-manylinux_2_34_x86_64.whl.
File metadata
- Download URL: aiopquic-0.2.4-cp312-cp312-manylinux_2_34_x86_64.whl
- Upload date:
- Size: 4.2 MB
- Tags: CPython 3.12, manylinux: glibc 2.34+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
abcbceffcaa2c049d0bf01d1bd722a9e4deb4b8f3f896e94e363a889b7c5fce9
|
|
| MD5 |
9261a43cb5e3afa1259d3fc64629e144
|
|
| BLAKE2b-256 |
3a0e112862ab124acc429630bc66abbe321bdefd6e8912dbb03183a89ec91fbf
|
File details
Details for the file aiopquic-0.2.4-cp312-cp312-macosx_14_0_arm64.whl.
File metadata
- Download URL: aiopquic-0.2.4-cp312-cp312-macosx_14_0_arm64.whl
- Upload date:
- Size: 3.6 MB
- Tags: CPython 3.12, macOS 14.0+ ARM64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bbcbb5cba4306ec42f01b3e5ab3644bc35e4b8980f444a545368ef13b20cb46f
|
|
| MD5 |
61cb13ef5eef20311ef97d2717e3e7d2
|
|
| BLAKE2b-256 |
b899825c1d06dbcdb86b205164d57967be945ff7c8407839317097419b5461b7
|