Module `supertokens_python.recipe.thirdparty.provider`

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

import abc
from typing import TYPE_CHECKING, Any, Dict, Union

if TYPE_CHECKING:
    from .types import AccessTokenAPI, AuthorisationRedirectAPI, UserInfo


class Provider(abc.ABC):
    def __init__(self, provider_id: str, is_default: bool):
        self.id: str = provider_id
        self.is_default: bool = is_default

    @abc.abstractmethod
    async def get_profile_info(
        self, auth_code_response: Dict[str, Any], user_context: Dict[str, Any]
    ) -> UserInfo:
        pass

    @abc.abstractmethod
    def get_authorisation_redirect_api_info(
        self, user_context: Dict[str, Any]
    ) -> AuthorisationRedirectAPI:
        pass

    @abc.abstractmethod
    def get_access_token_api_info(
        self,
        redirect_uri: str,
        auth_code_from_request: str,
        user_context: Dict[str, Any],
    ) -> AccessTokenAPI:
        pass

    @abc.abstractmethod
    def get_redirect_uri(self, user_context: Dict[str, Any]) -> Union[None, str]:
        pass

    @abc.abstractmethod
    def get_client_id(self, user_context: Dict[str, Any]) -> str:
        pass

Classes

class Provider (provider_id: str, is_default: bool)

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

Expand source code

class Provider(abc.ABC):
    def __init__(self, provider_id: str, is_default: bool):
        self.id: str = provider_id
        self.is_default: bool = is_default

    @abc.abstractmethod
    async def get_profile_info(
        self, auth_code_response: Dict[str, Any], user_context: Dict[str, Any]
    ) -> UserInfo:
        pass

    @abc.abstractmethod
    def get_authorisation_redirect_api_info(
        self, user_context: Dict[str, Any]
    ) -> AuthorisationRedirectAPI:
        pass

    @abc.abstractmethod
    def get_access_token_api_info(
        self,
        redirect_uri: str,
        auth_code_from_request: str,
        user_context: Dict[str, Any],
    ) -> AccessTokenAPI:
        pass

    @abc.abstractmethod
    def get_redirect_uri(self, user_context: Dict[str, Any]) -> Union[None, str]:
        pass

    @abc.abstractmethod
    def get_client_id(self, user_context: Dict[str, Any]) -> str:
        pass

Ancestors

abc.ABC

Subclasses

Methods

def get_access_token_api_info(self, redirect_uri: str, auth_code_from_request: str, user_context: Dict[str, Any]) ‑> AccessTokenAPI

Expand source code

@abc.abstractmethod
def get_access_token_api_info(
    self,
    redirect_uri: str,
    auth_code_from_request: str,
    user_context: Dict[str, Any],
) -> AccessTokenAPI:
    pass

def get_authorisation_redirect_api_info(self, user_context: Dict[str, Any]) ‑> AuthorisationRedirectAPI

Expand source code

@abc.abstractmethod
def get_authorisation_redirect_api_info(
    self, user_context: Dict[str, Any]
) -> AuthorisationRedirectAPI:
    pass

def get_client_id(self, user_context: Dict[str, Any]) ‑> str

Expand source code

@abc.abstractmethod
def get_client_id(self, user_context: Dict[str, Any]) -> str:
    pass

async def get_profile_info(self, auth_code_response: Dict[str, Any], user_context: Dict[str, Any]) ‑> UserInfo

Expand source code

@abc.abstractmethod
async def get_profile_info(
    self, auth_code_response: Dict[str, Any], user_context: Dict[str, Any]
) -> UserInfo:
    pass

def get_redirect_uri(self, user_context: Dict[str, Any]) ‑> Optional[None]

Expand source code

@abc.abstractmethod
def get_redirect_uri(self, user_context: Dict[str, Any]) -> Union[None, str]:
    pass