boto3-assist 0.1.13__tar.gz → 0.1.14__tar.gz

{boto3_assist-0.1.13 → boto3_assist-0.1.14}/PKG-INFO

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

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

{boto3_assist-0.1.13 → boto3_assist-0.1.14}/src/boto3_assist/dynamodb/dynamodb_key.py

@@ -59,4 +59,6 @@ class DynamoDBKey:
                 break
             else:
                 parts.append(f"{prefix}{value}")
-        return "#".join(parts)
+        key_str = "#".join(parts)
+
+        return key_str

{boto3_assist-0.1.13 → boto3_assist-0.1.14}/src/boto3_assist/dynamodb/dynamodb_model_base.py

@@ -64,13 +64,21 @@ class DynamoDBModelBase:
     @exclude_from_serialization
     def projection_expression(self) -> str | None:
         """Gets the projection expression"""
+        prop_list: List[str] = []
         if self.__projection_expression is None and self.auto_generate_projections:
             props = self.to_dictionary()
             # turn props to a list[str]
             prop_list = list(props.keys())
+        else:
+            if self.__projection_expression:
+                prop_list = self.__projection_expression.split(",")
+                prop_list = [p.strip() for p in prop_list]
+
+        if len(prop_list) == 0:
+            return None
 
-            transformed_list = self.__reserved_words.tranform_projections(prop_list)
-            self.projection_expression = ",".join(transformed_list)
+        transformed_list = self.__reserved_words.tranform_projections(prop_list)
+        self.projection_expression = ",".join(transformed_list)
 
         return self.__projection_expression
 
@@ -105,6 +113,12 @@ class DynamoDBModelBase:
             self.projection_expression_attribute_names = (
                 self.__reserved_words.transform_attributes(prop_list)
             )
+        else:
+            if self.projection_expression:
+                expression_list = self.projection_expression.replace("#", "").split(",")
+                self.projection_expression_attribute_names = (
+                    self.__reserved_words.transform_attributes(expression_list)
+                )
 
         return self.__projection_expression_attribute_names
 
@@ -325,6 +339,8 @@ class DynamoDBSerializer:
 
         # Add instance variables
         for attr, value in instance.__dict__.items():
+            if str(attr) == "T":
+                continue
             # don't get the private properties
             if not str(attr).startswith("_"):
                 if value is not None or include_none:
@@ -346,6 +362,10 @@ class DynamoDBSerializer:
                 if exclude:
                     continue
 
+                # Skip TypeVar T or instances of DynamoDBModelBase
+                if str(name) == "T":
+                    continue
+
                 # don't get the private properties
                 if not str(name).startswith("_"):
                     value = getattr(instance, name)

{boto3_assist-0.1.13 → boto3_assist-0.1.14}/src/boto3_assist/dynamodb/dynamodb_reserved_words.py

@@ -31,7 +31,7 @@ class DynamoDBReservedWords:
         if isinstance(projections, str):
             projections = projections.split(",")
 
-        # any project that exists add a # infront of it
+        # any projection that exists add a # infront of it
         projections = ["#" + p if self.is_reserved_word(p) else p for p in projections]
         return projections
 

boto3_assist-0.1.14/src/boto3_assist/version.py

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

{boto3_assist-0.1.13 → boto3_assist-0.1.14}/tests/dynamodb/dynamodb_model_base_test.py

@@ -155,6 +155,8 @@ class DynamoDBModelUnitTest(unittest.TestCase):
         self.assertEqual(keys[2].partition_key.value, "users#")
         self.assertEqual(keys[2].sort_key.attribute_name, "gsi1_sk")
         self.assertEqual(keys[2].sort_key.value, "lastname#")
+        expression = user.helpers.get_filter_expressions(keys[2].key())
+        print(f"expression: {expression}")
 
         self.assertEqual(keys[3].partition_key.attribute_name, "gsi2_pk")
         self.assertEqual(keys[3].partition_key.value, "users#")
@@ -195,3 +197,35 @@ class DynamoDBModelUnitTest(unittest.TestCase):
         self.assertEqual(dictionary.get("gsi2_sk"), "firstname#John#lastname#Smith")
 
         print("stop")
+
+    def test_key_dictionary_key_gen(self):
+        """Test Listing Keys"""
+        # Arrange
+        data = {
+            "id": "123456",
+            "first_name": "John",
+            "age": 30,
+            "email": "john@example.com",
+        }
+
+        # Act
+        user: User = User().map(data)
+        keys: List[DynamoDBKey] = user.list_keys()
+
+        self.assertEqual(len(keys), 4)
+
+        dictionary = user.helpers.keys_to_dictionary(keys=keys)
+
+        self.assertEqual(dictionary.get("pk"), "user#123456")
+        self.assertEqual(dictionary.get("sk"), "user#123456")
+
+        self.assertEqual(dictionary.get("gsi0_pk"), "users#")
+        self.assertEqual(dictionary.get("gsi0_sk"), "email#john@example.com")
+
+        self.assertEqual(dictionary.get("gsi1_pk"), "users#")
+        self.assertEqual(dictionary.get("gsi1_sk"), "lastname#")
+
+        self.assertEqual(dictionary.get("gsi2_pk"), "users#")
+        self.assertEqual(dictionary.get("gsi2_sk"), "firstname#John#lastname#")
+
+        print("stop")

{boto3_assist-0.1.13 → boto3_assist-0.1.14}/tests/dynamodb/dynamodb_model_projections_test.py

@@ -82,6 +82,7 @@ class DynamoDBModeProjectionlUnitTest(unittest.TestCase):
         self.assertIsNone(attribute_names)
 
     def test_user_model_and_nulls(self):
+        """Test nulls"""
         model: User = User()
         model.first_name = "John"
 
@@ -91,6 +92,7 @@ class DynamoDBModeProjectionlUnitTest(unittest.TestCase):
         self.assertIn("id", expressions)
 
     def test_user_limited_projections(self):
+        """Test limited projections"""
         model: User = User()
         model.first_name = "John"
 
@@ -107,3 +109,23 @@ class DynamoDBModeProjectionlUnitTest(unittest.TestCase):
         self.assertNotIn("email", expressions)
         self.assertNotIn("status", expressions)
         self.assertIsNone(attributes)
+
+    def test_user_limited_reserved_projections(self):
+        """Test reserved word addition."""
+        model: User = User()
+        model.first_name = "John"
+
+        model.projection_expression = "id,status"
+        # model.projection_expression_attribute_names = None
+        model.auto_generate_projections = False
+        expressions = model.projection_expression
+        attributes = model.projection_expression_attribute_names
+        self.assertIsInstance(expressions, str)
+
+        self.assertIn("id", expressions)
+        self.assertNotIn("first_name", expressions)
+        self.assertNotIn("age", expressions)
+        self.assertNotIn("email", expressions)
+        self.assertIn("#status", expressions)
+        # self.assertIsNone(attributes)
+        self.assertIn("#status", attributes)

boto3_assist-0.1.14/tests/dynamodb/dynamodb_model_serializtion_test.py

@@ -0,0 +1,51 @@
+"""
+Geek Cafe, LLC
+Maintainers: Eric Wilson
+MIT License.  See Project Root for the license information.
+"""
+
+import unittest
+from typing import List, Dict
+
+
+from tests.dynamodb.models.user_model import User
+
+
+class DynamoDBModelSerializationUnitTest(unittest.TestCase):
+    "Serialization Tests"
+
+    def test_basic_serialization(self):
+        """Test Basic Serlization"""
+        # Arrange
+        data = {
+            "id": "123456",
+            "first_name": "John",
+            "age": 30,
+            "email": "john@example.com",
+        }
+
+        # Act
+        serialized_data: User = User().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, User)
+
+        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.1.13 → boto3_assist-0.1.14}/tests/dynamodb/models/user_model.py

@@ -4,11 +4,11 @@ Maintainers: Eric Wilson
 MIT License.  See Project Root for the license information.
 """
 
-from typing import Optional, List, Dict
+from typing import Optional
 
-from src.boto3_assist.dynamodb.dynamodb_model_base import DynamoDBModelBase
+from boto3_assist.dynamodb.dynamodb_model_base import DynamoDBModelBase
 from boto3_assist.dynamodb.dynamodb_index import DynamoDBIndex
-from src.boto3_assist.dynamodb.dynamodb_key import DynamoDBKey
+from boto3_assist.dynamodb.dynamodb_key import DynamoDBKey
 
 
 class User(DynamoDBModelBase):
@@ -18,7 +18,7 @@ class User(DynamoDBModelBase):
         self,
         id: Optional[str] = None,  # pylint: disable=redefined-builtin
     ):
-        DynamoDBModelBase.__init__(self)
+        super().__init__(self)
         self.id: Optional[str] = id
         self.first_name: Optional[str] = None
         self.last_name: Optional[str] = None

boto3_assist-0.1.13/src/boto3_assist/version.py

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