boto3-assist 0.1.7__py3-none-any.whl → 0.1.9__py3-none-any.whl

boto3_assist/dynamodb/dynamodb_model_base.py

@@ -153,21 +153,25 @@ class DynamoDBModelBase:
             self, include_indexes=include_indexes
         )
 
-    def to_resource_dictionary(self, include_indexes: bool = True):
+    def to_resource_dictionary(
+        self, include_indexes: bool = True, include_none: bool = False
+    ):
         """
         Convert the instance to a dictionary suitable for DynamoDB resource.
         """
         return DynamoDBSerializer.to_resource_dictionary(
-            self, include_indexes=include_indexes
+            self, include_indexes=include_indexes, include_none=include_none
         )
 
-    def to_dictionary(self):
+    def to_dictionary(self, include_none: bool = True):
         """
         Convert the instance to a dictionary without an indexes/keys.
         Usefull for turning an object into a dictionary for serialization.
         This is the same as to_resource_dictionary(include_indexes=False)
         """
-        return DynamoDBSerializer.to_resource_dictionary(self, include_indexes=False)
+        return DynamoDBSerializer.to_resource_dictionary(
+            self, include_indexes=False, include_none=include_none
+        )
 
     def get_key(self, index_name: str) -> DynamoDBIndex:
         """Get the index name and key"""
@@ -232,7 +236,9 @@ class DynamoDBSerializer:
 
     @staticmethod
     def to_resource_dictionary(
-        instance: DynamoDBModelBase, include_indexes: bool = True
+        instance: DynamoDBModelBase,
+        include_indexes: bool = True,
+        include_none: bool = False,
     ):
         """
         Convert a Python class instance to a dictionary suitable for DynamoDB resource.
@@ -244,12 +250,18 @@ class DynamoDBSerializer:
         - dict: A dictionary representation of the class instance suitable for DynamoDB resource.
         """
         return DynamoDBSerializer._serialize(
-            instance, lambda x: x, include_indexes=include_indexes
+            instance,
+            lambda x: x,
+            include_indexes=include_indexes,
+            include_none=include_none,
         )
 
     @staticmethod
     def _serialize(
-        instance: DynamoDBModelBase, serialize_fn, include_indexes: bool = True
+        instance: DynamoDBModelBase,
+        serialize_fn,
+        include_indexes: bool = True,
+        include_none: bool = True,
     ):
         def is_primitive(value):
             """Check if the value is a primitive data type."""
@@ -259,7 +271,11 @@ class DynamoDBSerializer:
             """Serialize the value using the provided function."""
 
             if isinstance(value, DynamoDBModelBase):
-                return serialize_fn(value.to_resource_dictionary(False))
+                return serialize_fn(
+                    value.to_resource_dictionary(
+                        include_indexes=False, include_none=include_none
+                    )
+                )
             if isinstance(value, dt.datetime):
                 return serialize_fn(value.isoformat())
             elif isinstance(value, float):
@@ -278,23 +294,36 @@ class DynamoDBSerializer:
             elif isinstance(value, dict):
                 return serialize_fn({k: serialize_value(v) for k, v in value.items()})
             else:
-                return serialize_fn(DynamoDBSerializer._serialize(value, serialize_fn))
+                return serialize_fn(
+                    DynamoDBSerializer._serialize(
+                        value,
+                        serialize_fn,
+                        include_indexes=include_indexes,
+                        include_none=include_none,
+                    )
+                )
 
-        instance_dict = DynamoDBSerializer._add_properties(instance, serialize_value)
+        instance_dict = DynamoDBSerializer._add_properties(
+            instance, serialize_value, include_none=include_none
+        )
 
         if include_indexes:
             instance_dict = DynamoDBSerializer._add_indexes(instance, instance_dict)
         return instance_dict
 
     @staticmethod
-    def _add_properties(instance: DynamoDBModelBase, serialize_value) -> dict:
+    def _add_properties(
+        instance: DynamoDBModelBase,
+        serialize_value,
+        include_none: bool = True,
+    ) -> dict:
         instance_dict = {}
 
         # Add instance variables
         for attr, value in instance.__dict__.items():
             # don't get the private properties
             if not str(attr).startswith("_"):
-                if value is not None:
+                if value is not None or include_none:
                     instance_dict[attr] = serialize_value(value)
 
         # Add properties
@@ -316,7 +345,7 @@ class DynamoDBSerializer:
                 # don't get the private properties
                 if not str(name).startswith("_"):
                     value = getattr(instance, name)
-                    if value is not None:
+                    if value is not None or include_none:
                         instance_dict[name] = serialize_value(value)
 
         return instance_dict

boto3_assist/dynamodb/dynamodb_reserved_words.py

@@ -44,4 +44,6 @@ class DynamoDBReservedWords:
             if self.is_reserved_word(item):
                 transformed_attributes["#" + item] = item
 
-        return transformed_attributes
+        if len(transformed_attributes) > 0:
+            return transformed_attributes
+        return None

boto3_assist/version.py

@@ -1 +1 @@
-__version__ = '0.1.7'
+__version__ = '0.1.9'

{boto3_assist-0.1.7.dist-info → boto3_assist-0.1.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: boto3_assist
-Version: 0.1.7
+Version: 0.1.9
 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.1.7.dist-info → boto3_assist-0.1.9.dist-info}/RECORD

@@ -1,7 +1,7 @@
 boto3_assist/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 boto3_assist/boto3session.py,sha256=J20E2lkqJOaey4Ohi-xRe2xABj7QsA8DrggzK29-5es,6415
 boto3_assist/connection_tracker.py,sha256=WYRdDSozJlxbFY_oYQAlGRpDgFWsF_nAiN7CIzh_yVo,2637
-boto3_assist/version.py,sha256=mFY0GwwuN-a3M8w93_mskS6GZIvv9SNdjLfJaWNsm-I,22
+boto3_assist/version.py,sha256=2uYVJ4eLF8kKOzfX6k2Go3u7xIwcGSuemAueAoXn-5o,22
 boto3_assist/dynamodb/dynamodb.py,sha256=vV0HvFCESnVK6BcAfcrWsMsNxIIsctvDX_3xdzOVCT0,14623
 boto3_assist/dynamodb/dynamodb_connection.py,sha256=JMCmWOsMzy45rikGl3Z2xqlG2vUTEKSYqi6dpsfJ750,4418
 boto3_assist/dynamodb/dynamodb_connection_tracker.py,sha256=nTNQ99sIidDoLMhMbBju2umgLmcttsmnvmd_DMy_J9M,1582
@@ -10,10 +10,10 @@ boto3_assist/dynamodb/dynamodb_importer.py,sha256=nCKsyRQeMqDSf0Q5mQ_X_oVIg4PRnu
 boto3_assist/dynamodb/dynamodb_index.py,sha256=LRQgSci222s-pU-JXgnaAoOa71ABX9h3uJPeCVPl1GE,6315
 boto3_assist/dynamodb/dynamodb_iservice.py,sha256=2AuaKxt7DUZbB-GpBBtPtPMpAlgZkumkAldm8vy7-sg,701
 boto3_assist/dynamodb/dynamodb_key.py,sha256=X3I3gUPx2T858vjRDi9SN8qn8ez5UJUo0vZiKBeeUWg,1776
-boto3_assist/dynamodb/dynamodb_model_base.py,sha256=KXsQ9E11o5mRPjD79qSsBp8ebee81-dLoFD0YGn2580,12561
+boto3_assist/dynamodb/dynamodb_model_base.py,sha256=5JRecZC9Cz8iJ5BZ4b2XhTEMclZB7pAnknrBNzZ3JS4,13350
 boto3_assist/dynamodb/dynamodb_model_base_interfaces.py,sha256=yT4zDRI8vP15WVOHnCvY3FsEy_QSIta5-bnUby70Xow,747
 boto3_assist/dynamodb/dynamodb_reindexer.py,sha256=_I-W7Ply-82fRHnhsRZuquRYxEIXubuWGq7E7B4Pa7I,6204
-boto3_assist/dynamodb/dynamodb_reserved_words.py,sha256=BwBA8i2Rtc9k-whyGBXZFEDAX2PpmydAbOhK31TwPSA,1718
+boto3_assist/dynamodb/dynamodb_reserved_words.py,sha256=iiud7ijpER5MgKHIP_NIgkDmHVy_57VRQzNHRipv0as,1786
 boto3_assist/dynamodb/dynamodb_reserved_words.txt,sha256=CanugFPh7rpgJ_jH9k4t8ANycrZJWTjT09sWiW4LC68,4137
 boto3_assist/dynamodb/readme.md,sha256=wNMzdRwk0qRV0kE88UUYnJos3pEK0HNjEIVkq2PATf8,1490
 boto3_assist/dynamodb/troubleshooting.md,sha256=uGpBaBUt_MyzjzwFOLOe0udTgcvaOpiTFxfj7ilLNkM,136
@@ -25,8 +25,8 @@ boto3_assist/utilities/datetime_utility.py,sha256=TbqGQkJDTahqvaZAIV550nhYnW1Bsq
 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/string_utility.py,sha256=w8l063UT3GE48tuJopETyZrjG4CgAzWkyDWMAYMg5Og,7432
-boto3_assist-0.1.7.dist-info/METADATA,sha256=LL3fZQnr7EtmQ_3FWWxv2hvxLY-c6oD2F5_cvP6hCp0,1804
-boto3_assist-0.1.7.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-boto3_assist-0.1.7.dist-info/licenses/LICENSE-EXPLAINED.txt,sha256=WFREvTpfTjPjDHpOLADxJpCKpIla3Ht87RUUGii4ODU,606
-boto3_assist-0.1.7.dist-info/licenses/LICENSE.txt,sha256=PXDhFWS5L5aOTkVhNvoitHKbAkgxqMI2uUPQyrnXGiI,1105
-boto3_assist-0.1.7.dist-info/RECORD,,
+boto3_assist-0.1.9.dist-info/METADATA,sha256=T9Z7AqJ3YXzOGdHxwdyccfyiCNf4sE7ZfiV6KZiXbFA,1804
+boto3_assist-0.1.9.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+boto3_assist-0.1.9.dist-info/licenses/LICENSE-EXPLAINED.txt,sha256=WFREvTpfTjPjDHpOLADxJpCKpIla3Ht87RUUGii4ODU,606
+boto3_assist-0.1.9.dist-info/licenses/LICENSE.txt,sha256=PXDhFWS5L5aOTkVhNvoitHKbAkgxqMI2uUPQyrnXGiI,1105
+boto3_assist-0.1.9.dist-info/RECORD,,