Fix all typing issues

Author: Kludex

httptools/parser/__init__.py

@@ -1,6 +1,29 @@
 from .protocol import HTTPProtocol
-from .parser import *  # NoQA
-from .errors import *  # NoQA
-from .url_parser import *  # NoQA
+from .parser import HttpParser, HttpRequestParser, HttpResponseParser  # NoQA
+from .errors import (
+    HttpParserError,
+    HttpParserCallbackError,
+    HttpParserInvalidStatusError,
+    HttpParserInvalidMethodError,
+    HttpParserInvalidURLError,
+    HttpParserUpgrade,
+)
+from .url_parser import parse_url
 
-__all__ = parser.__all__ + errors.__all__ + url_parser.__all__  # NoQA
+__all__ = (
+    # protocol
+    "HTTPProtocol",
+    # parser
+    "HttpParser",
+    "HttpRequestParser",
+    "HttpResponseParser",
+    # errors
+    "HttpParserError",
+    "HttpParserCallbackError",
+    "HttpParserInvalidStatusError",
+    "HttpParserInvalidMethodError",
+    "HttpParserInvalidURLError",
+    "HttpParserUpgrade",
+    # url_parser
+    "parse_url",
+)

httptools/parser/parser.pyi

@@ -1,57 +1,53 @@
-from typing import Union, Any
+from typing import Union
 from array import array
 from .protocol import HTTPProtocol
 
 class HttpParser:
-    def __init__(self, protocol: Union[HTTPProtocol, Any]) -> None:
-        """
-        protocol -- a Python object with the following methods
-        (all optional):
-
-          - on_message_begin()
-          - on_url(url: bytes)
-          - on_header(name: bytes, value: bytes)
-          - on_headers_complete()
-          - on_body(body: bytes)
-          - on_message_complete()
-          - on_chunk_header()
-          - on_chunk_complete()
-          - on_status(status: bytes)
+    def __init__(self, protocol: HTTPProtocol) -> None:
+        """The HTTP parser.
+
+        Args:
+            protocol(HTTPProtocol): a Python object with the following methods (all optional):
+                - on_message_begin(self): ...
+                - on_url(self, url: bytes): ...
+                - on_header(self, name: bytes, value: bytes): ...
+                - on_headers_complete(self): ...
+                - on_body(self, body: bytes): ...
+                - on_message_complete(self): ...
+                - on_chunk_header(self): ...
+                - on_chunk_complete(self): ...
+                - on_status(self, status: bytes): ...
         """
 
     def get_http_version(self) -> str:
         """Return an HTTP protocol version."""
-        ...
 
     def should_keep_alive(self) -> bool:
         """Return ``True`` if keep-alive mode is preferred."""
-        ...
 
     def should_upgrade(self) -> bool:
         """Return ``True`` if the parsed request is a valid Upgrade request.
         The method exposes a flag set just before on_headers_complete.
         Calling this method earlier will only yield `False`."""
-        ...
 
-    def feed_data(self, data: Union[bytes, bytearray, memoryview, array]) -> None:
+    def feed_data(self, data: Union[bytes, bytearray, memoryview, array[int]]) -> None:
         """Feed data to the parser.
 
-        Will eventually trigger callbacks on the ``protocol``
-        object.
+        Will eventually trigger callbacks on the ``protocol`` object.
 
         On HTTP upgrade, this method will raise an
         ``HttpParserUpgrade`` exception, with its sole argument
         set to the offset of the non-HTTP data in ``data``.
         """
 
 class HttpRequestParser(HttpParser):
-    """Used for parsing http requests from the server's side"""
+    """Used for parsing http requests from the server side."""
 
     def get_method(self) -> bytes:
-        """Return HTTP request method (GET, HEAD, etc)"""
+        """Retrieve the HTTP method of the request."""
 
 class HttpResponseParser(HttpParser):
-    """Used for parsing http requests from the client's side"""
+    """Used for parsing http responses from the client side."""
 
     def get_status_code(self) -> int:
-        """Return the status code of the HTTP response"""
+        """Retrieve the status code of the HTTP response."""

httptools/parser/protocol.py

@@ -4,12 +4,12 @@
 class HTTPProtocol(Protocol):
     """Used for providing static type-checking when parsing through the http protocol"""
 
-    def on_message_begin() -> None: ...
-    def on_url(url: bytes) -> None: ...
-    def on_header(name: bytes, value: bytes) -> None: ...
-    def on_headers_complete() -> None: ...
-    def on_body(body: bytes) -> None: ...
-    def on_message_complete() -> None: ...
-    def on_chunk_header() -> None: ...
-    def on_chunk_complete() -> None: ...
-    def on_status(status: bytes) -> None: ...
+    def on_message_begin(self) -> None: ...
+    def on_url(self, url: bytes) -> None: ...
+    def on_header(self, name: bytes, value: bytes) -> None: ...
+    def on_headers_complete(self) -> None: ...
+    def on_body(self, body: bytes) -> None: ...
+    def on_message_complete(self) -> None: ...
+    def on_chunk_header(self) -> None: ...
+    def on_chunk_complete(self) -> None: ...
+    def on_status(self, status: bytes) -> None: ...

httptools/parser/url_parser.pyi

@@ -10,18 +10,17 @@ class URL:
     fragment: bytes
     userinfo: bytes
 
-def parse_url(url: Union[bytes, bytearray, memoryview, array]) -> URL:
+def parse_url(url: Union[bytes, bytearray, memoryview, array[int]]) -> URL:
     """Parse URL strings into a structured Python object.
 
     Returns an instance of ``httptools.URL`` class with the
     following attributes:
 
-      - schema: bytes
-      - host: bytes
+      - schema(bytes): The schema of the URL.
+      - host(bytes): The host of the URL.
       - port: int
-      - path: bytes
-      - query: bytes
-      - fragment: bytes
-      - userinfo: bytes
+      - path(bytes): The path of the URL.
+      - query(bytes): The query of the URL.
+      - fragment(bytes): The fragment of the URL.
+      - userinfo(bytes): The userinfo of the URL.
     """
-    ...