changed init function to accept None for api_key

Author: iresharma

supertokens_python/constants.py

@@ -11,7 +11,18 @@
 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 # License for the specific language governing permissions and limitations
 # under the License.
-SUPPORTED_CDI_VERSIONS = ["2.9", "2.10", "2.11", "2.12", "2.13", "2.14", "2.15", "2.16", "2.17", "2.18"]
+SUPPORTED_CDI_VERSIONS = [
+    "2.9",
+    "2.10",
+    "2.11",
+    "2.12",
+    "2.13",
+    "2.14",
+    "2.15",
+    "2.16",
+    "2.17",
+    "2.18",
+]
 VERSION = "0.12.2"
 TELEMETRY = "/telemetry"
 USER_COUNT = "/users/count"

supertokens_python/recipe/dashboard/api/__init__.py

@@ -18,8 +18,7 @@
 from .userdetails.user_delete import handle_user_delete
 from .userdetails.user_email_verify_get import handle_user_email_verify_get
 from .userdetails.user_email_verify_put import handle_user_email_verify_put
-from .userdetails.user_email_verify_token_post import \
-    handle_email_verify_token_post
+from .userdetails.user_email_verify_token_post import handle_email_verify_token_post
 from .userdetails.user_get import handle_user_get
 from .userdetails.user_metadata_get import handle_metadata_get
 from .userdetails.user_metadata_put import handle_metadata_put
@@ -49,5 +48,5 @@
     "handle_user_password_put",
     "handle_email_verify_token_post",
     "handle_sign_in_api",
-    "handle_signout"
+    "handle_signout",
 ]

supertokens_python/recipe/dashboard/api/signin.py

@@ -16,9 +16,8 @@
 from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
-    from supertokens_python.recipe.dashboard.interfaces import (APIInterface,
-                                                                APIOptions)
-
+    from supertokens_python.recipe.dashboard.interfaces import APIInterface, APIOptions
 
+# pylint: disable=unused-argument
 async def handle_sign_in_api(api_implementation: APIInterface, api_options: APIOptions):
-    pass
+    pass

supertokens_python/recipe/dashboard/api/signout.py

@@ -16,11 +16,13 @@
 from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
-    from supertokens_python.recipe.dashboard.interfaces import (APIInterface,
-                                                                APIOptions)
+    from supertokens_python.recipe.dashboard.interfaces import APIInterface, APIOptions
 
 from ..interfaces import SignOutOK
 
 
-async def handle_signout(api_implementation: APIInterface, api_options: APIOptions) -> SignOutOK:
-    pass
+# pylint: disable=unused-argument
+async def handle_signout(
+    api_implementation: APIInterface, api_options: APIOptions
+) -> SignOutOK:
+    return SignOutOK()

supertokens_python/recipe/dashboard/interfaces.py

@@ -14,11 +14,9 @@
 from __future__ import annotations
 
 from abc import ABC, abstractmethod
-from typing import (TYPE_CHECKING, Any, Awaitable, Callable, Dict, List,
-                    Optional, Union)
+from typing import TYPE_CHECKING, Any, Awaitable, Callable, Dict, List, Optional, Union
 
-from supertokens_python.recipe.session.interfaces import \
-    SessionInformationResult
+from supertokens_python.recipe.session.interfaces import SessionInformationResult
 from supertokens_python.types import User
 
 from ...supertokens import AppInfo
@@ -288,6 +286,7 @@ def __init__(self, error: str) -> None:
     def to_json(self) -> Dict[str, Any]:
         return {"status": self.status, "error": self.error}
 
+
 class SignOutOK(APIResponse):
     def to_json(self):
-        return {"status": "OK"}
+        return {"status": "OK"}

supertokens_python/recipe/dashboard/recipe.py

@@ -19,14 +19,26 @@
 from supertokens_python.normalised_url_path import NormalisedURLPath
 from supertokens_python.recipe_module import APIHandled, RecipeModule
 
-from .api import (api_key_protector, handle_dashboard_api,
-                  handle_email_verify_token_post, handle_metadata_get,
-                  handle_metadata_put, handle_sessions_get, handle_sign_in_api,
-                  handle_signout, handle_user_delete,
-                  handle_user_email_verify_get, handle_user_email_verify_put,
-                  handle_user_get, handle_user_password_put, handle_user_put,
-                  handle_user_sessions_post, handle_users_count_get_api,
-                  handle_users_get_api, handle_validate_key_api)
+from .api import (
+    api_key_protector,
+    handle_dashboard_api,
+    handle_email_verify_token_post,
+    handle_metadata_get,
+    handle_metadata_put,
+    handle_sessions_get,
+    handle_sign_in_api,
+    handle_signout,
+    handle_user_delete,
+    handle_user_email_verify_get,
+    handle_user_email_verify_put,
+    handle_user_get,
+    handle_user_password_put,
+    handle_user_put,
+    handle_user_sessions_post,
+    handle_users_count_get_api,
+    handle_users_get_api,
+    handle_validate_key_api,
+)
 from .api.implementation import APIImplementation
 from .exceptions import SuperTokensDashboardError
 from .interfaces import APIInterface, APIOptions
@@ -38,16 +50,28 @@
     from supertokens_python.supertokens import AppInfo
     from supertokens_python.types import APIResponse
 
-from supertokens_python.exceptions import (SuperTokensError,
-                                           raise_general_exception)
-
-from .constants import (DASHBOARD_API, EMAIL_PASSSWORD_SIGNOUT,
-                        EMAIL_PASSWORD_SIGN_IN, USER_API,
-                        USER_EMAIL_VERIFY_API, USER_EMAIL_VERIFY_TOKEN_API,
-                        USER_METADATA_API, USER_PASSWORD_API, USER_SESSION_API,
-                        USERS_COUNT_API, USERS_LIST_GET_API, VALIDATE_KEY_API)
-from .utils import (InputOverrideConfig, get_api_if_matched, is_api_path,
-                    validate_and_normalise_user_input)
+from supertokens_python.exceptions import SuperTokensError, raise_general_exception
+
+from .constants import (
+    DASHBOARD_API,
+    EMAIL_PASSSWORD_SIGNOUT,
+    EMAIL_PASSWORD_SIGN_IN,
+    USER_API,
+    USER_EMAIL_VERIFY_API,
+    USER_EMAIL_VERIFY_TOKEN_API,
+    USER_METADATA_API,
+    USER_PASSWORD_API,
+    USER_SESSION_API,
+    USERS_COUNT_API,
+    USERS_LIST_GET_API,
+    VALIDATE_KEY_API,
+)
+from .utils import (
+    InputOverrideConfig,
+    get_api_if_matched,
+    is_api_path,
+    validate_and_normalise_user_input,
+)
 
 
 class DashboardRecipe(RecipeModule):
@@ -58,7 +82,7 @@ def __init__(
         self,
         recipe_id: str,
         app_info: AppInfo,
-        api_key: str,
+        api_key: Union[str, None],
         override: Union[InputOverrideConfig, None] = None,
     ):
         super().__init__(recipe_id, app_info)
@@ -173,7 +197,7 @@ def get_all_cors_headers(self) -> List[str]:
 
     @staticmethod
     def init(
-        api_key: str,
+        api_key: Union[str, None],
         override: Union[InputOverrideConfig, None] = None,
     ):
         def func(app_info: AppInfo):
@@ -205,8 +229,7 @@ def reset():
         if ("SUPERTOKENS_ENV" not in environ) or (
             environ["SUPERTOKENS_ENV"] != "testing"
         ):
-            raise_general_exception(
-                "calling testing function in non testing env")
+            raise_general_exception("calling testing function in non testing env")
         DashboardRecipe.__instance = None
 
     def return_api_id_if_can_handle_request(

supertokens_python/recipe/dashboard/utils.py

@@ -19,32 +19,48 @@
     from supertokens_python.framework.request import BaseRequest
 
 from supertokens_python.recipe.emailpassword import EmailPasswordRecipe
-from supertokens_python.recipe.emailpassword.asyncio import \
-    get_user_by_id as ep_get_user_by_id
+from supertokens_python.recipe.emailpassword.asyncio import (
+    get_user_by_id as ep_get_user_by_id,
+)
 from supertokens_python.recipe.passwordless import PasswordlessRecipe
-from supertokens_python.recipe.passwordless.asyncio import \
-    get_user_by_id as pless_get_user_by_id
+from supertokens_python.recipe.passwordless.asyncio import (
+    get_user_by_id as pless_get_user_by_id,
+)
 from supertokens_python.recipe.thirdparty import ThirdPartyRecipe
-from supertokens_python.recipe.thirdparty.asyncio import \
-    get_user_by_id as tp_get_user_by_idx
-from supertokens_python.recipe.thirdpartyemailpassword import \
-    ThirdPartyEmailPasswordRecipe
-from supertokens_python.recipe.thirdpartyemailpassword.asyncio import \
-    get_user_by_id as tpep_get_user_by_id
-from supertokens_python.recipe.thirdpartypasswordless import \
-    ThirdPartyPasswordlessRecipe
-from supertokens_python.recipe.thirdpartypasswordless.asyncio import \
-    get_user_by_id as tppless_get_user_by_id
+from supertokens_python.recipe.thirdparty.asyncio import (
+    get_user_by_id as tp_get_user_by_idx,
+)
+from supertokens_python.recipe.thirdpartyemailpassword import (
+    ThirdPartyEmailPasswordRecipe,
+)
+from supertokens_python.recipe.thirdpartyemailpassword.asyncio import (
+    get_user_by_id as tpep_get_user_by_id,
+)
+from supertokens_python.recipe.thirdpartypasswordless import (
+    ThirdPartyPasswordlessRecipe,
+)
+from supertokens_python.recipe.thirdpartypasswordless.asyncio import (
+    get_user_by_id as tppless_get_user_by_id,
+)
 from supertokens_python.types import User
 from supertokens_python.utils import Awaitable
 
 from ...normalised_url_path import NormalisedURLPath
 from ...supertokens import AppInfo
-from .constants import (DASHBOARD_API, EMAIL_PASSSWORD_SIGNOUT,
-                        EMAIL_PASSWORD_SIGN_IN, USER_API,
-                        USER_EMAIL_VERIFY_API, USER_EMAIL_VERIFY_TOKEN_API,
-                        USER_METADATA_API, USER_PASSWORD_API, USER_SESSION_API,
-                        USERS_COUNT_API, USERS_LIST_GET_API, VALIDATE_KEY_API)
+from .constants import (
+    DASHBOARD_API,
+    EMAIL_PASSSWORD_SIGNOUT,
+    EMAIL_PASSWORD_SIGN_IN,
+    USER_API,
+    USER_EMAIL_VERIFY_API,
+    USER_EMAIL_VERIFY_TOKEN_API,
+    USER_METADATA_API,
+    USER_PASSWORD_API,
+    USER_SESSION_API,
+    USERS_COUNT_API,
+    USERS_LIST_GET_API,
+    VALIDATE_KEY_API,
+)
 
 if TYPE_CHECKING:
     from .interfaces import APIInterface, RecipeInterface
@@ -132,8 +148,7 @@ def to_json(self) -> Dict[str, Any]:
 class InputOverrideConfig:
     def __init__(
         self,
-        functions: Union[Callable[[RecipeInterface],
-                                  RecipeInterface], None] = None,
+        functions: Union[Callable[[RecipeInterface], RecipeInterface], None] = None,
         apis: Union[Callable[[APIInterface], APIInterface], None] = None,
     ):
         self.functions = functions
@@ -143,8 +158,7 @@ def __init__(
 class OverrideConfig:
     def __init__(
         self,
-        functions: Union[Callable[[RecipeInterface],
-                                  RecipeInterface], None] = None,
+        functions: Union[Callable[[RecipeInterface], RecipeInterface], None] = None,
         apis: Union[Callable[[APIInterface], APIInterface], None] = None,
     ):
         self.functions = functions
@@ -153,10 +167,7 @@ def __init__(
 
 class DashboardConfig:
     def __init__(
-        self,
-        api_key: str,
-        override: OverrideConfig,
-        auth_mode: str
+        self, api_key: Union[str, None], override: OverrideConfig, auth_mode: str
     ):
         self.api_key = api_key
         self.override = override
@@ -165,7 +176,7 @@ def __init__(
 
 def validate_and_normalise_user_input(
     # app_info: AppInfo,
-    api_key: str,
+    api_key: Union[str, None],
     override: Optional[InputOverrideConfig] = None,
 ) -> DashboardConfig:
 
@@ -178,7 +189,7 @@ def validate_and_normalise_user_input(
             functions=override.functions,
             apis=override.apis,
         ),
-        "api-key" if api_key else "email-password"
+        "api-key" if api_key else "email-password",
     )
 
 
@@ -190,8 +201,7 @@ def is_api_path(path: NormalisedURLPath, app_info: AppInfo) -> bool:
     if not path.startswith(dashboard_recipe_base_path):
         return False
 
-    path_without_dashboard_path = path.get_as_string_dangerous().split(DASHBOARD_API)[
-        1]
+    path_without_dashboard_path = path.get_as_string_dangerous().split(DASHBOARD_API)[1]
 
     if len(path_without_dashboard_path) > 0 and path_without_dashboard_path[0] == "/":
         path_without_dashboard_path = path_without_dashboard_path[1:]
@@ -242,16 +252,15 @@ def __init__(self, user: UserWithMetadata, recipe: str):
 
 
 if TYPE_CHECKING:
-    from supertokens_python.recipe.emailpassword.types import \
-        User as EmailPasswordUser
-    from supertokens_python.recipe.passwordless.types import \
-        User as PasswordlessUser
-    from supertokens_python.recipe.thirdparty.types import \
-        User as ThirdPartyUser
-    from supertokens_python.recipe.thirdpartyemailpassword.types import \
-        User as ThirdPartyEmailPasswordUser
-    from supertokens_python.recipe.thirdpartypasswordless.types import \
-        User as ThirdPartyPasswordlessUser
+    from supertokens_python.recipe.emailpassword.types import User as EmailPasswordUser
+    from supertokens_python.recipe.passwordless.types import User as PasswordlessUser
+    from supertokens_python.recipe.thirdparty.types import User as ThirdPartyUser
+    from supertokens_python.recipe.thirdpartyemailpassword.types import (
+        User as ThirdPartyEmailPasswordUser,
+    )
+    from supertokens_python.recipe.thirdpartypasswordless.types import (
+        User as ThirdPartyPasswordlessUser,
+    )
 
     GetUserResult = Union[
         EmailPasswordUser,