boto3-assist 0.2.9__py3-none-any.whl → 0.2.11__py3-none-any.whl

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/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/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/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/version.py

@@ -1 +1 @@
-__version__ = '0.2.9'
+__version__ = '0.2.11'

{boto3_assist-0.2.9.dist-info → boto3_assist-0.2.11.dist-info}/METADATA

@@ -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.dist-info → boto3_assist-0.2.11.dist-info}/RECORD

@@ -2,21 +2,21 @@ boto3_assist/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 boto3_assist/boto3session.py,sha256=NWhWtYR3143thEbTpoklkwdz77-fTMs-QsoQdqfRm6E,6430
 boto3_assist/connection.py,sha256=EJlGueLIYqMSKs7aQlThK1S0Zkb8dOYBWch1iRZdgUI,3233
 boto3_assist/connection_tracker.py,sha256=_s1t7h2DOi3CCIHIr_HIKyGjku65WR-HJ_v8vJHDvO0,2977
-boto3_assist/version.py,sha256=bd8hlxKMc0Fh_2w5GWfqBtuwa8uTepTMjT8w7F-EKvY,22
+boto3_assist/version.py,sha256=1GoaUwMSeBBLruUDdM6dEOYv-nA5voDZ34P71yo1WKo,23
 boto3_assist/cloudwatch/cloudwatch_connection.py,sha256=mnGWaLSQpHh5EeY7Ek_2o9JKHJxOELIYtQVMX1IaHn4,2480
 boto3_assist/cloudwatch/cloudwatch_connection_tracker.py,sha256=mzRtO1uHrcfJNh1XrGEiXdTqxwEP8d1RqJkraMNkgK0,410
 boto3_assist/cloudwatch/cloudwatch_log_connection.py,sha256=qQMZHjUJ6gA8wU9utjQhOURXNSPH2RjxSoAy83bvoCs,1737
 boto3_assist/cloudwatch/cloudwatch_logs.py,sha256=VtI0OnFjX1l4RYVvA8tvveGkPwAogtrplnflZ4dQSNM,1204
 boto3_assist/cloudwatch/cloudwatch_query.py,sha256=uNhSb1Gfp99v8BaHmCnCKs63j4MMU4WveqBavCJyhGY,6409
-boto3_assist/dynamodb/dynamodb.py,sha256=PVWALqf5f8ftsf3U5xcNFo_32HQmysgkNbucMwope4w,15771
+boto3_assist/dynamodb/dynamodb.py,sha256=q3U4uYqnKX1_u5TXv8Iq94JrBad16q0rL_vKxQyR_3k,15772
 boto3_assist/dynamodb/dynamodb_connection.py,sha256=hr4IGbbEE73fh375tj3_XtYAwwDV0s7z1-6JK_1Tc30,5263
 boto3_assist/dynamodb/dynamodb_connection_tracker.py,sha256=0BWHRfi5_vjkJLuCSX6sYwvA6wc7BSYCQnGrzbhfyKA,404
 boto3_assist/dynamodb/dynamodb_helpers.py,sha256=ajpTJ5bJOm9PDgE2Zx9p2zkTRFV4xswqJRS81SOTn1s,12198
 boto3_assist/dynamodb/dynamodb_importer.py,sha256=nCKsyRQeMqDSf0Q5mQ_X_oVIg4PRnu0hcUzZnBli610,3471
-boto3_assist/dynamodb/dynamodb_index.py,sha256=7xa2bN3o8P7XIN9CcJiU7_i1MVjZPl6ZPVZqbZr8pS4,7747
+boto3_assist/dynamodb/dynamodb_index.py,sha256=fNIFeuUqjoYN82DcF1FRtkKwb0rXI5KMVeE9BrDLblI,8359
 boto3_assist/dynamodb/dynamodb_iservice.py,sha256=O9Aj0PFEvcuk2vhARifWTFnUwcQW5EXzwZS478Hm-N0,796
 boto3_assist/dynamodb/dynamodb_key.py,sha256=YD7o1EUlwVBQ55p9YCTKqAUU_np4nqtLIHnmp-BeolM,1803
-boto3_assist/dynamodb/dynamodb_model_base.py,sha256=RpVhh88Bvg0aPO5Ux1yliFc8-INQfWdMsXo3mk_Clw8,15351
+boto3_assist/dynamodb/dynamodb_model_base.py,sha256=bAKYN2h__tGBtYmcNh-Ra-8DHzvnqZpjVeiXaCNYDZA,15408
 boto3_assist/dynamodb/dynamodb_model_base_interfaces.py,sha256=yT4zDRI8vP15WVOHnCvY3FsEy_QSIta5-bnUby70Xow,747
 boto3_assist/dynamodb/dynamodb_reindexer.py,sha256=bCj6KIU0fQOgjkkiq9yF51PFZZr4Y9Lu3-hPlmsPG0Y,6164
 boto3_assist/dynamodb/dynamodb_reserved_words.py,sha256=p0irNBSqGe4rd2FwWQqbRJWrNr4svdbWiyIXmz9lj4c,1937
@@ -34,10 +34,10 @@ boto3_assist/utilities/datetime_utility.py,sha256=TbqGQkJDTahqvaZAIV550nhYnW1Bsq
 boto3_assist/utilities/file_operations.py,sha256=Zy8fu8fpuVNf7U9NimrLdy5FRF71XSI159cnRdzmzGY,3411
 boto3_assist/utilities/http_utility.py,sha256=koFv7Va-8ng-47Nt1K2Sh7Ti95e62IYs9VMLlGh9Kt4,1173
 boto3_assist/utilities/logging_utility.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-boto3_assist/utilities/serialization_utility.py,sha256=s_QQRIhtwIE7xN5nU13mNk2wtWyErBX_Sg7n0gbHj-M,4308
+boto3_assist/utilities/serialization_utility.py,sha256=AWm8s0E62C35Zb9SLfW6DFA05e8sgCVyHwVl67mdu24,5749
 boto3_assist/utilities/string_utility.py,sha256=w8l063UT3GE48tuJopETyZrjG4CgAzWkyDWMAYMg5Og,7432
-boto3_assist-0.2.9.dist-info/METADATA,sha256=i463YtqFRnpN9R6CpO4LNt5Esk0EJW9-XW5uLx1riqM,1707
-boto3_assist-0.2.9.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-boto3_assist-0.2.9.dist-info/licenses/LICENSE-EXPLAINED.txt,sha256=WFREvTpfTjPjDHpOLADxJpCKpIla3Ht87RUUGii4ODU,606
-boto3_assist-0.2.9.dist-info/licenses/LICENSE.txt,sha256=PXDhFWS5L5aOTkVhNvoitHKbAkgxqMI2uUPQyrnXGiI,1105
-boto3_assist-0.2.9.dist-info/RECORD,,
+boto3_assist-0.2.11.dist-info/METADATA,sha256=U0W8JPS56y0U06bXqpOB8reCj4Pew8UB50IVP_GM7F8,1708
+boto3_assist-0.2.11.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+boto3_assist-0.2.11.dist-info/licenses/LICENSE-EXPLAINED.txt,sha256=WFREvTpfTjPjDHpOLADxJpCKpIla3Ht87RUUGii4ODU,606
+boto3_assist-0.2.11.dist-info/licenses/LICENSE.txt,sha256=PXDhFWS5L5aOTkVhNvoitHKbAkgxqMI2uUPQyrnXGiI,1105
+boto3_assist-0.2.11.dist-info/RECORD,,