Add type hints to hyperframe

sethmlarson · web-flow · commit 72a6db5897e1 · 2021-02-26T08:55:27.000-06:00
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -8,6 +8,10 @@ dev
 
 -
 
+**API Changes (Backward-compatible)**
+
+- Added type hints.
+
 **Bugfixes**
 
 -
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -4,4 +4,5 @@ graft test
 prune docs/build
 prune test/http2-frame-test-case
 include README.rst LICENSE CHANGELOG.rst CONTRIBUTORS.rst tox.ini .gitmodules
+include src/hyperframe/py.typed
 global-exclude *.pyc *.pyo *.swo *.swp *.map *.yml *.DS_Store
diff --git a/setup.cfg b/setup.cfg
@@ -19,3 +19,8 @@ source =
 
 [flake8]
 max-line-length = 120
+
+[check-manifest]
+ignore =
+    Makefile
+    test/http2-frame-test-case
diff --git a/setup.py b/setup.py
@@ -33,7 +33,7 @@
     author_email='cory@lukasa.co.uk',
     url='https://github.com/python-hyper/hyperframe/',
     packages=find_packages(where="src"),
-    package_data={'': ['LICENSE', 'README.rst', 'CHANGELOG.rst']},
+    package_data={'': ['LICENSE', 'README.rst', 'CHANGELOG.rst'], "hyperframe": ["py.typed"]},
     package_dir={'': 'src'},
     python_requires='>=3.6.1',
     include_package_data=True,
diff --git a/src/hyperframe/exceptions.py b/src/hyperframe/exceptions.py
@@ -22,14 +22,14 @@ class UnknownFrameError(HyperframeError):
     .. versionchanged:: 6.0.0
         Changed base class from `ValueError` to :class:`HyperframeError`
     """
-    def __init__(self, frame_type, length):
+    def __init__(self, frame_type: int, length: int) -> None:
         #: The type byte of the unknown frame that was received.
         self.frame_type = frame_type
 
         #: The length of the data portion of the unknown frame.
         self.length = length
 
-    def __str__(self):
+    def __str__(self) -> str:
         return (
             "UnknownFrameError: Unknown frame type 0x%X received, "
             "length %d bytes" % (self.frame_type, self.length)
diff --git a/src/hyperframe/flags.py b/src/hyperframe/flags.py
@@ -5,40 +5,43 @@
 
 Defines basic Flag and Flags data structures.
 """
-import collections
 from collections.abc import MutableSet
+from typing import NamedTuple, Iterable, Set, Iterator
 
-Flag = collections.namedtuple("Flag", ["name", "bit"])
 
+class Flag(NamedTuple):
+    name: str
+    bit: int
 
-class Flags(MutableSet):
+
+class Flags(MutableSet):  # type: ignore
     """
     A simple MutableSet implementation that will only accept known flags as
     elements.
 
     Will behave like a regular set(), except that a ValueError will be thrown
     when .add()ing unexpected flags.
     """
-    def __init__(self, defined_flags):
+    def __init__(self, defined_flags: Iterable[Flag]):
         self._valid_flags = set(flag.name for flag in defined_flags)
-        self._flags = set()
+        self._flags: Set[str] = set()
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         return repr(sorted(list(self._flags)))
 
-    def __contains__(self, x):
+    def __contains__(self, x: object) -> bool:
         return self._flags.__contains__(x)
 
-    def __iter__(self):
+    def __iter__(self) -> Iterator[str]:
         return self._flags.__iter__()
 
-    def __len__(self):
+    def __len__(self) -> int:
         return self._flags.__len__()
 
-    def discard(self, value):
+    def discard(self, value: str) -> None:
         return self._flags.discard(value)
 
-    def add(self, value):
+    def add(self, value: str) -> None:
         if value not in self._valid_flags:
             raise ValueError(
                 "Unexpected flag: {}. Valid flags are: {}".format(
diff --git a/src/hyperframe/frame.py b/src/hyperframe/frame.py
diff --git a/src/hyperframe/py.typed b/src/hyperframe/py.typed
diff --git a/tox.ini b/tox.ini

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,10 @@ dev`
`8`	`8`
`9`	`9`	`-`
`10`	`10`
	`11`	`+API Changes (Backward-compatible)`
	`12`	`+`
	`13`	`+- Added type hints.`
	`14`	`+`
`11`	`15`	`Bugfixes`
`12`	`16`
`13`	`17`	`-`