chore: add type-hints to imapclient/response_lexer.py

Author: JohnVillalovos

imapclient/response_lexer.py

@@ -9,6 +9,8 @@
 external callers.
 """
 
+from typing import Iterator, List, Optional, Tuple, TYPE_CHECKING, Union
+
 from .util import assert_imap_protocol
 
 __all__ = ["TokenSource"]
@@ -31,15 +33,17 @@ class TokenSource:
     the current IMAP literal.
     """
 
-    def __init__(self, text):
+    def __init__(self, text: List[bytes]):
         self.lex = Lexer(text)
         self.src = iter(self.lex)
 
     @property
-    def current_literal(self):
+    def current_literal(self) -> Optional[bytes]:
+        if TYPE_CHECKING:
+            assert self.lex.current_source is not None
         return self.lex.current_source.literal
 
-    def __iter__(self):
+    def __iter__(self) -> Iterator[bytes]:
         return self.src
 
 
@@ -48,11 +52,13 @@ class Lexer:
     A lexical analyzer class for IMAP
     """
 
-    def __init__(self, text):
+    def __init__(self, text: List[bytes]):
         self.sources = (LiteralHandlingIter(chunk) for chunk in text)
-        self.current_source = None
+        self.current_source: Optional[LiteralHandlingIter] = None
 
-    def read_until(self, stream_i, end_char, escape=True):
+    def read_until(
+        self, stream_i: "PushableIterator", end_char: int, escape: bool = True
+    ) -> bytearray:
         token = bytearray()
         try:
             for nextchar in stream_i:
@@ -71,7 +77,7 @@ def read_until(self, stream_i, end_char, escape=True):
         token.append(end_char)
         return token
 
-    def read_token_stream(self, stream_i):
+    def read_token_stream(self, stream_i: "PushableIterator") -> Iterator[bytearray]:
         whitespace = WHITESPACE
         wordchars = NON_SPECIALS
         read_until = self.read_until
@@ -110,7 +116,7 @@ def read_token_stream(self, stream_i):
                     yield token
                 break
 
-    def __iter__(self):
+    def __iter__(self) -> Iterator[bytes]:
         for source in self.sources:
             self.current_source = source
             for tok in self.read_token_stream(iter(source)):
@@ -129,7 +135,8 @@ def __iter__(self):
 # string literal is processed, we peek into this object to grab the
 # literal.
 class LiteralHandlingIter:
-    def __init__(self, resp_record):
+    def __init__(self, resp_record: Union[Tuple[bytes, bytes], bytes]):
+        self.literal: Optional[bytes]
         if isinstance(resp_record, tuple):
             # A 'record' with a string which includes a literal marker, and
             # the literal itself.
@@ -141,27 +148,27 @@ def __init__(self, resp_record):
             self.src_text = resp_record
             self.literal = None
 
-    def __iter__(self):
+    def __iter__(self) -> "PushableIterator":
         return PushableIterator(self.src_text)
 
 
 class PushableIterator:
     NO_MORE = object()
 
-    def __init__(self, it):
+    def __init__(self, it: bytes):
         self.it = iter(it)
-        self.pushed = []
+        self.pushed: List[int] = []
 
-    def __iter__(self):
+    def __iter__(self) -> "PushableIterator":
         return self
 
-    def __next__(self):
+    def __next__(self) -> int:
         if self.pushed:
             return self.pushed.pop()
         return next(self.it)
 
     # For Python 2 compatibility
     next = __next__
 
-    def push(self, item):
+    def push(self, item: int) -> None:
         self.pushed.append(item)

pyproject.toml

@@ -50,7 +50,6 @@ module = [
     "imapclient.config",
     "imapclient.imapclient",
     "imapclient.interact",
-    "imapclient.response_lexer",
     "imapclient.response_parser",
     "imapclient.response_types",
     "interact",