Module supertokens_python.recipe.session.api.implementation

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, Union

from supertokens_python.normalised_url_path import NormalisedURLPath
from supertokens_python.recipe.session.interfaces import APIInterface, SignOutOkayResponse
from supertokens_python.utils import normalise_http_method

if TYPE_CHECKING:
    from supertokens_python.recipe.session.interfaces import APIOptions, SignOutResponse
    from supertokens_python.recipe.session import Session
from supertokens_python.recipe.session.exceptions import UnauthorisedError


class APIImplementation(APIInterface):
    def __init__(self):
        super().__init__()

    async def refresh_post(self, api_options: APIOptions):
        await api_options.recipe_implementation.refresh_session(api_options.request)

    async def signout_post(self, api_options: APIOptions) -> SignOutResponse:
        try:
            session = await api_options.recipe_implementation.get_session(api_options.request)
        except UnauthorisedError:
            return SignOutOkayResponse()

        if session is None:
            raise Exception('Session is undefined. Should not come here.')
        await session.revoke_session()
        return SignOutOkayResponse()

    async def verify_session(self, api_options: APIOptions, anti_csrf_check: Union[bool, None] = None,
                             session_required: bool = True) -> Union[Session, None]:
        method = normalise_http_method(api_options.request.method())
        if method == 'options' or method == 'trace':
            return None
        incoming_path = NormalisedURLPath(api_options.request.get_path())
        refresh_token_path = api_options.config.refresh_token_path
        if incoming_path.equals(refresh_token_path) and method == 'post':
            return await api_options.recipe_implementation.refresh_session(api_options.request)
        else:
            return await api_options.recipe_implementation.get_session(api_options.request, anti_csrf_check,
                                                                       session_required)

Classes

class APIImplementation

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

Expand source code 
class APIImplementation(APIInterface):
    def __init__(self):
        super().__init__()

    async def refresh_post(self, api_options: APIOptions):
        await api_options.recipe_implementation.refresh_session(api_options.request)

    async def signout_post(self, api_options: APIOptions) -> SignOutResponse:
        try:
            session = await api_options.recipe_implementation.get_session(api_options.request)
        except UnauthorisedError:
            return SignOutOkayResponse()

        if session is None:
            raise Exception('Session is undefined. Should not come here.')
        await session.revoke_session()
        return SignOutOkayResponse()

    async def verify_session(self, api_options: APIOptions, anti_csrf_check: Union[bool, None] = None,
                             session_required: bool = True) -> Union[Session, None]:
        method = normalise_http_method(api_options.request.method())
        if method == 'options' or method == 'trace':
            return None
        incoming_path = NormalisedURLPath(api_options.request.get_path())
        refresh_token_path = api_options.config.refresh_token_path
        if incoming_path.equals(refresh_token_path) and method == 'post':
            return await api_options.recipe_implementation.refresh_session(api_options.request)
        else:
            return await api_options.recipe_implementation.get_session(api_options.request, anti_csrf_check,
                                                                       session_required)

Ancestors

Methods

async def refresh_post(self, api_options: APIOptions)
Expand source code 
async def refresh_post(self, api_options: APIOptions):
    await api_options.recipe_implementation.refresh_session(api_options.request)
async def signout_post(self, api_options: APIOptions) ‑> SignOutResponse
Expand source code 
async def signout_post(self, api_options: APIOptions) -> SignOutResponse:
    try:
        session = await api_options.recipe_implementation.get_session(api_options.request)
    except UnauthorisedError:
        return SignOutOkayResponse()

    if session is None:
        raise Exception('Session is undefined. Should not come here.')
    await session.revoke_session()
    return SignOutOkayResponse()
async def verify_session(self, api_options: APIOptions, anti_csrf_check: Union[bool, None] = None, session_required: bool = True) ‑> Union[Session, None]
Expand source code 
async def verify_session(self, api_options: APIOptions, anti_csrf_check: Union[bool, None] = None,
                         session_required: bool = True) -> Union[Session, None]:
    method = normalise_http_method(api_options.request.method())
    if method == 'options' or method == 'trace':
        return None
    incoming_path = NormalisedURLPath(api_options.request.get_path())
    refresh_token_path = api_options.config.refresh_token_path
    if incoming_path.equals(refresh_token_path) and method == 'post':
        return await api_options.recipe_implementation.refresh_session(api_options.request)
    else:
        return await api_options.recipe_implementation.get_session(api_options.request, anti_csrf_check,
                                                                   session_required)