Module supertokens_python.recipe.usermetadata.utils

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

from supertokens_python.recipe.usermetadata.interfaces import (
    APIInterface,
    RecipeInterface,
)
from supertokens_python.types.config import (
    BaseConfig,
    BaseNormalisedConfig,
    BaseNormalisedOverrideConfig,
    BaseOverrideableConfig,
    BaseOverrideConfig,
)

if TYPE_CHECKING:
    from supertokens_python.recipe.usermetadata.recipe import UserMetadataRecipe
    from supertokens_python.supertokens import AppInfo


UserMetadataOverrideConfig = BaseOverrideConfig[RecipeInterface, APIInterface]
NormalisedUserMetadataOverrideConfig = BaseNormalisedOverrideConfig[
    RecipeInterface, APIInterface
]
InputOverrideConfig = UserMetadataOverrideConfig
"""Deprecated: Use `UserMetadataOverrideConfig` instead."""


class UserMetadataOverrideableConfig(BaseOverrideableConfig):
    """Input config properties overrideable using the plugin config overrides"""

    ...


class UserMetadataConfig(
    UserMetadataOverrideableConfig,
    BaseConfig[RecipeInterface, APIInterface, UserMetadataOverrideableConfig],
):
    def to_overrideable_config(self) -> UserMetadataOverrideableConfig:
        """Create a `UserMetadataOverrideableConfig` from the current config."""
        return UserMetadataOverrideableConfig(**self.model_dump())

    def from_overrideable_config(
        self,
        overrideable_config: UserMetadataOverrideableConfig,
    ) -> "UserMetadataConfig":
        """
        Create a `UserMetadataConfig` from a `UserMetadataOverrideableConfig`.
        Not a classmethod since it needs to be used in a dynamic context within plugins.
        """
        return UserMetadataConfig(
            **overrideable_config.model_dump(),
            override=self.override,
        )


class NormalisedUserMetadataConfig(
    BaseNormalisedConfig[RecipeInterface, APIInterface]
): ...


def validate_and_normalise_user_input(
    _recipe: UserMetadataRecipe,
    _app_info: AppInfo,
    input_config: UserMetadataConfig,
) -> NormalisedUserMetadataConfig:
    override_config = NormalisedUserMetadataOverrideConfig.from_input_config(
        override_config=input_config.override
    )

    return NormalisedUserMetadataConfig(override=override_config)

Functions

def validate_and_normalise_user_input(_recipe: UserMetadataRecipe, _app_info: AppInfo, input_config: UserMetadataConfig)

Classes

class InputOverrideConfig (**data: Any)

Base class for input override config with API overrides.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors

Inherited members

class NormalisedUserMetadataConfig (**data: Any)

Base class for normalized config of a Recipe with API overrides.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code 
class NormalisedUserMetadataConfig(
    BaseNormalisedConfig[RecipeInterface, APIInterface]
): ...

Ancestors

Inherited members

class UserMetadataConfig (**data: Any)

Input config properties overrideable using the plugin config overrides

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code 
class UserMetadataConfig(
    UserMetadataOverrideableConfig,
    BaseConfig[RecipeInterface, APIInterface, UserMetadataOverrideableConfig],
):
    def to_overrideable_config(self) -> UserMetadataOverrideableConfig:
        """Create a `UserMetadataOverrideableConfig` from the current config."""
        return UserMetadataOverrideableConfig(**self.model_dump())

    def from_overrideable_config(
        self,
        overrideable_config: UserMetadataOverrideableConfig,
    ) -> "UserMetadataConfig":
        """
        Create a `UserMetadataConfig` from a `UserMetadataOverrideableConfig`.
        Not a classmethod since it needs to be used in a dynamic context within plugins.
        """
        return UserMetadataConfig(
            **overrideable_config.model_dump(),
            override=self.override,
        )

Ancestors

Methods

def from_overrideable_config(self, overrideable_config: UserMetadataOverrideableConfig) ‑> UserMetadataConfig

Create a UserMetadataConfig from a UserMetadataOverrideableConfig. Not a classmethod since it needs to be used in a dynamic context within plugins.

def to_overrideable_config(self) ‑> UserMetadataOverrideableConfig

Create a UserMetadataOverrideableConfig from the current config.

Inherited members

class UserMetadataOverrideableConfig (**data: Any)

Input config properties overrideable using the plugin config overrides

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code 
class UserMetadataOverrideableConfig(BaseOverrideableConfig):
    """Input config properties overrideable using the plugin config overrides"""

    ...

Ancestors

Subclasses

Inherited members