Module supertokens_python.framework.fastapi.fastapi_response

Classes

class FastApiResponse (response: starlette.responses.Response)

Helper class that provides a standard way to create an ABC using inheritance.

Expand source code

class FastApiResponse(BaseResponse):
    from fastapi import Response

    def __init__(self, response: Response):
        super().__init__({})
        self.response = response
        self.original = response
        self.parser_checked = False
        self.response_sent = False
        self.status_set = False

    def set_html_content(self, content: str):
        if not self.response_sent:
            body = bytes(content, "utf-8")
            self.set_header("Content-Length", str(len(body)))
            self.set_header("Content-Type", "text/html")
            self.response.body = body
            self.response_sent = True

    def set_cookie(
        self,
        key: str,
        value: str,
        expires: int,
        path: str = "/",
        domain: Optional[str] = None,
        secure: bool = False,
        httponly: bool = False,
        samesite: str = "lax",
    ):
        # Note: For FastAPI response object, the expires value
        # doesn't mean the absolute time in ms, but the duration in seconds
        # So we need to convert our absolute expiry time (ms) to a duration (seconds)

        # we do ceil because if we do floor, we tests may fail where the access
        # token lifetime is set to 1 second
        self.response.set_cookie(
            key=key,
            value=value,  # Note: Unlike other frameworks, FastAPI wraps the value in quotes in Set-Cookie header
            expires=ceil((expires - get_timestamp_ms()) / 1000),
            path=path,
            domain=domain,  # type: ignore # starlette didn't set domain as optional type but their default value is None anyways
            secure=secure,
            httponly=httponly,
            samesite=samesite,
        )

    def set_header(self, key: str, value: str):
        self.response.headers[key] = value

    def get_header(self, key: str) -> Optional[str]:
        return self.response.headers.get(key, None)

    def remove_header(self, key: str):
        del self.response.headers[key]

    def set_status_code(self, status_code: int):
        if not self.status_set:
            self.response.status_code = status_code
            self.status_code = status_code
            self.status_set = True

    def set_json_content(self, content: Dict[str, Any]):
        if not self.response_sent:
            body = json.dumps(
                content,
                ensure_ascii=False,
                allow_nan=False,
                indent=None,
                separators=(",", ":"),
            ).encode("utf-8")
            self.set_header("Content-Type", "application/json; charset=utf-8")
            self.set_header("Content-Length", str(len(body)))
            self.response.body = body
            self.response_sent = True

Ancestors

• BaseResponse
• abc.ABC

Class variables

var Response

Methods

def get_header(self, key: str) ‑> Optional[str]

Expand source code

def get_header(self, key: str) -> Optional[str]:
    return self.response.headers.get(key, None)

def remove_header(self, key: str)

Expand source code

def remove_header(self, key: str):
    del self.response.headers[key]

def set_cookie(self, key: str, value: str, expires: int, path: str = '/', domain: Optional[str] = None, secure: bool = False, httponly: bool = False, samesite: str = 'lax')

Expand source code

def set_cookie(
    self,
    key: str,
    value: str,
    expires: int,
    path: str = "/",
    domain: Optional[str] = None,
    secure: bool = False,
    httponly: bool = False,
    samesite: str = "lax",
):
    # Note: For FastAPI response object, the expires value
    # doesn't mean the absolute time in ms, but the duration in seconds
    # So we need to convert our absolute expiry time (ms) to a duration (seconds)

    # we do ceil because if we do floor, we tests may fail where the access
    # token lifetime is set to 1 second
    self.response.set_cookie(
        key=key,
        value=value,  # Note: Unlike other frameworks, FastAPI wraps the value in quotes in Set-Cookie header
        expires=ceil((expires - get_timestamp_ms()) / 1000),
        path=path,
        domain=domain,  # type: ignore # starlette didn't set domain as optional type but their default value is None anyways
        secure=secure,
        httponly=httponly,
        samesite=samesite,
    )

def set_header(self, key: str, value: str)

Expand source code

def set_header(self, key: str, value: str):
    self.response.headers[key] = value

def set_html_content(self, content: str)

Expand source code

def set_html_content(self, content: str):
    if not self.response_sent:
        body = bytes(content, "utf-8")
        self.set_header("Content-Length", str(len(body)))
        self.set_header("Content-Type", "text/html")
        self.response.body = body
        self.response_sent = True

def set_json_content(self, content: Dict[str, Any])

Expand source code

def set_json_content(self, content: Dict[str, Any]):
    if not self.response_sent:
        body = json.dumps(
            content,
            ensure_ascii=False,
            allow_nan=False,
            indent=None,
            separators=(",", ":"),
        ).encode("utf-8")
        self.set_header("Content-Type", "application/json; charset=utf-8")
        self.set_header("Content-Length", str(len(body)))
        self.response.body = body
        self.response_sent = True

def set_status_code(self, status_code: int)

Expand source code

def set_status_code(self, status_code: int):
    if not self.status_set:
        self.response.status_code = status_code
        self.status_code = status_code
        self.status_set = True