Module `supertokens_python.framework.fastapi.fastapi_request`

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.
from __future__ import annotations

from typing import TYPE_CHECKING, Any, Dict, Union
from urllib.parse import parse_qsl

from supertokens_python.framework.request import BaseRequest

if TYPE_CHECKING:
    from supertokens_python.recipe.session.interfaces import SessionContainer
    from fastapi import Request


class FastApiRequest(BaseRequest):
    def __init__(self, request: Request):
        super().__init__()
        self.request = request

    def get_original_url(self) -> str:
        return self.request.url.components.geturl()

    def get_query_param(
        self, key: str, default: Union[str, None] = None
    ) -> Union[str, None]:
        return self.request.query_params.get(key, default)

    def get_query_params(self) -> Dict[str, Any]:
        return dict(self.request.query_params.items())  # type: ignore

    async def json(self) -> Union[Any, None]:
        try:
            return await self.request.json()
        except Exception:
            return {}

    def method(self) -> str:
        return self.request.method

    def get_cookie(self, key: str) -> Union[str, None]:
        # Note: Unlike other frameworks, FastAPI wraps the value in quotes in Set-Cookie header
        # It also takes care of escaping the quotes while fetching the value
        return self.request.cookies.get(key)

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

    def get_session(self) -> Union[SessionContainer, None]:
        return self.request.state.supertokens

    def set_session(self, session: SessionContainer):
        self.request.state.supertokens = session

    def set_session_as_none(self):
        self.request.state.supertokens = None

    def get_path(self) -> str:
        root_path = self.request.scope.get("root_path")
        url = self.request.url.path
        # FastAPI seems buggy and it adds an extra root_path (if it matches):
        # So we trim the extra root_path (from the left) from the url
        return url[url.startswith(root_path) and len(root_path) :]

    async def form_data(self):
        return dict(parse_qsl((await self.request.body()).decode("utf-8")))

Classes

class FastApiRequest (request: Request)

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

Expand source code

class FastApiRequest(BaseRequest):
    def __init__(self, request: Request):
        super().__init__()
        self.request = request

    def get_original_url(self) -> str:
        return self.request.url.components.geturl()

    def get_query_param(
        self, key: str, default: Union[str, None] = None
    ) -> Union[str, None]:
        return self.request.query_params.get(key, default)

    def get_query_params(self) -> Dict[str, Any]:
        return dict(self.request.query_params.items())  # type: ignore

    async def json(self) -> Union[Any, None]:
        try:
            return await self.request.json()
        except Exception:
            return {}

    def method(self) -> str:
        return self.request.method

    def get_cookie(self, key: str) -> Union[str, None]:
        # Note: Unlike other frameworks, FastAPI wraps the value in quotes in Set-Cookie header
        # It also takes care of escaping the quotes while fetching the value
        return self.request.cookies.get(key)

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

    def get_session(self) -> Union[SessionContainer, None]:
        return self.request.state.supertokens

    def set_session(self, session: SessionContainer):
        self.request.state.supertokens = session

    def set_session_as_none(self):
        self.request.state.supertokens = None

    def get_path(self) -> str:
        root_path = self.request.scope.get("root_path")
        url = self.request.url.path
        # FastAPI seems buggy and it adds an extra root_path (if it matches):
        # So we trim the extra root_path (from the left) from the url
        return url[url.startswith(root_path) and len(root_path) :]

    async def form_data(self):
        return dict(parse_qsl((await self.request.body()).decode("utf-8")))

Ancestors

BaseRequest
abc.ABC

Methods

async def form_data(self)

Expand source code

async def form_data(self):
    return dict(parse_qsl((await self.request.body()).decode("utf-8")))

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

Expand source code

def get_cookie(self, key: str) -> Union[str, None]:
    # Note: Unlike other frameworks, FastAPI wraps the value in quotes in Set-Cookie header
    # It also takes care of escaping the quotes while fetching the value
    return self.request.cookies.get(key)

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

Expand source code

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

def get_original_url(self) ‑> str

Expand source code

def get_original_url(self) -> str:
    return self.request.url.components.geturl()

def get_path(self) ‑> str

Expand source code

def get_path(self) -> str:
    root_path = self.request.scope.get("root_path")
    url = self.request.url.path
    # FastAPI seems buggy and it adds an extra root_path (if it matches):
    # So we trim the extra root_path (from the left) from the url
    return url[url.startswith(root_path) and len(root_path) :]

def get_query_param(self, key: str, default: Union[str, None] = None) ‑> Optional[str]

Expand source code

def get_query_param(
    self, key: str, default: Union[str, None] = None
) -> Union[str, None]:
    return self.request.query_params.get(key, default)

def get_query_params(self) ‑> Dict[str, Any]

Expand source code

def get_query_params(self) -> Dict[str, Any]:
    return dict(self.request.query_params.items())  # type: ignore

def get_session(self) ‑> Union[SessionContainer, None]

Expand source code

def get_session(self) -> Union[SessionContainer, None]:
    return self.request.state.supertokens

async def json(self) ‑> Optional[Any]

Expand source code

async def json(self) -> Union[Any, None]:
    try:
        return await self.request.json()
    except Exception:
        return {}

def method(self) ‑> str

Expand source code

def method(self) -> str:
    return self.request.method

def set_session(self, session: SessionContainer)

Expand source code

def set_session(self, session: SessionContainer):
    self.request.state.supertokens = session

Inherited members

BaseRequest:
- set_session_as_none