feat(data-classes): add value property to AttributeValue

Author: Michael Brewer

aws_lambda_powertools/utilities/data_classes/dynamo_db_stream_event.py

@@ -1,5 +1,5 @@
 from enum import Enum
-from typing import Dict, Iterator, List, Optional
+from typing import Any, Dict, Iterator, List, Optional, Union
 
 from aws_lambda_powertools.utilities.data_classes.common import DictWrapper
 
@@ -23,10 +23,16 @@ class AttributeValue(DictWrapper):
     Documentation: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_streams_AttributeValue.html
     """
 
-    @property
-    def get_type(self) -> AttributeValueType:
-        """Get the attribute value type based on the contained data"""
-        return AttributeValueType(list(self.raw_event.keys())[0])
+    def __init__(self, data: Dict[str, Any]):
+        """AttributeValue constructor
+
+        Parameters
+        ----------
+        data: Dict[str, Any]
+            Raw lambda event dict
+        """
+        super().__init__(data)
+        self.dynamodb_type = list(data.keys())[0]
 
     @property
     def b_value(self) -> Optional[str]:
@@ -124,6 +130,29 @@ def ss_value(self) -> Optional[List[str]]:
         """
         return self.get("SS")
 
+    @property
+    def get_type(self) -> AttributeValueType:
+        """Get the attribute value type based on the contained data"""
+        return AttributeValueType(self.dynamodb_type)
+
+    @property
+    def value(self) -> Union[Optional[bool], Optional[str], Optional[List], Optional[Dict]]:
+        """Get the attribute value"""
+        try:
+            return getattr(self, f"{self.dynamodb_type.lower()}_value")
+        except AttributeError:
+            raise TypeError(f"Dynamodb type {self.dynamodb_type} is not supported")
+
+    @property
+    def l_value(self) -> Optional[List["AttributeValue"]]:
+        """Alias of list_value"""
+        return self.list_value
+
+    @property
+    def m_value(self) -> Optional[Dict[str, "AttributeValue"]]:
+        """Alias of map_value"""
+        return self.map_value
+
 
 def _attribute_value_dict(attr_values: Dict[str, dict], key: str) -> Optional[Dict[str, AttributeValue]]:
     """A dict of type String to AttributeValue object map

tests/functional/test_data_classes.py

@@ -450,6 +450,7 @@ def test_dynamo_attribute_value_b_value():
     attribute_value = AttributeValue(example_attribute_value)
 
     assert attribute_value.get_type == AttributeValueType.Binary
+    assert attribute_value.b_value == attribute_value.value
 
 
 def test_dynamo_attribute_value_bs_value():
@@ -458,6 +459,7 @@ def test_dynamo_attribute_value_bs_value():
     attribute_value = AttributeValue(example_attribute_value)
 
     assert attribute_value.get_type == AttributeValueType.BinarySet
+    assert attribute_value.bs_value == attribute_value.value
 
 
 def test_dynamo_attribute_value_bool_value():
@@ -466,6 +468,7 @@ def test_dynamo_attribute_value_bool_value():
     attribute_value = AttributeValue(example_attribute_value)
 
     assert attribute_value.get_type == AttributeValueType.Boolean
+    assert attribute_value.bool_value == attribute_value.value
 
 
 def test_dynamo_attribute_value_list_value():
@@ -476,6 +479,8 @@ def test_dynamo_attribute_value_list_value():
     item = list_value[0]
     assert item.s_value == "Cookies"
     assert attribute_value.get_type == AttributeValueType.List
+    assert attribute_value.l_value == attribute_value.list_value
+    assert attribute_value.list_value == attribute_value.value
 
 
 def test_dynamo_attribute_value_map_value():
@@ -488,6 +493,8 @@ def test_dynamo_attribute_value_map_value():
     item = map_value["Name"]
     assert item.s_value == "Joe"
     assert attribute_value.get_type == AttributeValueType.Map
+    assert attribute_value.m_value == attribute_value.map_value
+    assert attribute_value.map_value == attribute_value.value
 
 
 def test_dynamo_attribute_value_n_value():
@@ -496,6 +503,7 @@ def test_dynamo_attribute_value_n_value():
     attribute_value = AttributeValue(example_attribute_value)
 
     assert attribute_value.get_type == AttributeValueType.Number
+    assert attribute_value.n_value == attribute_value.value
 
 
 def test_dynamo_attribute_value_ns_value():
@@ -504,6 +512,7 @@ def test_dynamo_attribute_value_ns_value():
     attribute_value = AttributeValue(example_attribute_value)
 
     assert attribute_value.get_type == AttributeValueType.NumberSet
+    assert attribute_value.ns_value == attribute_value.value
 
 
 def test_dynamo_attribute_value_null_value():
@@ -512,6 +521,7 @@ def test_dynamo_attribute_value_null_value():
     attribute_value = AttributeValue(example_attribute_value)
 
     assert attribute_value.get_type == AttributeValueType.Null
+    assert attribute_value.null_value == attribute_value.value
 
 
 def test_dynamo_attribute_value_s_value():
@@ -520,6 +530,7 @@ def test_dynamo_attribute_value_s_value():
     attribute_value = AttributeValue(example_attribute_value)
 
     assert attribute_value.get_type == AttributeValueType.String
+    assert attribute_value.s_value == attribute_value.value
 
 
 def test_dynamo_attribute_value_ss_value():
@@ -528,6 +539,7 @@ def test_dynamo_attribute_value_ss_value():
     attribute_value = AttributeValue(example_attribute_value)
 
     assert attribute_value.get_type == AttributeValueType.StringSet
+    assert attribute_value.ss_value == attribute_value.value
 
 
 def test_event_bridge_event():