fix: set defaults to None

Author: tonnico

aws_lambda_powertools/utilities/data_classes/shared_functions.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 import base64
-from typing import Any, Dict, List, Optional, overload
+from typing import Any, overload
 
 
 def base64_decode(value: str) -> str:
@@ -26,31 +26,31 @@ def get_header_value(
     headers: dict[str, Any],
     name: str,
     default_value: str,
-    case_sensitive: bool,
+    case_sensitive: bool | None = None,
 ) -> str: ...
 
 
 @overload
 def get_header_value(
     headers: dict[str, Any],
     name: str,
-    default_value: Optional[str],
-    case_sensitive: bool,
-) -> Optional[str]: ...
+    default_value: str | None = None,
+    case_sensitive: bool | None = None,
+) -> str | None: ...
 
 
 def get_header_value(
     headers: dict[str, Any],
     name: str,
-    default_value: Optional[str],
-    case_sensitive: bool,
-) -> Optional[str]:
+    default_value: str | None = None,
+    case_sensitive: bool | None = None,
+) -> str | None:
     """
     Get the value of a header by its name.
 
     Parameters
     ----------
-    headers: Dict[str, str]
+    headers: dict[str, str]
         The dictionary of headers.
     name: str
         The name of the header to retrieve.
@@ -82,25 +82,25 @@ def get_header_value(
 
 @overload
 def get_query_string_value(
-    query_string_parameters: Dict[str, str] | None,
+    query_string_parameters: dict[str, str] | None,
     name: str,
     default_value: str,
 ) -> str: ...
 
 
 @overload
 def get_query_string_value(
-    query_string_parameters: Dict[str, str] | None,
+    query_string_parameters: dict[str, str] | None,
     name: str,
-    default_value: Optional[str] = None,
-) -> Optional[str]: ...
+    default_value: str | None = None,
+) -> str | None: ...
 
 
 def get_query_string_value(
-    query_string_parameters: Dict[str, str] | None,
+    query_string_parameters: dict[str, str] | None,
     name: str,
-    default_value: Optional[str] = None,
-) -> Optional[str]:
+    default_value: str | None = None,
+) -> str | None:
     """
     Retrieves the value of a query string parameter specified by the given name.
 
@@ -121,23 +121,23 @@ def get_query_string_value(
 
 
 def get_multi_value_query_string_values(
-    multi_value_query_string_parameters: Dict[str, List[str]] | None,
+    multi_value_query_string_parameters: dict[str, list[str]] | None,
     name: str,
-    default_values: Optional[List[str]] = None,
-) -> List[str]:
+    default_values: list[str] | None = None,
+) -> list[str]:
     """
     Retrieves the values of a multi-value string parameters specified by the given name.
 
     Parameters
     ----------
     name: str
         The name of the query string parameter to retrieve.
-    default_value: List[str], optional
+    default_value: list[str], optional
         The default value to return if the parameter is not found. Defaults to None.
 
     Returns
     -------
-    List[str]. optional
+    list[str]. optional
         The values of the query string parameter if found, or the default values if not found.
     """
 

examples/event_handler_graphql/src/custom_models.py

@@ -26,11 +26,11 @@ class Location(TypedDict, total=False):
 class MyCustomModel(AppSyncResolverEvent):
     @property
     def country_viewer(self) -> str:
-        return self.get_header_value(name="cloudfront-viewer-country", default_value="", case_sensitive=False)  # type: ignore[return-value] # sentinel typing # noqa: E501
+        return self.get_header_value(name="cloudfront-viewer-country", default_value="", case_sensitive=False)
 
     @property
     def api_key(self) -> str:
-        return self.get_header_value(name="x-api-key", default_value="", case_sensitive=False)  # type: ignore[return-value] # sentinel typing # noqa: E501
+        return self.get_header_value(name="x-api-key", default_value="", case_sensitive=False)
 
 
 @app.resolver(type_name="Query", field_name="listLocations")