boto3-assist 0.2.9__tar.gz → 0.2.11__tar.gz

{boto3_assist-0.2.9 → boto3_assist-0.2.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: boto3_assist
-Version: 0.2.9
+Version: 0.2.11
 Summary: Additional boto3 wrappers to make your life a little easier
 Author-email: Eric Wilson <boto3-assist@geekcafe.com>
 License-File: LICENSE-EXPLAINED.txt

{boto3_assist-0.2.9 → boto3_assist-0.2.11}/pyproject.toml

@@ -7,7 +7,7 @@ packages = ["src/boto3_assist"]
 
 [project]
 name = "boto3_assist"
-version = "0.2.9"
+version = "0.2.11"
 
 authors = [
   { name="Eric Wilson", email="boto3-assist@geekcafe.com" }

{boto3_assist-0.2.9 → boto3_assist-0.2.11}/src/boto3_assist/dynamodb/dynamodb.py

@@ -94,7 +94,7 @@ class DynamoDB(DynamoDBConnection):
                 except Exception as e:  # pylint: disable=w0718
                     logger.exception(e)
                     raise RuntimeError(
-                        "An error occured during model converation.  The entry was not saved."
+                        "An error occured during model converation.  The entry was not saved. "
                     ) from e
 
             if isinstance(item, dict):

{boto3_assist-0.2.9 → boto3_assist-0.2.11}/src/boto3_assist/dynamodb/dynamodb_index.py

@@ -28,6 +28,14 @@ class DynamoDBIndexes:
     def add_primary(self, index: DynamoDBIndex):
         """Add an index"""
         index.name = DynamoDBIndexes.PRIMARY_INDEX
+
+        if index.name in self.__indexes:
+            raise ValueError(
+                f"The index {index.name} is already defined in your model somewhere. "
+                "This error is generated to protect you from unforseen issues. "
+                "If you models are inheriting from other models, you may have the primary defined twice."
+            )
+
         self.__indexes[DynamoDBIndexes.PRIMARY_INDEX] = index
 
     def add_secondary(self, index: DynamoDBIndex):
@@ -37,7 +45,11 @@ class DynamoDBIndexes:
 
         # if the index already exists, raise an exception
         if index.name in self.__indexes:
-            raise ValueError(f"Index {index.name} already exists")
+            raise ValueError(
+                f"The index {index.name} is already defined in your model somewhere. "
+                "This error is generated to protect you from unforseen issues. "
+                "If you models are inheriting from other models, you may have the primary defined twice."
+            )
         if index.name == DynamoDBIndexes.PRIMARY_INDEX:
             raise ValueError(f"Index {index.name} is reserved for the primary index")
         if index.partition_key is None:

{boto3_assist-0.2.9 → boto3_assist-0.2.11}/src/boto3_assist/dynamodb/dynamodb_model_base.py

@@ -49,6 +49,7 @@ class DynamoDBModelBase:
         self.__indexes: DynamoDBIndexes | None = None
         self.__reserved_words: DynamoDBReservedWords = DynamoDBReservedWords()
         self.__auto_generate_projections: bool = auto_generate_projections
+        self.__actively_serializing_data__: bool = False
 
     @property
     @exclude_from_serialization

{boto3_assist-0.2.9 → boto3_assist-0.2.11}/src/boto3_assist/utilities/serialization_utility.py

@@ -67,7 +67,6 @@ class Serialization:
         raise ValueError("Unable to convert object to dictionary")
 
     @staticmethod
-    @tracer.capture_method
     def map(source: object, target: T) -> T | None:
         """Map an object from one object to another"""
         source_dict: dict | object
@@ -80,7 +79,6 @@ class Serialization:
         return Serialization.load_properties(source_dict, target=target)
 
     @staticmethod
-    @tracer.capture_method
     def load_properties(source: dict, target: T) -> T | None:
         """
         Converts a source to an object
@@ -93,8 +91,11 @@ class Serialization:
         if hasattr(source, "__dict__"):
             source = source.__dict__
 
+        if hasattr(target, "__actively_serializing_data__"):
+            setattr(target, "__actively_serializing_data__", True)
+
         for key, value in source.items():
-            if hasattr(target, key):
+            if Serialization.has_attribute(target, key):  # hasattr(target, key):
                 attr = getattr(target, key)
                 if isinstance(attr, (int, float, str, bool, type(None))):
                     try:
@@ -116,4 +117,29 @@ class Serialization:
                     Serialization.load_properties(value, attr)
                 else:
                     setattr(target, key, value)
+
+        if hasattr(target, "__actively_serializing_data__"):
+            setattr(target, "__actively_serializing_data__", False)
+
         return target
+
+    @staticmethod
+    def has_attribute(obj: object, attribute_name: str) -> bool:
+        """Check if an object has an attribute"""
+        try:
+            return hasattr(obj, attribute_name)
+        except AttributeError:
+            return False
+        except Exception as e:  # pylint: disable=w0718
+            raise RuntimeError(
+                "Failed to serialize the object. \n"
+                "You may have some validation that is preventing this routine "
+                "from completing. Such as a None checker on a getter. \n\n"
+                "To work around this create a boolean (bool) property named __actively_serializing_data__. \n"
+                "e.g. self.__actively_serializing_data__: bool = False\n\n"
+                "Only issue/raise your exception if __actively_serializing_data__ is not True. \n\n"
+                "e.g. if not self.some_propert and not self.__actively_serializing_data__:\n"
+                '    raise ValueError("some_property must be set")\n\n'
+                "This procedure will update the property from False to True while serializing, "
+                "then back to False once serialization is complete. "
+            ) from e

boto3_assist-0.2.11/src/boto3_assist/version.py

@@ -0,0 +1 @@
+__version__ = '0.2.11'

{boto3_assist-0.2.9 → boto3_assist-0.2.11}/tests/dynamodb/dynamodb_model_serializtion_test.py

@@ -8,6 +8,7 @@ import unittest
 
 
 from tests.dynamodb.models.user_model import User
+from tests.dynamodb.models.user_required_fields_model import User as User2
 
 
 class DynamoDBModelSerializationUnitTest(unittest.TestCase):
@@ -48,3 +49,38 @@ class DynamoDBModelSerializationUnitTest(unittest.TestCase):
         user: User = User()
         dictionary = user.to_resource_dictionary()
         self.assertIsInstance(dictionary, dict)
+
+    def test_required_fields(self):
+        """Test Required Fields"""
+        # Arrange
+        data = {
+            "id": "123456",
+            "first_name": "John",
+            "age": 30,
+            "email": "john@example.com",
+        }
+
+        # Act
+        serialized_data: User2 = User2().map(data)
+
+        # Assert
+        self.assertEqual(serialized_data.first_name, "John")
+        self.assertEqual(serialized_data.age, 30)
+        self.assertEqual(serialized_data.email, "john@example.com")
+        self.assertIsInstance(serialized_data, User2)
+
+        key = serialized_data.indexes.primary.key()
+        self.assertIsInstance(key, dict)
+
+        dictionary = serialized_data.to_resource_dictionary()
+        self.assertIsInstance(dictionary, dict)
+        keys = dictionary.keys()
+        self.assertIn("first_name", keys)
+        self.assertIn("age", keys)
+        self.assertIn("email", keys)
+        self.assertIn("id", keys)
+        self.assertNotIn("T", keys)
+
+        user: User = User()
+        dictionary = user.to_resource_dictionary()
+        self.assertIsInstance(dictionary, dict)

boto3_assist-0.2.11/tests/dynamodb/models/user_required_fields_model.py

@@ -0,0 +1,74 @@
+"""
+Geek Cafe, LLC
+Maintainers: Eric Wilson
+MIT License.  See Project Root for the license information.
+"""
+
+from typing import Optional
+
+from boto3_assist.dynamodb.dynamodb_model_base import DynamoDBModelBase
+from boto3_assist.dynamodb.dynamodb_index import DynamoDBIndex
+from boto3_assist.dynamodb.dynamodb_key import DynamoDBKey
+
+
+class User(DynamoDBModelBase):
+    """User Model"""
+
+    def __init__(
+        self,
+        id: Optional[str] = None,  # pylint: disable=redefined-builtin
+    ):
+        super().__init__(self)
+        self.id: Optional[str] = id
+        self.first_name: Optional[str] = None
+        self.last_name: Optional[str] = None
+        self.age: Optional[int] = None
+        self.__email: Optional[str] = None
+        # known reserved words
+        self.status: Optional[str] = None
+
+        self.__setup_indexes()
+
+    def __setup_indexes(self):
+        primay: DynamoDBIndex = DynamoDBIndex()
+        primay.partition_key.attribute_name = "pk"
+        # allows for a wild card search on all "sites"
+        primay.partition_key.value = lambda: DynamoDBKey.build_key(("user", self.id))
+        primay.sort_key.attribute_name = "sk"
+        primay.sort_key.value = lambda: DynamoDBKey.build_key(("user", self.id))
+        self.indexes.add_primary(primay)
+
+        gsi0: DynamoDBIndex = DynamoDBIndex(index_name="gsi0")
+        gsi0.partition_key.attribute_name = "gsi0_pk"
+        gsi0.partition_key.value = lambda: DynamoDBKey.build_key(("users", None))
+        gsi0.sort_key.attribute_name = "gsi0_sk"
+        gsi0.sort_key.value = lambda: DynamoDBKey.build_key(("email", self.email))
+        self.indexes.add_secondary(gsi0)
+
+        gsi1: DynamoDBIndex = DynamoDBIndex(index_name="gsi1")
+        gsi1.partition_key.attribute_name = "gsi1_pk"
+        gsi1.partition_key.value = lambda: DynamoDBKey.build_key(("users", None))
+        gsi1.sort_key.attribute_name = "gsi1_sk"
+        gsi1.sort_key.value = lambda: DynamoDBKey.build_key(
+            ("lastname", self.last_name), ("firstname", self.first_name)
+        )
+        self.indexes.add_secondary(gsi1)
+
+        gsi0: DynamoDBIndex = DynamoDBIndex(index_name="gsi2")
+        gsi0.partition_key.attribute_name = "gsi2_pk"
+        gsi0.partition_key.value = lambda: DynamoDBKey.build_key(("users", None))
+        gsi0.sort_key.attribute_name = "gsi2_sk"
+        gsi0.sort_key.value = lambda: DynamoDBKey.build_key(
+            ("firstname", self.first_name), ("lastname", self.last_name)
+        )
+        self.indexes.add_secondary(gsi0)
+
+    @property
+    def email(self) -> str:
+        if not self.__email and not self.__actively_serializing_data__:
+            raise ValueError("Email is required.")
+        return self.__email
+
+    @email.setter
+    def email(self, value: str):
+        self.__email = value.lower()

boto3_assist-0.2.9/src/boto3_assist/version.py

@@ -1 +0,0 @@
-__version__ = '0.2.9'