boto3-assist 0.22.0__py3-none-any.whl → 0.24.0__py3-none-any.whl

boto3_assist/dynamodb/dynamodb.py

@@ -355,7 +355,9 @@ class DynamoDB(DynamoDBConnection):
             key = key.key()
 
         kwargs: dict = {}
-        if index_name:
+
+        if index_name and index_name != "primary":
+            # only include the index_name if we are not using our "primary" pk/sk
             kwargs["IndexName"] = f"{index_name}"
         kwargs["TableName"] = f"{table_name}"
         kwargs["KeyConditionExpression"] = key

boto3_assist/dynamodb/dynamodb_index.py

@@ -37,7 +37,7 @@ class DynamoDBIndexes:
         if index.name in self.__indexes:
             raise ValueError(
                 f"The index {index.name} is already defined in your model somewhere. "
-                "This error is generated to protect you from unforseen issues. "
+                "This error is generated to protect you from unforeseen issues. "
                 "If you models are inheriting from other models, you may have the primary defined twice."
             )
 
@@ -64,7 +64,7 @@ class DynamoDBIndexes:
         for _, v in self.__indexes.items():
             if v.partition_key.attribute_name == index.partition_key.attribute_name:
                 raise ValueError(
-                    f"The attrubute {index.partition_key.attribute_name} is already being used by index "
+                    f"The attribute {index.partition_key.attribute_name} is already being used by index "
                     f"{v.name}. "
                     f"Reusing this attribute would over write the value on index {v.name}"
                 )
@@ -73,7 +73,7 @@ class DynamoDBIndexes:
             for _, v in self.__indexes.items():
                 if v.sort_key.attribute_name == index.sort_key.attribute_name:
                     raise ValueError(
-                        f"The attrubute {index.sort_key.attribute_name} is already being used by index "
+                        f"The attribute {index.sort_key.attribute_name} is already being used by index "
                         f"{v.name}. "
                         f"Reusing this attribute would over write the value on index {v.name}"
                     )
@@ -156,21 +156,13 @@ class DynamoDBIndex:
         condition: str = "begins_with",
         low_value: Any = None,
         high_value: Any = None,
+        query_key: bool = False,
         # sk_value_2: Optional[str | int | float] = None,
     ) -> dict | Key | ConditionBase | ComparisonCondition | Equals:
         """Get the key for a given index"""
         key: dict | Key | ConditionBase | ComparisonCondition | Equals
-        if self.name == DynamoDBIndexes.PRIMARY_INDEX and include_sort_key:
-            # this is a direct primary key which is used in a get call
-            # this is differenet than query keys
-            key = {}
-            key[self.partition_key.attribute_name] = self.partition_key.value
 
-            if self.sort_key and self.sort_key.attribute_name:
-                key[self.sort_key.attribute_name] = self.sort_key.value
-
-            return key
-        else:
+        if query_key:
             key = self._build_query_key(
                 include_sort_key=include_sort_key,
                 condition=condition,
@@ -179,6 +171,31 @@ class DynamoDBIndex:
             )
             return key
 
+        elif (
+            self.name == DynamoDBIndexes.PRIMARY_INDEX
+            and include_sort_key
+            # if it ends with a # we are assuming that we are doing a wild card mapping
+            and not str(self.sort_key.value).endswith("#")
+        ):
+            # this is a direct primary key which is used in a get call
+            # this is different than query keys
+            key = {}
+            key[self.partition_key.attribute_name] = self.partition_key.value
+
+            if self.sort_key and self.sort_key.attribute_name:
+                key[self.sort_key.attribute_name] = self.sort_key.value
+
+            return key
+
+        # catch all (TODO: decide if this is the best pattern or should we raise an error)
+        key = self._build_query_key(
+            include_sort_key=include_sort_key,
+            condition=condition,
+            low_value=low_value,
+            high_value=high_value,
+        )
+        return key
+
     def _build_query_key(
         self,
         *,

boto3_assist/dynamodb/dynamodb_model_base.py

@@ -21,6 +21,7 @@ from boto3_assist.dynamodb.dynamodb_index import (
 from boto3_assist.dynamodb.dynamodb_reserved_words import DynamoDBReservedWords
 from boto3_assist.utilities.datetime_utility import DatetimeUtility
 from boto3_assist.models.serializable_model import SerializableModel
+from boto3_assist.utilities.string_utility import StringUtility
 
 
 def exclude_from_serialization(method):
@@ -190,7 +191,7 @@ class DynamoDBModelBase(SerializableModel):
     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.
+        Useful 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(
@@ -205,6 +206,13 @@ class DynamoDBModelBase(SerializableModel):
 
         return self.indexes.get(index_name)
 
+    @staticmethod
+    def generate_uuid(sortable: bool = True) -> str:
+        if sortable:
+            return StringUtility.generate_sortable_uuid()
+
+        return StringUtility.generate_uuid()
+
     @property
     @exclude_from_serialization
     def helpers(self) -> DynamoDBHelpers:

boto3_assist/version.py

@@ -1 +1 @@
-__version__ = '0.22.0'
+__version__ = '0.24.0'

{boto3_assist-0.22.0.dist-info → boto3_assist-0.24.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: boto3_assist
-Version: 0.22.0
+Version: 0.24.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
@@ -32,7 +32,7 @@ Description-Content-Type: text/markdown
 
 This is in beta and subject to changes before it's initial 1.0.0 release
 
-This libary was created to make life a little easier when using boto3.
+This library was created to make life a little easier when using boto3.
 
 Currently it supports:
 - User Authentication / Session Mapping
@@ -40,11 +40,11 @@ Currently it supports:
 
 
 ## User Authentication / Session Mapping
-Have you ever needed an easy way to load your sessions for a local, dev or production enviroment? Well this library
+Have you ever needed an easy way to load your sessions for a local, dev or production environment? Well this library
 makes it a little easier by lazy loading your boto3 session so that tools like `python-dotenv` can be used to load your
 environment vars first and then load your session.
 
-## DyamoDB model mapping and Key Generation
+## DynamoDB model mapping and Key Generation
 It's a light weight mapping tool to turn your python classes / object models to DynamoDB items that are ready
 for saving.  See the [examples](https://github.com/geekcafe/boto3-assist/tree/main/examples) directory in the repo for more information.
 
@@ -61,7 +61,7 @@ pip install boto3-assist
 ## Running Unit Tests
 Several of our tests use a mocking library to simulate connections to S3, DynamoDB, etc.  In order to use those tests, you will need to have a `.env.unittest` file at the root of this project (which our tests will attempt to locate and load).  
 
-For your convenince the `.evn.unittest` file has been added to this project.  The values should not point to live AWS profiles, instead it should use the values added.
+For your convenience the `.evn.unittest` file has been added to this project.  The values should not point to live AWS profiles, instead it should use the values added.
 
 Since we also point to a profile, you should create the profile in the `~/.aws/config` file.  The entry should look like the following:
 

{boto3_assist-0.22.0.dist-info → boto3_assist-0.24.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=h1iZs_ySY6is5xPKVypDpl9q8RFwvTXfv3Urt9ZSKSQ,23
+boto3_assist/version.py,sha256=lbgaUA9yL_X3wnFgvRc5nIlmJ4gFm6Ala6TbPHN-5aY,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
@@ -19,14 +19,14 @@ boto3_assist/cognito/cognito_connection.py,sha256=deuXR3cNHz0mCYff2k0LfAvK--9Okq
 boto3_assist/cognito/cognito_utility.py,sha256=IVZAg58nHG1U7uxe7FsTYpqwwZiwwdIBGiVTZuLCFqg,18417
 boto3_assist/cognito/jwks_cache.py,sha256=1Y9r-YfQ8qrgZN5xYPvjUEEV0vthbdcPdAIaPbZP7kU,373
 boto3_assist/cognito/user.py,sha256=qc44qLx3gwq6q2zMxcPQze1EjeZwy5Kuav93vbe-4WU,820
-boto3_assist/dynamodb/dynamodb.py,sha256=2Xg9_aqcXzZm-4hASt6Z-mCR0gSs6iUDzLdAqzPn81o,18370
+boto3_assist/dynamodb/dynamodb.py,sha256=aW6kWq-Hcc6idmuFygdpUyPusPHsIvVGq2hiG8n8gBo,18481
 boto3_assist/dynamodb/dynamodb_connection.py,sha256=D4KmVpMpE0OuVOwW5g4JBWllUNkwy0hMXEGUiToAMBc,3608
 boto3_assist/dynamodb/dynamodb_helpers.py,sha256=RoRRqKjdwfC-2-gvlkLvCoNWhIoMrHm-68dkyhXI_Xk,12080
 boto3_assist/dynamodb/dynamodb_importer.py,sha256=nCKsyRQeMqDSf0Q5mQ_X_oVIg4PRnu0hcUzZnBli610,3471
-boto3_assist/dynamodb/dynamodb_index.py,sha256=D0Lq121qk1cXeMetPeqnzvv6CXd0XfEygfdUXaljLG8,8551
+boto3_assist/dynamodb/dynamodb_index.py,sha256=EhLvaLQznrsbP1b8LRHDnPSUxou_JYn0fYYRLhvH26U,9085
 boto3_assist/dynamodb/dynamodb_iservice.py,sha256=O9Aj0PFEvcuk2vhARifWTFnUwcQW5EXzwZS478Hm-N0,796
 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.py,sha256=Bgnjs62lHTqqJ2nZbPV1JHvcK6d2-aaRsJtcc8DEqKk,12291
 boto3_assist/dynamodb/dynamodb_model_base_interfaces.py,sha256=SFw-yK7TDPL4cK52bpn2zMm5G4mX7eYNU7eFytEw0-A,749
 boto3_assist/dynamodb/dynamodb_re_indexer.py,sha256=Y0qRrvpmjS68w8ci6Au7Hg02W_ktqhUGGALeN-9XTls,6164
 boto3_assist/dynamodb/dynamodb_reindexer.py,sha256=bCj6KIU0fQOgjkkiq9yF51PFZZr4Y9Lu3-hPlmsPG0Y,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.22.0.dist-info/METADATA,sha256=fvChz9xIsO1PiE8HD8zzg4m1FMytpFhDJJMJcM6BKWw,2875
-boto3_assist-0.22.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-boto3_assist-0.22.0.dist-info/licenses/LICENSE-EXPLAINED.txt,sha256=WFREvTpfTjPjDHpOLADxJpCKpIla3Ht87RUUGii4ODU,606
-boto3_assist-0.22.0.dist-info/licenses/LICENSE.txt,sha256=PXDhFWS5L5aOTkVhNvoitHKbAkgxqMI2uUPQyrnXGiI,1105
-boto3_assist-0.22.0.dist-info/RECORD,,
+boto3_assist-0.24.0.dist-info/METADATA,sha256=yWQTff8EmXgeFxcFGHTq1DbzD-bhAUArD3CCOjz3BYk,2879
+boto3_assist-0.24.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+boto3_assist-0.24.0.dist-info/licenses/LICENSE-EXPLAINED.txt,sha256=WFREvTpfTjPjDHpOLADxJpCKpIla3Ht87RUUGii4ODU,606
+boto3_assist-0.24.0.dist-info/licenses/LICENSE.txt,sha256=PXDhFWS5L5aOTkVhNvoitHKbAkgxqMI2uUPQyrnXGiI,1105
+boto3_assist-0.24.0.dist-info/RECORD,,