From 91dcf5728473ee5837e3e9da8cf7750ced039ebe Mon Sep 17 00:00:00 2001 From: rishabhpoddar Date: Mon, 30 Sep 2024 16:36:22 +0530 Subject: [PATCH] adds comments --- supertokens_python/recipe/multifactorauth/utils.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/supertokens_python/recipe/multifactorauth/utils.py b/supertokens_python/recipe/multifactorauth/utils.py index 7b32b92a..12f9ea0f 100644 --- a/supertokens_python/recipe/multifactorauth/utils.py +++ b/supertokens_python/recipe/multifactorauth/utils.py @@ -37,6 +37,8 @@ from .types import OverrideConfig, MultiFactorAuthConfig +# IMPORTANT: If this function signature is modified, please update all tha places where this function is called. +# There will be no type errors cause we use importLib to dynamically import if to prevent cyclic import issues. def validate_and_normalise_user_input( first_factors: Optional[List[str]], override: Union[OverrideConfig, None] = None, @@ -69,6 +71,8 @@ def __init__( ) +# IMPORTANT: If this function signature is modified, please update all tha places where this function is called. +# There will be no type errors cause we use importLib to dynamically import if to prevent cyclic import issues. async def update_and_get_mfa_related_info_in_session( user_context: Dict[str, Any], input_session_recipe_user_id: Optional[RecipeUserId] = None, @@ -259,6 +263,8 @@ async def get_required_secondary_factors_for_tenant_helper() -> List[str]: ) +# IMPORTANT: If this function signature is modified, please update all tha places where this function is called. +# There will be no type errors cause we use importLib to dynamically import if to prevent cyclic import issues. async def is_valid_first_factor( tenant_id: str, factor_id: str, user_context: Dict[str, Any] ) -> Literal["OK", "INVALID_FIRST_FACTOR_ERROR", "TENANT_NOT_FOUND_ERROR"]: