boto3-assist 0.20.0__py3-none-any.whl → 0.21.0__py3-none-any.whl

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

@@ -1 +1 @@
-__version__ = '0.20.0'
+__version__ = '0.21.0'

{boto3_assist-0.20.0.dist-info → boto3_assist-0.21.0.dist-info}/METADATA

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

@@ -6,7 +6,7 @@ boto3_assist/connection_tracker.py,sha256=UgfR9RlvXf3A4ssMr3gDMpw89ka8mSRvJn4M34
 boto3_assist/http_status_codes.py,sha256=G0zRSWenwavYKETvDF9tNVUXQz3Ae2gXdBETYbjvJe8,3284
 boto3_assist/role_assumption_mixin.py,sha256=PMUU5yC2FUBjFD1UokVkRY3CPB5zTw85AhIB5BMtbc8,1031
 boto3_assist/session_setup_mixin.py,sha256=X-JQKyyaWNA8Z8kKgf2V2I5vsiLAH8udLTX_xepnsdQ,3140
-boto3_assist/version.py,sha256=pJLteH9r0aOnAwnvPatmr2QSz7lO2BDXON0AKkXx0Pg,23
+boto3_assist/version.py,sha256=UAuTYiKF41yTa-lG-LD9UUArhXc4aZ6bJs_6sGq2BuU,23
 boto3_assist/aws_lambda/event_info.py,sha256=OkZ4WzuGaHEu_T8sB188KBgShAJhZpWASALKRGBOhMg,14648
 boto3_assist/aws_lambda/mock_context.py,sha256=LPjHP-3YSoY6iPl1kPqJDwSVf1zLNTcukUunDtYcbK0,116
 boto3_assist/cloudwatch/cloudwatch_connection.py,sha256=mnGWaLSQpHh5EeY7Ek_2o9JKHJxOELIYtQVMX1IaHn4,2480
@@ -25,7 +25,7 @@ boto3_assist/dynamodb/dynamodb_helpers.py,sha256=RoRRqKjdwfC-2-gvlkLvCoNWhIoMrHm
 boto3_assist/dynamodb/dynamodb_importer.py,sha256=nCKsyRQeMqDSf0Q5mQ_X_oVIg4PRnu0hcUzZnBli610,3471
 boto3_assist/dynamodb/dynamodb_index.py,sha256=D0Lq121qk1cXeMetPeqnzvv6CXd0XfEygfdUXaljLG8,8551
 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_key.py,sha256=4IYnG4a99AjdOKUcDaWhNF_lvZJRZcKOIPzBQQzVdB0,3294
 boto3_assist/dynamodb/dynamodb_model_base.py,sha256=ceVKmequ2S7zY-8IkQwmtNvGV8GtaEraFBy1c2Y5P4A,12031
 boto3_assist/dynamodb/dynamodb_model_base_interfaces.py,sha256=yT4zDRI8vP15WVOHnCvY3FsEy_QSIta5-bnUby70Xow,747
 boto3_assist/dynamodb/dynamodb_re_indexer.py,sha256=Y0qRrvpmjS68w8ci6Au7Hg02W_ktqhUGGALeN-9XTls,6164
@@ -57,8 +57,8 @@ boto3_assist/utilities/logging_utility.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5N
 boto3_assist/utilities/numbers_utility.py,sha256=wzv9d0uXT_2_ZHHio7LBzibwxPqhGpvbq9HinrVn_4A,10160
 boto3_assist/utilities/serialization_utility.py,sha256=Jc6H0cpcZjLO7tdyUZdBWHzItduLkw6sh2YQh8Hc8D8,21647
 boto3_assist/utilities/string_utility.py,sha256=XxUIz19L2LFFTRDAAmdPa8Qhn40u9yO7g4nULFuvg0M,11033
-boto3_assist-0.20.0.dist-info/METADATA,sha256=fTDDcy1YzJ4vDZFqic4B1-veECbBopRgj9Yyj0FTeEI,2875
-boto3_assist-0.20.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-boto3_assist-0.20.0.dist-info/licenses/LICENSE-EXPLAINED.txt,sha256=WFREvTpfTjPjDHpOLADxJpCKpIla3Ht87RUUGii4ODU,606
-boto3_assist-0.20.0.dist-info/licenses/LICENSE.txt,sha256=PXDhFWS5L5aOTkVhNvoitHKbAkgxqMI2uUPQyrnXGiI,1105
-boto3_assist-0.20.0.dist-info/RECORD,,
+boto3_assist-0.21.0.dist-info/METADATA,sha256=jg5TRMDh2xJnT8enHHUVuxET9Ohz0BHTrf9aR57oZwo,2875
+boto3_assist-0.21.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+boto3_assist-0.21.0.dist-info/licenses/LICENSE-EXPLAINED.txt,sha256=WFREvTpfTjPjDHpOLADxJpCKpIla3Ht87RUUGii4ODU,606
+boto3_assist-0.21.0.dist-info/licenses/LICENSE.txt,sha256=PXDhFWS5L5aOTkVhNvoitHKbAkgxqMI2uUPQyrnXGiI,1105
+boto3_assist-0.21.0.dist-info/RECORD,,