📝 add documentation to create scope function

Kludex · Feb 27, 2021 · a5b55de · a5b55de
1 parent 2b71225
commit a5b55de
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,3 @@
+{
+    "python.pythonPath": ".venv/bin/python"
+}
diff --git a/mangum/adapter.py b/mangum/adapter.py
@@ -106,6 +106,15 @@ def __call__(self, event: dict, context: "LambdaContext") -> dict:
         return response
 
     def _create_scope(self, event: dict, context: "LambdaContext") -> Scope:
+        """Creates a scope object according to ASGI specification from a Lambda Event.
+
+        https://asgi.readthedocs.io/en/latest/specs/www.html#http-connection-scope
+
+        The event comes from various sources: AWS ALB, AWS API Gateway of different
+        versions and configurations(multivalue header, etc).
+        Thus, some heuristics is applied to guess an event type.
+
+        """
         request_context = event["requestContext"]
 
         if event.get("multiValueHeaders"):