boto3-assist 0.20.0__tar.gz → 0.21.0__tar.gz

{boto3_assist-0.20.0 → boto3_assist-0.21.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: boto3_assist
-Version: 0.20.0
+Version: 0.21.0
 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.20.0 → boto3_assist-0.21.0}/pyproject.toml

@@ -15,7 +15,7 @@ addopts = "-m 'not integration'"
 
 [project]
 name = "boto3_assist"
-version = "0.20.0"
+version = "0.21.0"
 
 authors = [
   { name="Eric Wilson", email="boto3-assist@geekcafe.com" }

{boto3_assist-0.20.0 → boto3_assist-0.21.0}/src/boto3_assist/dynamodb/dynamodb_key.py

@@ -49,7 +49,52 @@ class DynamoDBKey:
     def build_key(*key_value_pairs) -> str:
         """
         Static method to build a key based on provided key-value pairs.
-        Stops appending if any value is None.
+        - Stops appending if any value is None.
+        - However a value of "" (empty string) will continue the chain.
+
+        Example:
+            gsi.partition_key.value = lambda: DynamoDBKey.build_key(
+                ("user",self.model.user_id)
+            )
+
+            pk: user#<user-id>
+            pk: user#123456789
+
+            gsi.sort_key.value = lambda: DynamoDBKey.build_key(
+                ("xref", self.model.xref_type),
+                ("id", self.model.xref_pk),
+
+            )
+
+            sk: xref#<xref-type>#id#<some-id>
+            sk: xref#task#id#123456789
+
+            # example two has a leading "domain" (crm)
+            gsi.sort_key.value = lambda: DynamoDBKey.build_key(
+                ("crm", "")
+                ("xref", self.model.xref_type),
+                ("id", self.model.xref_pk),
+
+            )
+
+            sk: crm#xref#<xref-type>#id#<some-id>
+            sk: crm#xref#task#id#123456789
+
+            # using None stops the key build
+            # useful when doing begins with
+
+            # assume self.model.xref_pk is None
+            gsi.sort_key.value = lambda: DynamoDBKey.build_key(
+                ("xref", self.model.xref_type),
+                ("id", self.model.xref_pk),
+
+            )
+            # results with a key of
+            # which would get all of the users tasks assuming the pk was still
+            # the same
+            sk: xref#<xref-type>#id#
+            sk: xref#task#id#
+
         """
         parts = []
         for key, value in key_value_pairs:
@@ -57,6 +102,8 @@ class DynamoDBKey:
             if value is None:
                 parts.append(f"{prefix}")
                 break
+            elif len(str(value).strip()) == 0:
+                parts.append(f"{key}")
             else:
                 parts.append(f"{prefix}{value}")
         key_str = "#".join(parts)

boto3_assist-0.21.0/src/boto3_assist/version.py

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

boto3_assist-0.20.0/src/boto3_assist/version.py

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