Module `supertokens_python.recipe.session.syncio`

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

from supertokens_python.async_to_sync_wrapper import sync
from supertokens_python.recipe.session.asyncio import Session


def create_new_session(request, user_id: str, jwt_payload: Union[dict, None] = None,
                       session_data: Union[dict, None] = None):
    from supertokens_python.recipe.session.asyncio import create_new_session
    return sync(create_new_session(
        request, user_id, jwt_payload, session_data))


def get_session(request, anti_csrf_check: Union[bool, None] = None, session_required: bool = True) -> Union[Session,
                                                                                                            None]:
    from supertokens_python.recipe.session.asyncio import get_session
    return sync(get_session(request, anti_csrf_check, session_required))


def refresh_session(request) -> Session:
    from supertokens_python.recipe.session.asyncio import refresh_session
    return sync(refresh_session(request))


def revoke_session(session_handle: str) -> bool:
    from supertokens_python.recipe.session.asyncio import revoke_session
    return sync(revoke_session(session_handle))


def revoke_all_sessions_for_user(user_id: str) -> List[str]:
    from supertokens_python.recipe.session.asyncio import revoke_all_sessions_for_user
    return sync(revoke_all_sessions_for_user(user_id))


def revoke_multiple_sessions(session_handles: List[str]) -> List[str]:
    from supertokens_python.recipe.session.asyncio import revoke_multiple_sessions
    return sync(revoke_multiple_sessions(session_handles))


def get_session_data(session_handle: str) -> dict:
    from supertokens_python.recipe.session.asyncio import get_session_data
    return sync(get_session_data(session_handle))


def get_session_information(session_handle: str) -> dict:
    from supertokens_python.recipe.session.asyncio import get_session_information
    return sync(get_session_information(session_handle))


def update_session_data(session_handle: str, new_session_data: dict) -> None:
    from supertokens_python.recipe.session.asyncio import update_session_data
    return sync(update_session_data(session_handle, new_session_data))


def get_jwt_payload(session_handle: str) -> dict:
    from supertokens_python.recipe.session.asyncio import get_jwt_payload
    return sync(get_jwt_payload(session_handle))


async def update_jwt_payload(session_handle: str, new_jwt_payload: dict) -> None:
    from supertokens_python.recipe.session.asyncio import update_jwt_payload
    return sync(update_jwt_payload(session_handle, new_jwt_payload))

Functions

def create_new_session(request, user_id: str, jwt_payload: Optional[dict] = None, session_data: Optional[dict] = None)

Expand source code

def create_new_session(request, user_id: str, jwt_payload: Union[dict, None] = None,
                       session_data: Union[dict, None] = None):
    from supertokens_python.recipe.session.asyncio import create_new_session
    return sync(create_new_session(
        request, user_id, jwt_payload, session_data))

def get_jwt_payload(session_handle: str) ‑> dict

Expand source code

def get_jwt_payload(session_handle: str) -> dict:
    from supertokens_python.recipe.session.asyncio import get_jwt_payload
    return sync(get_jwt_payload(session_handle))

def get_session(request, anti_csrf_check: Optional[bool] = None, session_required: bool = True) ‑> Optional[Session]

Expand source code

def get_session(request, anti_csrf_check: Union[bool, None] = None, session_required: bool = True) -> Union[Session,
                                                                                                            None]:
    from supertokens_python.recipe.session.asyncio import get_session
    return sync(get_session(request, anti_csrf_check, session_required))

def get_session_data(session_handle: str) ‑> dict

Expand source code

def get_session_data(session_handle: str) -> dict:
    from supertokens_python.recipe.session.asyncio import get_session_data
    return sync(get_session_data(session_handle))

def get_session_information(session_handle: str) ‑> dict

Expand source code

def get_session_information(session_handle: str) -> dict:
    from supertokens_python.recipe.session.asyncio import get_session_information
    return sync(get_session_information(session_handle))

def refresh_session(request) ‑> Session

Expand source code

def refresh_session(request) -> Session:
    from supertokens_python.recipe.session.asyncio import refresh_session
    return sync(refresh_session(request))

def revoke_all_sessions_for_user(user_id: str) ‑> List[str]

Expand source code

def revoke_all_sessions_for_user(user_id: str) -> List[str]:
    from supertokens_python.recipe.session.asyncio import revoke_all_sessions_for_user
    return sync(revoke_all_sessions_for_user(user_id))

def revoke_multiple_sessions(session_handles: List[str]) ‑> List[str]

Expand source code

def revoke_multiple_sessions(session_handles: List[str]) -> List[str]:
    from supertokens_python.recipe.session.asyncio import revoke_multiple_sessions
    return sync(revoke_multiple_sessions(session_handles))

def revoke_session(session_handle: str) ‑> bool

Expand source code

def revoke_session(session_handle: str) -> bool:
    from supertokens_python.recipe.session.asyncio import revoke_session
    return sync(revoke_session(session_handle))

async def update_jwt_payload(session_handle: str, new_jwt_payload: dict) ‑> None

Expand source code

async def update_jwt_payload(session_handle: str, new_jwt_payload: dict) -> None:
    from supertokens_python.recipe.session.asyncio import update_jwt_payload
    return sync(update_jwt_payload(session_handle, new_jwt_payload))

def update_session_data(session_handle: str, new_session_data: dict) ‑> None

Expand source code

def update_session_data(session_handle: str, new_session_data: dict) -> None:
    from supertokens_python.recipe.session.asyncio import update_session_data
    return sync(update_session_data(session_handle, new_session_data))