Type compatibility with `h11._headers.Header`

Offen

#173 erstellt am 08.7.2022 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 1/5
Geschätzter Aufwand: 1-3 Stunden
Anfängerfreundlichkeit: 48/100

Issue-Typ: Bug
Klarheit: Klar beschrieben
Aktivitätsstatus: Veraltet
Tech-Stack: python
Bereich: networking

Rechercherichtung

Start in src/wsproto/typing.py and inspect how the Headers alias is defined. Compare it with h11._headers.Headers from version 0.13.0, then verify that the reported mypy error is resolved and that existing checks still pass. Done means wsproto.Header is type-compatible with h11 headers.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

At the moment, the wsproto.typing.Header type is not compatible with h11._headers.Header which is defined as the following, starting with version 0.13.0:

class Headers(Sequence[Tuple[bytes, bytes]]):
    [...]

The following patch might provide this compatibility:

diff --git a/src/wsproto/typing.py b/src/wsproto/typing.py
index a44b27e..1786501 100644
--- a/src/wsproto/typing.py
+++ b/src/wsproto/typing.py
@@ -1,3 +1,3 @@
-from typing import List, Tuple
+from typing import Sequence, Tuple
 
-Headers = List[Tuple[bytes, bytes]]
+Headers = Sequence[Tuple[bytes, bytes]]

This would fix mypy errors such as:

error: Argument "headers" to "initiate_upgrade_connection" of "WSConnection" has incompatible type "Headers"; expected "List[Tuple[bytes, bytes]]"  [arg-type]

Would that make sense? I can make a PR if necessary.

Vorherrschende Sprache: Python
Sterne: 303
Forks: 57
PR-Merge-Kennzahlen: Keine gemergten PRs in 30 T.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus python-hyper/wsproto

Compression Offen

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100

python-hyper/wsproto#199 · 5 Kommentare · Erstellt am 20.1.2026
Attempt to close with local-only codes (e.g. 1006) results in normal close (1000) Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 38/100

python-hyper/wsproto#182 · Erstellt am 18.3.2023

Alle Issues in python-hyper/wsproto