Module `supertokens_python.framework.fastapi.fastapi_response`

Expand source code

# Copyright (c) 2021, VRAI Labs and/or its affiliates. All rights reserved.
#
# This software is licensed under the Apache License, Version 2.0 (the
# "License") as published by the Apache Software Foundation.
#
# You may not use this file except in compliance with the License. You may
# obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import json
from math import ceil
from time import time
from typing import Any, Dict, Union

from supertokens_python.framework.response import BaseResponse


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: Union[str, None] = None,
                   secure: bool = False,
                   httponly: bool = False,
                   samesite: str = "lax"):
        if domain is None:
            # 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, expires=ceil((expires - int(time() * 1000)) / 1000),
                                     path=path, secure=secure, httponly=httponly, samesite=samesite)
        else:
            # 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, expires=ceil((expires - int(time() * 1000)) / 1000),
                                     path=path, domain=domain, 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) -> Union[str, None]:
        return self.response.headers.get(key, None)

    def set_status_code(self, status_code: int):
        if not self.status_set:
            self.response.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

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: Union[str, None] = None,
                   secure: bool = False,
                   httponly: bool = False,
                   samesite: str = "lax"):
        if domain is None:
            # 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, expires=ceil((expires - int(time() * 1000)) / 1000),
                                     path=path, secure=secure, httponly=httponly, samesite=samesite)
        else:
            # 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, expires=ceil((expires - int(time() * 1000)) / 1000),
                                     path=path, domain=domain, 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) -> Union[str, None]:
        return self.response.headers.get(key, None)

    def set_status_code(self, status_code: int):
        if not self.status_set:
            self.response.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) -> Union[str, None]:
    return self.response.headers.get(key, None)

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: Union[str, None] = None,
               secure: bool = False,
               httponly: bool = False,
               samesite: str = "lax"):
    if domain is None:
        # 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, expires=ceil((expires - int(time() * 1000)) / 1000),
                                 path=path, secure=secure, httponly=httponly, samesite=samesite)
    else:
        # 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, expires=ceil((expires - int(time() * 1000)) / 1000),
                                 path=path, domain=domain, 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_set = True