Module `supertokens_python.recipe.userroles.recipe`

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 os import environ
from typing import List, Union

from supertokens_python.exceptions import (SuperTokensError,
                                           raise_general_exception)
from supertokens_python.framework import BaseRequest, BaseResponse
from supertokens_python.normalised_url_path import NormalisedURLPath
from supertokens_python.querier import Querier
from supertokens_python.recipe.userroles.recipe_implementation import \
    RecipeImplementation
from supertokens_python.recipe.userroles.utils import \
    validate_and_normalise_user_input
from supertokens_python.recipe_module import APIHandled, RecipeModule
from supertokens_python.supertokens import AppInfo

from .exceptions import SuperTokensUserRolesError
from .utils import InputOverrideConfig


class UserRolesRecipe(RecipeModule):
    recipe_id = 'userroles'
    __instance = None

    def __init__(self, recipe_id: str, app_info: AppInfo, override: Union[InputOverrideConfig, None] = None):
        super().__init__(recipe_id, app_info)
        self.config = validate_and_normalise_user_input(self, app_info, override)
        recipe_implementation = RecipeImplementation(Querier.get_instance(recipe_id))
        self.recipe_implementation = recipe_implementation if self.config.override.functions is None else \
            self.config.override.functions(recipe_implementation)

    def is_error_from_this_recipe_based_on_instance(
            self, err: Exception) -> bool:
        return isinstance(err, SuperTokensError) and (isinstance(err, SuperTokensUserRolesError))

    def get_apis_handled(self) -> List[APIHandled]:
        return []

    async def handle_api_request(self, request_id: str, request: BaseRequest, path: NormalisedURLPath, method: str,
                                 response: BaseResponse) -> Union[BaseResponse, None]:
        raise Exception("Should never come here")

    async def handle_error(self, request: BaseRequest, err: SuperTokensError, response: BaseResponse) -> BaseResponse:
        raise err

    def get_all_cors_headers(self) -> List[str]:
        return []

    @staticmethod
    def init(override: Union[InputOverrideConfig, None] = None):
        def func(app_info: AppInfo):
            if UserRolesRecipe.__instance is None:
                UserRolesRecipe.__instance = UserRolesRecipe(UserRolesRecipe.recipe_id, app_info, override)
                return UserRolesRecipe.__instance
            raise Exception(None, 'UserRoles recipe has already been initialised. Please check your code for bugs.')

        return func

    @staticmethod
    def reset():
        if ('SUPERTOKENS_ENV' not in environ) or (
                environ['SUPERTOKENS_ENV'] != 'testing'):
            raise_general_exception(
                'calling testing function in non testing env')
        UserRolesRecipe.__instance = None

    @staticmethod
    def get_instance() -> UserRolesRecipe:
        if UserRolesRecipe.__instance is not None:
            return UserRolesRecipe.__instance
        raise_general_exception(
            'Initialisation not done. Did you forget to call the SuperTokens.init or UserRoles.init function?')

Classes

class UserRolesRecipe (recipe_id: str, app_info: AppInfo, override: Union[InputOverrideConfig, None] = None)

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

Expand source code

class UserRolesRecipe(RecipeModule):
    recipe_id = 'userroles'
    __instance = None

    def __init__(self, recipe_id: str, app_info: AppInfo, override: Union[InputOverrideConfig, None] = None):
        super().__init__(recipe_id, app_info)
        self.config = validate_and_normalise_user_input(self, app_info, override)
        recipe_implementation = RecipeImplementation(Querier.get_instance(recipe_id))
        self.recipe_implementation = recipe_implementation if self.config.override.functions is None else \
            self.config.override.functions(recipe_implementation)

    def is_error_from_this_recipe_based_on_instance(
            self, err: Exception) -> bool:
        return isinstance(err, SuperTokensError) and (isinstance(err, SuperTokensUserRolesError))

    def get_apis_handled(self) -> List[APIHandled]:
        return []

    async def handle_api_request(self, request_id: str, request: BaseRequest, path: NormalisedURLPath, method: str,
                                 response: BaseResponse) -> Union[BaseResponse, None]:
        raise Exception("Should never come here")

    async def handle_error(self, request: BaseRequest, err: SuperTokensError, response: BaseResponse) -> BaseResponse:
        raise err

    def get_all_cors_headers(self) -> List[str]:
        return []

    @staticmethod
    def init(override: Union[InputOverrideConfig, None] = None):
        def func(app_info: AppInfo):
            if UserRolesRecipe.__instance is None:
                UserRolesRecipe.__instance = UserRolesRecipe(UserRolesRecipe.recipe_id, app_info, override)
                return UserRolesRecipe.__instance
            raise Exception(None, 'UserRoles recipe has already been initialised. Please check your code for bugs.')

        return func

    @staticmethod
    def reset():
        if ('SUPERTOKENS_ENV' not in environ) or (
                environ['SUPERTOKENS_ENV'] != 'testing'):
            raise_general_exception(
                'calling testing function in non testing env')
        UserRolesRecipe.__instance = None

    @staticmethod
    def get_instance() -> UserRolesRecipe:
        if UserRolesRecipe.__instance is not None:
            return UserRolesRecipe.__instance
        raise_general_exception(
            'Initialisation not done. Did you forget to call the SuperTokens.init or UserRoles.init function?')

Ancestors

RecipeModule
abc.ABC

Class variables

var recipe_id

Static methods

def get_instance() ‑> UserRolesRecipe

Expand source code

@staticmethod
def get_instance() -> UserRolesRecipe:
    if UserRolesRecipe.__instance is not None:
        return UserRolesRecipe.__instance
    raise_general_exception(
        'Initialisation not done. Did you forget to call the SuperTokens.init or UserRoles.init function?')

def init(override: Union[InputOverrideConfig, None] = None)

Expand source code

@staticmethod
def init(override: Union[InputOverrideConfig, None] = None):
    def func(app_info: AppInfo):
        if UserRolesRecipe.__instance is None:
            UserRolesRecipe.__instance = UserRolesRecipe(UserRolesRecipe.recipe_id, app_info, override)
            return UserRolesRecipe.__instance
        raise Exception(None, 'UserRoles recipe has already been initialised. Please check your code for bugs.')

    return func

def reset()

Expand source code

@staticmethod
def reset():
    if ('SUPERTOKENS_ENV' not in environ) or (
            environ['SUPERTOKENS_ENV'] != 'testing'):
        raise_general_exception(
            'calling testing function in non testing env')
    UserRolesRecipe.__instance = None

Methods

def get_all_cors_headers(self) ‑> List[str]

Expand source code

def get_all_cors_headers(self) -> List[str]:
    return []

def get_apis_handled(self) ‑> List[APIHandled]

Expand source code

def get_apis_handled(self) -> List[APIHandled]:
    return []

async def handle_api_request(self, request_id: str, request: BaseRequest, path: NormalisedURLPath, method: str, response: BaseResponse) ‑> Optional[BaseResponse]

Expand source code

async def handle_api_request(self, request_id: str, request: BaseRequest, path: NormalisedURLPath, method: str,
                             response: BaseResponse) -> Union[BaseResponse, None]:
    raise Exception("Should never come here")

async def handle_error(self, request: BaseRequest, err: SuperTokensError, response: BaseResponse) ‑> BaseResponse

Expand source code

async def handle_error(self, request: BaseRequest, err: SuperTokensError, response: BaseResponse) -> BaseResponse:
    raise err

def is_error_from_this_recipe_based_on_instance(self, err: Exception) ‑> bool

Expand source code

def is_error_from_this_recipe_based_on_instance(
        self, err: Exception) -> bool:
    return isinstance(err, SuperTokensError) and (isinstance(err, SuperTokensUserRolesError))