Refactor of _HTTPRequest

Changed name and added new attributes to HTTPRequest like method, path, query_params, http_version, headers and body

Author: michalpokusa

adafruit_httpserver/request.py

@@ -1,26 +1,64 @@
+from typing import Dict, Tuple
+
+
+class HTTPRequest:
+
+    method: str
+    path: str
+    query_params: Dict[str, str] = {}
+    http_version: str
+
+    headers: Dict[str, str] = {}
+    body: bytes | None
+
+    raw_request: bytes
 
-class _HTTPRequest:
     def __init__(
-        self, path: str = "", method: str = "", raw_request: bytes = None
+        self, raw_request: bytes = None
     ) -> None:
         self.raw_request = raw_request
-        if raw_request is None:
-            self.path = path
-            self.method = method
-        else:
-            # Parse request data from raw request
-            request_text = raw_request.decode("utf8")
-            first_line = request_text[: request_text.find("\n")]
-            try:
-                (self.method, self.path, _httpversion) = first_line.split()
-            except ValueError as exc:
-                raise ValueError("Unparseable raw_request: ", raw_request) from exc
-
-    def __hash__(self) -> int:
-        return hash(self.method) ^ hash(self.path)
-
-    def __eq__(self, other: "_HTTPRequest") -> bool:
-        return self.method == other.method and self.path == other.path
-
-    def __repr__(self) -> str:
-        return f"_HTTPRequest(path={repr(self.path)}, method={repr(self.method)})"
+
+        if raw_request is None: raise ValueError("raw_request cannot be None")
+
+        try:
+            self.method, self.path, self.query_params, self.http_version = self.parse_start_line(raw_request)
+            self.headers = self.parse_headers(raw_request)
+            self.body = self.parse_body(raw_request)
+        except Exception as error:
+            raise ValueError("Unparseable raw_request: ", raw_request) from error
+
+
+    @staticmethod
+    def parse_start_line(raw_request: bytes) -> Tuple(str, str, Dict[str, str], str):
+        """Parse HTTP Start line to method, path, query_params and http_version."""
+
+        start_line = raw_request.decode("utf8").splitlines()[0]
+
+        method, path, http_version = start_line.split()
+
+        if "?" not in path: path += "?"
+
+        path, query_string = path.split("?", 1)
+        query_params = dict([param.split("=", 1) for param in query_string.split("&")]) if query_string else {}
+
+        return method, path, query_params, http_version
+
+
+    @staticmethod
+    def parse_headers(raw_request: bytes) -> Dict[str, str]:
+        """Parse HTTP headers from raw request."""
+        parsed_request_lines = raw_request.decode("utf8").splitlines()
+        empty_line = parsed_request_lines.index("")
+
+        return dict([header.split(": ", 1) for header in parsed_request_lines[1:empty_line]])
+
+
+    @staticmethod
+    def parse_body(raw_request: bytes) -> Dict[str, str]:
+        """Parse HTTP body from raw request."""
+        parsed_request_lines = raw_request.decode("utf8").splitlines()
+        empty_line = parsed_request_lines.index("")
+
+        if empty_line == len(parsed_request_lines) - 1:
+            return None
+        return "\r\n".join(parsed_request_lines[empty_line+1:])

adafruit_httpserver/server.py

@@ -6,7 +6,7 @@
 from errno import EAGAIN, ECONNRESET
 
 from .methods import HTTPMethod
-from .request import _HTTPRequest
+from .request import HTTPRequest
 from .response import HTTPResponse
 from .status import HTTPStatus
 
@@ -94,7 +94,7 @@ def poll(self):
                 conn.setblocking(True)
                 length, _ = conn.recvfrom_into(self._buffer)
 
-                request = _HTTPRequest(raw_request=self._buffer[:length])
+                request = HTTPRequest(raw_request=self._buffer[:length])
 
                 # If a route exists for this request, call it. Otherwise try to serve a file.
                 route = self.routes.get(request, None)