Module `supertokens_python.framework.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 abc import ABC, abstractmethod
from typing import TYPE_CHECKING, Any, Dict, Union

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


class BaseRequest(ABC):
    def __init__(self):
        self.wrapper_used = True
        self.request = None

    @abstractmethod
    def get_original_url(self) -> str:
        pass

    @abstractmethod
    def get_query_param(
        self, key: str, default: Union[str, None] = None
    ) -> Union[str, None]:
        pass

    @abstractmethod
    def get_query_params(self) -> Dict[str, Any]:
        pass

    @abstractmethod
    async def json(self) -> Union[Any, None]:
        pass

    @abstractmethod
    async def form_data(self) -> Dict[str, Any]:
        pass

    @abstractmethod
    def method(self) -> str:
        pass

    @abstractmethod
    def get_cookie(self, key: str) -> Union[str, None]:
        pass

    @abstractmethod
    def get_header(self, key: str) -> Union[None, str]:
        pass

    @abstractmethod
    def get_session(self) -> Union[SessionContainer, None]:
        pass

    @abstractmethod
    def set_session(self, session: SessionContainer):
        pass

    @abstractmethod
    def set_session_as_none(self):
        """
        This function is used to set the request's session variable to None.
        See https://github.com/supertokens/supertokens-python/issues/90
        """

    @abstractmethod
    def get_path(self) -> str:
        pass

Classes

class BaseRequest

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

Expand source code

class BaseRequest(ABC):
    def __init__(self):
        self.wrapper_used = True
        self.request = None

    @abstractmethod
    def get_original_url(self) -> str:
        pass

    @abstractmethod
    def get_query_param(
        self, key: str, default: Union[str, None] = None
    ) -> Union[str, None]:
        pass

    @abstractmethod
    def get_query_params(self) -> Dict[str, Any]:
        pass

    @abstractmethod
    async def json(self) -> Union[Any, None]:
        pass

    @abstractmethod
    async def form_data(self) -> Dict[str, Any]:
        pass

    @abstractmethod
    def method(self) -> str:
        pass

    @abstractmethod
    def get_cookie(self, key: str) -> Union[str, None]:
        pass

    @abstractmethod
    def get_header(self, key: str) -> Union[None, str]:
        pass

    @abstractmethod
    def get_session(self) -> Union[SessionContainer, None]:
        pass

    @abstractmethod
    def set_session(self, session: SessionContainer):
        pass

    @abstractmethod
    def set_session_as_none(self):
        """
        This function is used to set the request's session variable to None.
        See https://github.com/supertokens/supertokens-python/issues/90
        """

    @abstractmethod
    def get_path(self) -> str:
        pass

Ancestors

abc.ABC

Subclasses

Methods

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

Expand source code

@abstractmethod
async def form_data(self) -> Dict[str, Any]:
    pass

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

Expand source code

@abstractmethod
def get_cookie(self, key: str) -> Union[str, None]:
    pass

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

Expand source code

@abstractmethod
def get_header(self, key: str) -> Union[None, str]:
    pass

def get_original_url(self) ‑> str

Expand source code

@abstractmethod
def get_original_url(self) -> str:
    pass

def get_path(self) ‑> str

Expand source code

@abstractmethod
def get_path(self) -> str:
    pass

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

Expand source code

@abstractmethod
def get_query_param(
    self, key: str, default: Union[str, None] = None
) -> Union[str, None]:
    pass

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

Expand source code

@abstractmethod
def get_query_params(self) -> Dict[str, Any]:
    pass

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

Expand source code

@abstractmethod
def get_session(self) -> Union[SessionContainer, None]:
    pass

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

Expand source code

@abstractmethod
async def json(self) -> Union[Any, None]:
    pass

def method(self) ‑> str

Expand source code

@abstractmethod
def method(self) -> str:
    pass

def set_session(self, session: SessionContainer)

Expand source code

@abstractmethod
def set_session(self, session: SessionContainer):
    pass

def set_session_as_none(self)

This function is used to set the request's session variable to None. See https://github.com/supertokens/supertokens-python/issues/90

Expand source code

@abstractmethod
def set_session_as_none(self):
    """
    This function is used to set the request's session variable to None.
    See https://github.com/supertokens/supertokens-python/issues/90
    """