chore(data-classes): Typing and docs

Changes:
- Correct typing to make mypy happier
- Correct highlighted lines

Author: Michael Brewer

aws_lambda_powertools/utilities/data_classes/appsync/resolver_utils.py

@@ -27,8 +27,8 @@ def register_resolver(func):
 
         return register_resolver
 
-    def resolve(self, event: dict, context: LambdaContext) -> Any:
-        event = AppSyncResolverEvent(event)
+    def resolve(self, _event: dict, context: LambdaContext) -> Any:
+        event = AppSyncResolverEvent(_event)
         resolver, config = self._resolver(event.type_name, event.field_name)
         kwargs = self._kwargs(event, context, config)
         return resolver(**kwargs)

aws_lambda_powertools/utilities/data_classes/cognito_user_pool_event.py

@@ -292,26 +292,26 @@ class CustomMessageTriggerEventResponse(DictWrapper):
     def sms_message(self) -> str:
         return self["response"]["smsMessage"]
 
-    @property
-    def email_message(self) -> str:
-        return self["response"]["emailMessage"]
-
-    @property
-    def email_subject(self) -> str:
-        return self["response"]["emailSubject"]
-
     @sms_message.setter
     def sms_message(self, value: str):
         """The custom SMS message to be sent to your users.
         Must include the codeParameter value received in the request."""
         self["response"]["smsMessage"] = value
 
+    @property
+    def email_message(self) -> str:
+        return self["response"]["emailMessage"]
+
     @email_message.setter
     def email_message(self, value: str):
         """The custom email message to be sent to your users.
         Must include the codeParameter value received in the request."""
         self["response"]["emailMessage"] = value
 
+    @property
+    def email_subject(self) -> str:
+        return self["response"]["emailSubject"]
+
     @email_subject.setter
     def email_subject(self, value: str):
         """The subject line for the custom message."""
@@ -471,26 +471,26 @@ class ClaimsOverrideDetails(DictWrapper):
     def claims_to_add_or_override(self) -> Optional[Dict[str, str]]:
         return self.get("claimsToAddOrOverride")
 
-    @property
-    def claims_to_suppress(self) -> Optional[List[str]]:
-        return self.get("claimsToSuppress")
-
-    @property
-    def group_configuration(self) -> Optional[GroupOverrideDetails]:
-        group_override_details = self.get("groupOverrideDetails")
-        return None if group_override_details is None else GroupOverrideDetails(group_override_details)
-
     @claims_to_add_or_override.setter
     def claims_to_add_or_override(self, value: Dict[str, str]):
         """A map of one or more key-value pairs of claims to add or override.
         For group related claims, use groupOverrideDetails instead."""
         self._data["claimsToAddOrOverride"] = value
 
+    @property
+    def claims_to_suppress(self) -> Optional[List[str]]:
+        return self.get("claimsToSuppress")
+
     @claims_to_suppress.setter
     def claims_to_suppress(self, value: List[str]):
         """A list that contains claims to be suppressed from the identity token."""
         self._data["claimsToSuppress"] = value
 
+    @property
+    def group_configuration(self) -> Optional[GroupOverrideDetails]:
+        group_override_details = self.get("groupOverrideDetails")
+        return None if group_override_details is None else GroupOverrideDetails(group_override_details)
+
     @group_configuration.setter
     def group_configuration(self, value: Dict[str, Any]):
         """The output object containing the current group configuration.
@@ -609,25 +609,25 @@ class DefineAuthChallengeTriggerEventResponse(DictWrapper):
     def challenge_name(self) -> str:
         return self["response"]["challengeName"]
 
-    @property
-    def fail_authentication(self) -> bool:
-        return bool(self["response"]["failAuthentication"])
-
-    @property
-    def issue_tokens(self) -> bool:
-        return bool(self["response"]["issueTokens"])
-
     @challenge_name.setter
     def challenge_name(self, value: str):
         """A string containing the name of the next challenge.
         If you want to present a new challenge to your user, specify the challenge name here."""
         self["response"]["challengeName"] = value
 
+    @property
+    def fail_authentication(self) -> bool:
+        return bool(self["response"]["failAuthentication"])
+
     @fail_authentication.setter
     def fail_authentication(self, value: bool):
         """Set to true if you want to terminate the current authentication process, or false otherwise."""
         self["response"]["failAuthentication"] = value
 
+    @property
+    def issue_tokens(self) -> bool:
+        return bool(self["response"]["issueTokens"])
+
     @issue_tokens.setter
     def issue_tokens(self, value: bool):
         """Set to true if you determine that the user has been sufficiently authenticated by
@@ -695,21 +695,17 @@ class CreateAuthChallengeTriggerEventResponse(DictWrapper):
     def public_challenge_parameters(self) -> Dict[str, str]:
         return self["response"]["publicChallengeParameters"]
 
-    @property
-    def private_challenge_parameters(self) -> Dict[str, str]:
-        return self["response"]["privateChallengeParameters"]
-
-    @property
-    def challenge_metadata(self) -> str:
-        return self["response"]["challengeMetadata"]
-
     @public_challenge_parameters.setter
     def public_challenge_parameters(self, value: Dict[str, str]):
         """One or more key-value pairs for the client app to use in the challenge to be presented to the user.
         This parameter should contain all of the necessary information to accurately present the challenge to
         the user."""
         self["response"]["publicChallengeParameters"] = value
 
+    @property
+    def private_challenge_parameters(self) -> Dict[str, str]:
+        return self["response"]["privateChallengeParameters"]
+
     @private_challenge_parameters.setter
     def private_challenge_parameters(self, value: Dict[str, str]):
         """This parameter is only used by the Verify Auth Challenge Response Lambda trigger.
@@ -719,6 +715,10 @@ def private_challenge_parameters(self, value: Dict[str, str]):
         for the question."""
         self["response"]["privateChallengeParameters"] = value
 
+    @property
+    def challenge_metadata(self) -> str:
+        return self["response"]["challengeMetadata"]
+
     @challenge_metadata.setter
     def challenge_metadata(self, value: str):
         """Your name for the custom challenge, if this is a custom challenge."""

aws_lambda_powertools/utilities/data_classes/common.py

@@ -25,7 +25,9 @@ def raw_event(self) -> Dict[str, Any]:
         return self._data
 
 
-def get_header_value(headers: Dict[str, str], name: str, default_value: str, case_sensitive: bool) -> Optional[str]:
+def get_header_value(
+    headers: Dict[str, str], name: str, default_value: Optional[str], case_sensitive: Optional[bool]
+) -> Optional[str]:
     """Get header value by name"""
     if case_sensitive:
         return headers.get(name, default_value)

docs/utilities/data_classes.md

@@ -554,7 +554,7 @@ This example is based on the AWS Blog post [Introducing Amazon S3 Object Lambda
 
 === "app.py"
 
-    ```python  hl_lines="4-5 10 12"
+    ```python  hl_lines="5-6 12 14"
     import boto3
     import requests