refactor: fix import issues and provide context in docblocks

Author: Joris Conijn

aws_lambda_powertools/utilities/typing/__init__.py

@@ -6,16 +6,10 @@
 > This is copied from: https://gist.github.com/alexcasalboni/a545b68ee164b165a74a20a5fee9d133
 """
 
-from .lambda_client_context import LambdaClientContext
-from .lambda_client_context_mobile_client import LambdaClientContextMobileClient
-from .lambda_cognito_identity import LambdaCognitoIdentity
+from .event import LambdaEvent
 from .lambda_context import LambdaContext
-from .lambda_dict import LambdaDict
 
 __all__ = [
-    "LambdaDict",
-    "LambdaClientContext",
-    "LambdaClientContextMobileClient",
-    "LambdaCognitoIdentity",
+    "LambdaEvent",
     "LambdaContext",
 ]

aws_lambda_powertools/utilities/typing/lambda_dict.py renamed to aws_lambda_powertools/utilities/typing/event.py

@@ -2,4 +2,4 @@
 
 from typing import Any, Dict
 
-LambdaDict = Dict[str, Any]
+LambdaEvent = Dict[str, Any]

aws_lambda_powertools/utilities/typing/lambda_client_context.py

@@ -1,8 +1,24 @@
 # -*- coding: utf-8 -*-
-from aws_lambda_powertools.utilities.typing import LambdaClientContextMobileClient, LambdaDict
+from aws_lambda_powertools.utilities.typing import LambdaEvent
+from aws_lambda_powertools.utilities.typing.lambda_client_context_mobile_client import LambdaClientContextMobileClient
 
 
 class LambdaClientContext(object):
-    client: LambdaClientContextMobileClient
-    custom: LambdaDict
-    env: LambdaDict
+    _client: LambdaClientContextMobileClient
+    _custom: LambdaEvent
+    _env: LambdaEvent
+
+    @property
+    def client(self) -> LambdaClientContextMobileClient:
+        """Client context that's provided to Lambda by the client application."""
+        return self._client
+
+    @property
+    def custom(self) -> LambdaEvent:
+        """A dict of custom values set by the mobile client application."""
+        return self._custom
+
+    @property
+    def env(self) -> LambdaEvent:
+        """A dict of environment information provided by the AWS SDK."""
+        return self._env

aws_lambda_powertools/utilities/typing/lambda_client_context_mobile_client.py

@@ -2,8 +2,30 @@
 
 
 class LambdaClientContextMobileClient(object):
-    installation_id: str
-    app_title: str
-    app_version_name: str
-    app_version_code: str
-    app_package_name: str
+    """Mobile Client context that's provided to Lambda by the client application."""
+
+    _installation_id: str
+    _app_title: str
+    _app_version_name: str
+    _app_version_code: str
+    _app_package_name: str
+
+    @property
+    def installation_id(self) -> str:
+        return self._installation_id
+
+    @property
+    def app_title(self) -> str:
+        return self._app_title
+
+    @property
+    def app_version_name(self) -> str:
+        return self._app_version_name
+
+    @property
+    def app_version_code(self) -> str:
+        return self._app_version_code
+
+    @property
+    def app_package_name(self) -> str:
+        return self._app_package_name

aws_lambda_powertools/utilities/typing/lambda_cognito_identity.py

@@ -2,5 +2,19 @@
 
 
 class LambdaCognitoIdentity(object):
-    cognito_identity_id: str
-    cognito_identity_pool_id: str
+    """
+    Information about the Amazon Cognito identity that authorized the request.
+    """
+
+    _cognito_identity_id: str
+    _cognito_identity_pool_id: str
+
+    @property
+    def cognito_identity_id(self) -> str:
+        """The authenticated Amazon Cognito identity."""
+        return self._cognito_identity_id
+
+    @property
+    def cognito_identity_pool_id(self) -> str:
+        """The Amazon Cognito identity pool that authorized the invocation."""
+        return self._cognito_identity_pool_id

aws_lambda_powertools/utilities/typing/lambda_context.py

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
-from aws_lambda_powertools.utilities.typing import LambdaClientContext, LambdaCognitoIdentity
+from aws_lambda_powertools.utilities.typing.lambda_client_context import LambdaClientContext
+from aws_lambda_powertools.utilities.typing.lambda_cognito_identity import LambdaCognitoIdentity
 
 
 class LambdaContext(object):
@@ -9,9 +10,9 @@ class LambdaContext(object):
     -------
     **A Lambda function using LambdaContext**
 
-        >>> from aws_lambda_powertools.utilities.typing import LambdaDict, LambdaContext
+        >>> from aws_lambda_powertools.utilities.typing import LambdaEvent, LambdaContext
         >>>
-        >>> def handler(event: LambdaDict, context: LambdaContext) -> LambdaDict:
+        >>> def handler(event: LambdaEvent, context: LambdaContext) -> LambdaEvent:
         >>>     # Insert business logic
         >>>     return event