boto3-assist 0.1.6__tar.gz → 0.1.8__tar.gz

{boto3_assist-0.1.6 → boto3_assist-0.1.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: boto3_assist
-Version: 0.1.6
+Version: 0.1.8
 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.6 → boto3_assist-0.1.8}/pyproject.toml

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

{boto3_assist-0.1.6 → boto3_assist-0.1.8}/src/boto3_assist/dynamodb/dynamodb_model_base.py

@@ -48,7 +48,7 @@ class DynamoDBModelBase:
         self.__helpers: DynamoDBHelpers | None = None
         self.__indexes: DynamoDBIndexes | None = None
         self.__reserved_words: DynamoDBReservedWords = DynamoDBReservedWords()
-        self.auto_generate_projections: bool = auto_generate_projections
+        self.__auto_generate_projections: bool = auto_generate_projections
 
     @property
     @exclude_from_serialization
@@ -74,6 +74,12 @@ class DynamoDBModelBase:
 
         return self.__projection_expression
 
+    @property
+    @exclude_from_serialization
+    def auto_generate_projections(self) -> bool:
+        """Gets the auto generate projections"""
+        return self.__auto_generate_projections
+
     @projection_expression.setter
     def projection_expression(self, value: str | None):
         self.__projection_expression = value

{boto3_assist-0.1.6 → boto3_assist-0.1.8}/src/boto3_assist/dynamodb/dynamodb_reserved_words.py

@@ -35,11 +35,15 @@ class DynamoDBReservedWords:
         projections = ["#" + p if self.is_reserved_word(p) else p for p in projections]
         return projections
 
-    def transform_attributes(self, attributes: dict) -> dict:
+    def transform_attributes(self, projections: List[str] | str) -> dict:
         """Transforms a dict of attributes to remove reserved words"""
         transformed_attributes: dict | None = {}
-        for k, v in attributes.items():
-            if self.is_reserved_word(k):
-                transformed_attributes["#" + k] = v
+        if isinstance(projections, str):
+            projections = projections.split(",")
+        for item in projections:
+            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-0.1.8/src/boto3_assist/version.py

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

{boto3_assist-0.1.6 → boto3_assist-0.1.8}/tests/dynamodb/dynamodb_model_projections_test.py

@@ -8,6 +8,7 @@ import unittest
 
 
 from tests.dynamodb.models.user_model import User
+from tests.dynamodb.models.simple_model import Simple
 
 
 class DynamoDBModeProjectionlUnitTest(unittest.TestCase):
@@ -40,17 +41,42 @@ class DynamoDBModeProjectionlUnitTest(unittest.TestCase):
         expressions = model.projection_expression
         self.assertIsInstance(expressions, str)
 
-        # #type is in expression
-        self.assertIn("#type", expressions)
         self.assertIn("#status", expressions)
 
         print(expressions)
 
         attribute_names = model.projection_expression_attribute_names
         self.assertIsInstance(attribute_names, dict)
-        self.assertIn("#type", attribute_names)
+
         self.assertIn("#status", attribute_names)
 
-        # "#type": "type" is in the  dictionary
-        self.assertIn("type", attribute_names["#type"])
         self.assertIn("status", attribute_names["#status"])
+
+    def test_simple_model(self):
+        """Test Basic Serlization"""
+        # Arrange
+        data = {
+            "id": "123456",
+        }
+
+        # Act
+        model: Simple = Simple().map(data)
+
+        # Assert
+
+        self.assertEqual(model.id, "123456")
+
+        self.assertIsInstance(model, Simple)
+
+        key = model.indexes.primary.key()
+        self.assertIsInstance(key, dict)
+
+        expressions = model.projection_expression
+        self.assertIsInstance(expressions, str)
+
+        self.assertIn("id", expressions)
+
+        print(expressions)
+
+        attribute_names = model.projection_expression_attribute_names
+        self.assertIsNone(attribute_names)

boto3_assist-0.1.8/tests/dynamodb/models/simple_model.py

@@ -0,0 +1,38 @@
+"""
+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 Simple(DynamoDBModelBase):
+    """User Model"""
+
+    def __init__(
+        self,
+        id: Optional[str] = None,  # pylint: disable=redefined-builtin
+    ):
+        DynamoDBModelBase.__init__(self)
+        self.id: Optional[str] = id
+
+        self.__setup_indexes()
+
+    def __setup_indexes(self):
+        primary_key: DynamoDBIndex = DynamoDBIndex(
+            index_name="primary_key",
+            partition_key=DynamoDBKey(
+                attribute_name="pk",
+                value=lambda: DynamoDBKey.build_key((("user", self.id))),
+            ),
+            sort_key=DynamoDBKey(
+                attribute_name="sk",
+                value=lambda: DynamoDBKey.build_key(("user", self.id)),
+            ),
+        )
+        self.indexes.add_primary(primary_key)

{boto3_assist-0.1.6 → boto3_assist-0.1.8}/tests/dynamodb/models/user_model.py

@@ -77,13 +77,3 @@ class User(DynamoDBModelBase):
         )
 
         self.indexes.add_secondary(gsi2)
-
-        # self.key_configs = key_configs
-        self.projection_expression = (
-            "id,first_name,last_name,email,tenant_id,#type,#status,"
-            "company_name,authorization,modified_datetime_utc"
-        )
-        self.projection_expression_attribute_names = {
-            "#status": "status",
-            "#type": "type",
-        }

boto3_assist-0.1.6/src/boto3_assist/version.py

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