Replacing dict with HTTPHeaders in other modules

Author: michalpokusa

adafruit_httpserver/request.py

@@ -12,6 +12,8 @@
 except ImportError:
     pass
 
+from .headers import HTTPHeaders
+
 
 class HTTPRequest:
     """
@@ -39,20 +41,9 @@ class HTTPRequest:
     http_version: str
     """HTTP version, e.g. "HTTP/1.1"."""
 
-    headers: Dict[str, str]
+    headers: HTTPHeaders
     """
-    Headers from the request as `dict`.
-
-    Values should be accessed using **lower case header names**.
-
-    Example::
-
-            request.headers
-            # {'connection': 'keep-alive', 'content-length': '64' ...}
-            request.headers["content-length"]
-            # '64'
-            request.headers["Content-Length"]
-            # KeyError: 'Content-Length'
+    Headers from the request.
     """
 
     raw_request: bytes
@@ -120,12 +111,12 @@ def _parse_start_line(header_bytes: bytes) -> Tuple[str, str, Dict[str, str], st
         return method, path, query_params, http_version
 
     @staticmethod
-    def _parse_headers(header_bytes: bytes) -> Dict[str, str]:
+    def _parse_headers(header_bytes: bytes) -> HTTPHeaders:
         """Parse HTTP headers from raw request."""
         header_lines = header_bytes.decode("utf8").splitlines()[1:]
 
-        return {
-            name.lower(): value
+        return HTTPHeaders({
+            name: value
             for header_line in header_lines
             for name, value in [header_line.split(": ", 1)]
-        }
+        })

adafruit_httpserver/response.py

@@ -20,14 +20,15 @@
 
 from .mime_type import MIMEType
 from .status import HTTPStatus, CommonHTTPStatus
+from .headers import HTTPHeaders
 
 
 class HTTPResponse:
     """Details of an HTTP response. Use in `HTTPServer.route` decorator functions."""
 
     http_version: str
     status: HTTPStatus
-    headers: Dict[str, str]
+    headers: HTTPHeaders
     content_type: str
 
     filename: Optional[str]
@@ -39,7 +40,7 @@ def __init__(  # pylint: disable=too-many-arguments
         self,
         status: Union[HTTPStatus, Tuple[int, str]] = CommonHTTPStatus.OK_200,
         body: str = "",
-        headers: Dict[str, str] = None,
+        headers: Union[HTTPHeaders, Dict[str, str]] = None,
         content_type: str = MIMEType.TYPE_TXT,
         filename: Optional[str] = None,
         root_path: str = "",
@@ -52,7 +53,7 @@ def __init__(  # pylint: disable=too-many-arguments
         """
         self.status = status if isinstance(status, HTTPStatus) else HTTPStatus(*status)
         self.body = body
-        self.headers = headers or {}
+        self.headers = headers.copy() if isinstance(headers, HTTPHeaders) else HTTPHeaders(headers)
         self.content_type = content_type
         self.filename = filename
         self.root_path = root_path
@@ -64,21 +65,18 @@ def _construct_response_bytes(  # pylint: disable=too-many-arguments
         status: HTTPStatus = CommonHTTPStatus.OK_200,
         content_type: str = MIMEType.TYPE_TXT,
         content_length: Union[int, None] = None,
-        headers: Dict[str, str] = None,
+        headers: HTTPHeaders = None,
         body: str = "",
     ) -> bytes:
         """Constructs the response bytes from the given parameters."""
 
         response = f"{http_version} {status.code} {status.text}\r\n"
 
-        # Make a copy of the headers so that we don't modify the incoming dict
-        response_headers = {} if headers is None else headers.copy()
+        headers.setdefault("Content-Type", content_type)
+        headers.setdefault("Content-Length", content_length or len(body))
+        headers.setdefault("Connection", "close")
 
-        response_headers.setdefault("Content-Type", content_type)
-        response_headers.setdefault("Content-Length", content_length or len(body))
-        response_headers.setdefault("Connection", "close")
-
-        for header, value in response_headers.items():
+        for header, value in headers.items():
             response += f"{header}: {value}\r\n"
 
         response += f"\r\n{body}"
@@ -122,7 +120,7 @@ def _send_response(  # pylint: disable=too-many-arguments
         status: HTTPStatus,
         content_type: str,
         body: str,
-        headers: Dict[str, str] = None,
+        headers: HTTPHeaders = None,
     ):
         self._send_bytes(
             conn,
@@ -140,7 +138,7 @@ def _send_file_response(  # pylint: disable=too-many-arguments
         filename: str,
         root_path: str,
         file_length: int,
-        headers: Dict[str, str] = None,
+        headers: HTTPHeaders = None,
     ):
         self._send_bytes(
             conn,