Add helper function to get the original request from user context provided to APIs and functions

Author: nkshah2

supertokens_python/asyncio/__init__.py

@@ -11,18 +11,19 @@
 # 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 List, Union, Optional, Dict
+from typing import Any, Dict, List, Optional, Union
 
 from supertokens_python import Supertokens
+from supertokens_python.framework.request import BaseRequest
 from supertokens_python.interfaces import (
     CreateUserIdMappingOkResult,
+    DeleteUserIdMappingOkResult,
+    GetUserIdMappingOkResult,
+    UnknownMappingError,
     UnknownSupertokensUserIDError,
+    UpdateOrDeleteUserIdMappingInfoOkResult,
     UserIdMappingAlreadyExistsError,
     UserIDTypes,
-    UnknownMappingError,
-    GetUserIdMappingOkResult,
-    DeleteUserIdMappingOkResult,
-    UpdateOrDeleteUserIdMappingInfoOkResult,
 )
 from supertokens_python.types import UsersResponse
 
@@ -97,3 +98,9 @@ async def update_or_delete_user_id_mapping_info(
     return await Supertokens.get_instance().update_or_delete_user_id_mapping_info(
         user_id, user_id_type, external_user_id_info
     )
+
+
+def get_request_from_user_context(
+    user_context: Optional[Dict[str, Any]],
+) -> Optional[BaseRequest]:
+    return Supertokens.get_instance().get_request_from_user_context(user_context)

supertokens_python/supertokens.py

@@ -552,3 +552,18 @@ async def handle_supertokens_error(
                 )
                 return await recipe.handle_error(request, err, response)
         raise err
+
+    def get_request_from_user_context(  # pylint: disable=no-self-use
+        self,
+        user_context: Optional[Dict[str, Any]] = None,
+    ) -> Optional[BaseRequest]:
+        if user_context is None:
+            return None
+
+        if "_default" not in user_context:
+            return None
+
+        if not isinstance(user_context["_default"], dict):
+            return None
+
+        return user_context.get("_default", {}).get("request")

supertokens_python/syncio/__init__.py

@@ -11,19 +11,20 @@
 # 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 List, Union, Optional, Dict
+from typing import Any, Dict, List, Optional, Union
 
 from supertokens_python import Supertokens
 from supertokens_python.async_to_sync_wrapper import sync
+from supertokens_python.framework.request import BaseRequest
 from supertokens_python.interfaces import (
     CreateUserIdMappingOkResult,
+    DeleteUserIdMappingOkResult,
+    GetUserIdMappingOkResult,
+    UnknownMappingError,
     UnknownSupertokensUserIDError,
+    UpdateOrDeleteUserIdMappingInfoOkResult,
     UserIdMappingAlreadyExistsError,
     UserIDTypes,
-    UnknownMappingError,
-    GetUserIdMappingOkResult,
-    DeleteUserIdMappingOkResult,
-    UpdateOrDeleteUserIdMappingInfoOkResult,
 )
 from supertokens_python.types import UsersResponse
 
@@ -103,3 +104,9 @@ def update_or_delete_user_id_mapping_info(
             user_id, user_id_type, external_user_id_info
         )
     )
+
+
+def get_request_from_user_context(
+    user_context: Optional[Dict[str, Any]],
+) -> Optional[BaseRequest]:
+    return Supertokens.get_instance().get_request_from_user_context(user_context)