Changed format of debug logs, added Response.size, fix in send_chunk

Author: michalpokusa

adafruit_httpserver/response.py

@@ -90,6 +90,9 @@ def route_func(request):
     Common MIME types are defined in `adafruit_httpserver.mime_types`.
     """
 
+    size: int = 0
+    """Size of the response in bytes."""
+
     def __init__(  # pylint: disable=too-many-arguments
         self,
         request: Request,
@@ -192,6 +195,9 @@ def send(
         self._send_bytes(self.request.connection, encoded_response_message_body)
         self._response_already_sent = True
 
+        if self.request.server.debug:
+            _debug_response_sent(self)
+
     @staticmethod
     def _check_file_path_is_valid(file_path: str) -> bool:
         """
@@ -270,6 +276,9 @@ def send_file(  # pylint: disable=too-many-arguments
                     self._send_bytes(self.request.connection, bytes_read)
         self._response_already_sent = True
 
+        if self.request.server.debug:
+            _debug_response_sent(self)
+
     def send_chunk(self, chunk: str = "") -> None:
         """
         Sends chunk of response.
@@ -279,6 +288,7 @@ def send_chunk(self, chunk: str = "") -> None:
 
         :param str chunk: String data to be sent.
         """
+        self._check_if_not_already_sent()
         self._check_chunked(True)
 
         if getattr(chunk, "encode", None):
@@ -299,14 +309,19 @@ def __exit__(self, exception_type, exception_value, exception_traceback):
 
         if self.chunked:
             self.send_chunk("")
+        self._response_already_sent = True
+
+        if self.chunked and self.request.server.debug:
+            _debug_response_sent(self)
+
         return True
 
-    @staticmethod
     def _send_bytes(
+        self,
         conn: Union["SocketPool.Socket", "socket.socket"],
         buffer: Union[bytes, bytearray, memoryview],
     ):
-        bytes_sent = 0
+        bytes_sent: int = 0
         bytes_to_send = len(buffer)
         view = memoryview(buffer)
         while bytes_sent < bytes_to_send:
@@ -318,3 +333,16 @@ def _send_bytes(
                 if exc.errno == ECONNRESET:
                     return
                 raise
+        self.size += bytes_sent
+
+
+def _debug_response_sent(response: "Response"):
+    """Prints a message when after a response is sent."""
+    client_ip = response.request.client_address[0]
+    method = response.request.method
+    path = response.request.path
+    req_size = len(response.request.raw_request)
+    status = response.status
+    res_size = response.size
+
+    print(f'{client_ip} -- "{method} {path}" {req_size} -- "{status}" {res_size}')

adafruit_httpserver/server.py

@@ -309,9 +309,6 @@ def poll(self):
                 if (request := self._receive_request(conn, client_address)) is None:
                     return
 
-                if self.debug:
-                    _debug_incoming_request(request)
-
                 # Find a handler for the route
                 handler = self._routes.find_handler(
                     _Route(request.path, request.method)
@@ -397,19 +394,10 @@ def _debug_started_server(server: "Server"):
 
 
 def _debug_stopped_server(server: "Server"):  # pylint: disable=unused-argument
-    """Prints a message when the server stops."""
+    """Prints a message after the server stops."""
     print("Stopped development server")
 
 
-def _debug_incoming_request(request: "Request"):
-    """Prints a message when a request is received."""
-    client_ip = request.client_address[0]
-    method = request.method
-    size = len(request.raw_request)
-
-    print(f"{client_ip} -- {method} {request.path} {size}")
-
-
 def _debug_exception_in_handler(error: Exception):
     """Prints a message when an exception is raised in a handler."""
     print_exception(error)

docs/examples.rst

@@ -228,25 +228,29 @@ During development it is useful to see the logs from the server.
 You can enable debug mode by setting ``debug=True`` on ``Server`` instance or in constructor,
 it is disabled by default.
 
-Debug mode prints messages on server startup, when a request is received and if exception
+Debug mode prints messages on server startup, after sending a response to a request and if exception
 occurs during handling of the request in ``.serve_forever()``.
 
 This is how the logs might look like when debug mode is enabled::
 
     Started development server on http://192.168.0.100:80
-    192.168.0.101 -- GET / 194
-    192.168.0.101 -- GET /example 194
-    192.168.0.102 -- POST /api 241
+    192.168.0.101 -- "GET /" 194 -- "200 OK" 154
+    192.168.0.101 -- "GET /example" 134 -- "404 Not Found" 172
+    192.168.0.102 -- "POST /api" 1241 -- "401 Unauthorized" 95
     Traceback (most recent call last):
         ...
         File "code.py", line 55, in example_handler
     KeyError: non_existent_key
-    192.168.0.103 -- GET /index.html 242
+    192.168.0.103 -- "GET /index.html" 242 -- "200 OK" 154
     Stopped development server
 
+This is the default format of the logs::
 
-If you need more information about the request or you want it in a different format you can modify
-functions at the bottom of ``adafruit_httpserver/server.py`` that start with ``_debug_...``.
+    {client_ip} -- "{request_method} {path}" {request_size} -- "{response_status}" {response_size}
+
+If you need more information about the server or request, or you want it in a different format you can modify
+functions at the bottom of ``adafruit_httpserver/server.py`` and ``adafruit_httpserver/response.py`` that
+start with ``_debug_...``.
 
 NOTE:
 *This is an advanced usage that might change in the future. It is not recommended to modify other parts of the code.*