fix: non-mutable argument, and type annotation

Author: heitorlessa

aws_lambda_powertools/utilities/validation/base.py

@@ -1,5 +1,5 @@
 import logging
-from typing import Any, Dict
+from typing import Any, Dict, Optional
 
 import fastjsonschema
 import jmespath
@@ -11,7 +11,7 @@
 logger = logging.getLogger(__name__)
 
 
-def validate_data_against_schema(data: Dict, schema: Dict, formats: Dict = {}):
+def validate_data_against_schema(data: Dict, schema: Dict, formats: Optional[Dict] = None):
     """Validate dict data against given JSON Schema
 
     Parameters
@@ -20,6 +20,8 @@ def validate_data_against_schema(data: Dict, schema: Dict, formats: Dict = {}):
         Data set to be validated
     schema : Dict
         JSON Schema to validate against
+    formats: Dict
+        Custom formats containing a key (e.g. int64) and a value expressed as regex or callback returning bool
 
     Raises
     ------

aws_lambda_powertools/utilities/validation/validator.py

@@ -1,5 +1,5 @@
 import logging
-from typing import Any, Callable, Dict, Union
+from typing import Any, Callable, Dict, Optional, Union
 
 from ...middleware_factory import lambda_handler_decorator
 from .base import unwrap_event_from_envelope, validate_data_against_schema
@@ -13,14 +13,35 @@ def validator(
     event: Union[Dict, str],
     context: Any,
     inbound_schema: Dict = None,
-    inbound_formats: Dict = {},
+    inbound_formats: Optional[Dict] = None,
     outbound_schema: Dict = None,
-    outbound_formats: Dict = {},
+    outbound_formats: Optional[Dict] = None,
     envelope: str = None,
     jmespath_options: Dict = None,
 ) -> Any:
     """Lambda handler decorator to validate incoming/outbound data using a JSON Schema
 
+    Parameters
+    ----------
+    handler : Callable
+        Method to annotate on
+    event : Dict
+        Lambda event to be validated
+    context : Any
+        Lambda context object
+    inbound_schema : Dict
+        JSON Schema to validate incoming event
+    outbound_schema : Dict
+        JSON Schema to validate outbound event
+    envelope : Dict
+        JMESPath expression to filter data against
+    jmespath_options : Dict
+        Alternative JMESPath options to be included when filtering expr
+    inbound_formats: Dict
+        Custom formats containing a key (e.g. int64) and a value expressed as regex or callback returning bool
+    outbound_formats: Dict
+        Custom formats containing a key (e.g. int64) and a value expressed as regex or callback returning bool
+
     Example
     -------
 
@@ -80,23 +101,6 @@ def handler(event, context):
         def handler(event, context):
             return event
 
-    Parameters
-    ----------
-    handler : Callable
-        Method to annotate on
-    event : Dict
-        Lambda event to be validated
-    context : Any
-        Lambda context object
-    inbound_schema : Dict
-        JSON Schema to validate incoming event
-    outbound_schema : Dict
-        JSON Schema to validate outbound event
-    envelope : Dict
-        JMESPath expression to filter data against
-    jmespath_options : Dict
-        Alternative JMESPath options to be included when filtering expr
-
     Returns
     -------
     Any
@@ -127,11 +131,33 @@ def handler(event, context):
     return response
 
 
-def validate(event: Dict, schema: Dict = None, formats: Dict = {}, envelope: str = None, jmespath_options: Dict = None):
+def validate(
+    event: Dict,
+    schema: Dict = None,
+    formats: Optional[Dict] = None,
+    envelope: str = None,
+    jmespath_options: Dict = None,
+):
     """Standalone function to validate event data using a JSON Schema
 
      Typically used when you need more control over the validation process.
 
+    Parameters
+    ----------
+    event : Dict
+        Lambda event to be validated
+    schema : Dict
+        JSON Schema to validate incoming event
+    envelope : Dict
+        JMESPath expression to filter data against
+    jmespath_options : Dict
+        Alternative JMESPath options to be included when filtering expr
+    formats: Dict
+        Custom formats containing a key (e.g. int64) and a value expressed as regex or callback returning bool
+
+    Example
+    -------
+
     **Validate event**
 
         from aws_lambda_powertools.utilities.validation import validate
@@ -180,17 +206,6 @@ def handler(event, context):
             validate(event=event, schema=json_schema_dict, envelope="awslogs.powertools_base64_gzip(data) | powertools_json(@).logEvents[*]")
             return event
 
-    Parameters
-    ----------
-    event : Dict
-        Lambda event to be validated
-    schema : Dict
-        JSON Schema to validate incoming event
-    envelope : Dict
-        JMESPath expression to filter data against
-    jmespath_options : Dict
-        Alternative JMESPath options to be included when filtering expr
-
     Raises
     ------
     SchemaValidationError