Repository navigation
Type compatibility with h11._headers.Header #173
Description
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.
Activity
pgjones commentedon Aug 23, 2022
I think the issue here is that wsproto doesn't accept (by typing) a
h11.Headersinstance as an argument toinitiate_upgrade_connection. I think this is correct as I don't thinkh11.Headersshould be used in other libraries. It is also possible to convert ah11.Headersto a list for wsproto via something likelist(headers).