Class Response

adafruit_httpserver/response.py:53–147

Response to a given `Request`. Use in `Server.route` handler functions. Base class for all other response classes. Example:: @server.route(path, method) def route_func(request: Request): return Response(request, body='Some content', content_type="text/pla

class Response:
    """
    Response to a given `Request`. Use in `Server.route` handler functions.

    Base class for all other response classes.

    Example::

        @server.route(path, method)
        def route_func(request: Request):

            return Response(request, body='Some content', content_type="text/plain")
    """

    def __init__(
        self,
        request: Request,
        body: Union[str, bytes] = "",
        *,
        status: Union[Status, Tuple[int, str]] = OK_200,
        headers: Union[Headers, Dict[str, str]] = None,
        cookies: Dict[str, str] = None,
        content_type: str = None,
    ) -> None:
        """
        :param Request request: Request that this is a response to.
        :param str body: Body of response. Defaults to empty string.
        :param Status status: Status code and text. Defaults to 200 OK.
        :param Headers headers: Headers to include in response. Defaults to empty dict.
        :param Dict[str, str] cookies: Cookies to be sent with the response.
        :param str content_type: Content type of response. Defaults to None.
        """

        self._request = request
        self._body = body
        self._status = status if isinstance(status, Status) else Status(*status)
        self._headers = headers.copy() if isinstance(headers, Headers) else Headers(headers)
        self._cookies = cookies.copy() if cookies else {}
        self._content_type = content_type
        self._size = 0

    def _send_headers(
        self,
        content_length: Optional[int] = None,
        content_type: str = None,
    ) -> None:
        headers = self._headers.copy()

        response_message_header = f"HTTP/1.1 {self._status.code} {self._status.text}\r\n"

        headers.setdefault("Content-Type", content_type or self._content_type or MIMETypes.DEFAULT)
        headers.setdefault("Content-Length", content_length)
        headers.setdefault("Connection", "close")

        for cookie_name, cookie_value in self._cookies.items():
            headers.add("Set-Cookie", f"{cookie_name}={cookie_value}")

        for header, value in headers.items():