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

boto3_assist/dynamodb/dynamodb.py

@@ -15,11 +15,11 @@ from boto3.dynamodb.conditions import (
     ComparisonCondition,
     ConditionBase,
 )
-from boto3_assist.dynamodb.dynamodb_connection import DynamoDBConnection
-from boto3_assist.dynamodb.dynamodb_helpers import DynamoDBHelpers
-from boto3_assist.dynamodb.dynamodb_model_base import DynamoDBModelBase
-from boto3_assist.utilities.string_utility import StringUtility
-
+from .dynamodb_connection import DynamoDBConnection
+from .dynamodb_helpers import DynamoDBHelpers
+from .dynamodb_model_base import DynamoDBModelBase
+from ..utilities.string_utility import StringUtility
+from .dynamodb_index import DynamoDBIndex
 
 logger = Logger()
 
@@ -69,9 +69,9 @@ class DynamoDB(DynamoDBConnection):
         """
         Save an item to the database
         Args:
-            item (dict): DynamoDB Dictionay Object or DynamoDBModelBase.  Supports the "client" or
+            item (dict): DynamoDB Dictionary Object or DynamoDBModelBase.  Supports the "client" or
             "resource" syntax
-            table_name (str): The DyamoDb Table Name
+            table_name (str): The DynamoDb Table Name
             source (str, optional): The source of the call, used for logging. Defaults to None.
 
         Raises:
@@ -98,7 +98,7 @@ class DynamoDB(DynamoDBConnection):
                 except Exception as e:  # pylint: disable=w0718
                     logger.exception(e)
                     raise RuntimeError(
-                        "An error occured during model converation.  The entry was not saved. "
+                        "An error occurred during model conversion.  The entry was not saved. "
                     ) from e
 
             if isinstance(item, dict):
@@ -279,11 +279,11 @@ class DynamoDB(DynamoDBConnection):
 
     def query(
         self,
-        key: dict | Key | ConditionBase | ComparisonCondition,
+        key: dict | Key | ConditionBase | ComparisonCondition | DynamoDBIndex,
+        table_name: str,
         *,
         index_name: Optional[str] = None,
         ascending: bool = False,
-        table_name: Optional[str] = None,
         source: Optional[str] = None,
         strongly_consistent: bool = False,
         projection_expression: Optional[str] = None,
@@ -305,6 +305,17 @@ class DynamoDB(DynamoDBConnection):
         """
 
         logger.debug({"action": "query", "source": source})
+        if not key:
+            raise ValueError("Query failed: key must be provided.")
+
+        if not table_name:
+            raise ValueError("Query failed: table_name must be provided.")
+
+        if isinstance(key, DynamoDBIndex):
+            if not index_name:
+                index_name = key.name
+            # turn it into a key expected by dynamodb
+            key = key.key()
 
         kwargs: dict = {}
         if index_name:
@@ -330,7 +341,16 @@ class DynamoDB(DynamoDBConnection):
             raise ValueError("Query failed: table_name must be provided.")
 
         table = self.dynamodb_resource.Table(table_name)
-        response = dict(table.query(**kwargs))
+        response: dict = {}
+        try:
+            response = dict(table.query(**kwargs))
+        except Exception as e:  # pylint: disable=w0718
+            logger.exception(
+                {"source": f"{source}", "metric_filter": "query", "error": str(e)}
+            )
+            response = {"exception": str(e)}
+            if self.raise_on_error:
+                raise e
 
         return response
 

boto3_assist/dynamodb/dynamodb_model_base.py

@@ -40,7 +40,7 @@ def exclude_indexes_from_serialization(method):
 
 
 class DynamoDBModelBase(SerializableModel):
-    """DyanmoDb Model Base"""
+    """DynamoDb Model Base"""
 
     T = TypeVar("T", bound="DynamoDBModelBase")
 
@@ -53,6 +53,9 @@ class DynamoDBModelBase(SerializableModel):
         self.__auto_generate_projections: bool = auto_generate_projections
         self.__actively_serializing_data__: bool = False
 
+    def serialization_in_progress(self) -> bool:
+        return self.__actively_serializing_data__
+
     @property
     @exclude_from_serialization
     def indexes(self) -> DynamoDBIndexes:

boto3_assist/dynamodb/dynamodb_re_indexer.py

@@ -0,0 +1,165 @@
+"""
+Geek Cafe, LLC
+Maintainers: Eric Wilson
+MIT License.  See Project Root for the license information.
+"""
+
+import json
+from typing import Any, Dict, Optional, List, Type
+from aws_lambda_powertools import Logger
+from boto3_assist.dynamodb.dynamodb import DynamoDB
+from boto3_assist.dynamodb.dynamodb_model_base import DynamoDBModelBase
+from boto3_assist.utilities.serialization_utility import Serialization
+from boto3_assist.dynamodb.dynamodb_index import DynamoDBIndex
+from boto3_assist.dynamodb.dynamodb_iservice import IDynamoDBService
+
+logger = Logger()
+
+
+class DynamoDBReIndexer:
+    """ReIndexing your database"""
+
+    def __init__(
+        self,
+        table_name: str,
+        *,
+        db: Optional[DynamoDB] = None,
+        aws_profile: Optional[str] = None,
+        aws_region: Optional[str] = None,
+        aws_end_point_url: Optional[str] = None,
+        aws_access_key_id: Optional[str] = None,
+        aws_secret_access_key: Optional[str] = None,
+    ):
+        self.table_name = table_name
+        self.db: DynamoDB = db or DynamoDB(
+            aws_profile=aws_profile,
+            aws_region=aws_region,
+            aws_end_point_url=aws_end_point_url,
+            aws_access_key_id=aws_access_key_id,
+            aws_secret_access_key=aws_secret_access_key,
+        )
+
+    def reindex_item(
+        self,
+        original_primary_key: dict,
+        model: DynamoDBModelBase,
+        *,
+        dry_run: bool = False,
+        inplace: bool = True,
+        leave_original_record: bool = False,
+        service_cls: Type[IDynamoDBService] | None,
+    ):
+        """
+        Reindex the record
+
+        Args:
+            original_primary_key (dict): The original primary key of the record to be reindexed.
+                This is either the partition_key or a composite key (partition_key, sort_key)
+            model (DynamoDBModelBase): A model instance that will be used to serialize the new keys
+                into a dictionary. It must inherit from DynamoDBModelBase
+
+            dry_run (bool, optional): Ability to log the actions without executing them. Defaults to False.
+            inplace (bool, optional): Ability to just update the indexes only.
+                No other fields will be updated, however you can't update the primary_key (partition/sort key)
+                with this action since they are immutable.
+                Defaults to True.
+            leave_original_record (bool, optional): _description_. Defaults to False.
+        """
+
+        if inplace:
+            keys: List[DynamoDBIndex] = model.list_keys()
+            # Update the item in DynamoDB with new keys
+            self.update_item_in_dynamodb(
+                original_primary_key=original_primary_key, keys=keys, dry_run=dry_run
+            )
+            # todo: add some additional error handling here and throw a more
+            # descriptive error if they try to use a different primary
+            # pk or sk, which you can't do.  If that's the case
+        else:
+            # add the new one first and optionally delete the older one
+            # once we are succesfull
+            try:
+                # save the new one first
+                service_instance: Optional[IDynamoDBService] = (
+                    service_cls(db=self.db) if callable(service_cls) else None
+                )
+
+                if service_instance:
+                    service_instance.save(model=model)
+                else:
+                    self.db.save(
+                        item=model, table_name=self.table_name, source="reindex"
+                    )
+
+                # then delete the old on
+                if not leave_original_record:
+                    self.db.delete(
+                        table_name=self.table_name, primary_key=original_primary_key
+                    )
+            except Exception as e:  # pylint: disable=broad-except
+                logger.error(str(e))
+                raise RuntimeError(str(e)) from e
+            # this gets a little more trick as we need to delete the item
+
+    def load_model(
+        self, db_item: dict, db_model: DynamoDBModelBase
+    ) -> DynamoDBModelBase | None:
+        """load the model which will serialze the dynamodb dictionary to an instance of an object"""
+
+        base_model = Serialization.map(db_item, db_model)
+        return base_model
+
+    def update_item_in_dynamodb(
+        self,
+        original_primary_key: dict,
+        keys: List[DynamoDBIndex],
+        dry_run: bool = False,
+    ):
+        """Update the dynamodb item"""
+        dictionary = self.db.helpers.keys_to_dictionary(keys=keys)
+
+        update_expression = self.build_update_expression(dictionary)
+        expression_attribute_values = self.build_expression_attribute_values(dictionary)
+
+        if not dry_run:
+            self.db.update_item(
+                table_name=self.table_name,
+                key=original_primary_key,
+                update_expression=update_expression,
+                expression_attribute_values=expression_attribute_values,
+            )
+        else:
+            print("Dry run: Skipping Update item")
+            print(f"{json.dumps(original_primary_key, indent=4)}")
+            print(f"{update_expression}")
+            print(f"{json.dumps(expression_attribute_values, indent=4)}")
+
+    def build_update_expression(self, updated_keys: Dict[str, Any]) -> str:
+        """
+        Build the expression for updating the item
+
+        Args:
+            updated_keys (Dict[str, Any]): _description_
+
+        Returns:
+            str: _description_
+        """
+        update_expression = "SET " + ", ".join(
+            f"{k} = :{k}" for k in updated_keys.keys()
+        )
+        return update_expression
+
+    def build_expression_attribute_values(
+        self, updated_keys: Dict[str, Any]
+    ) -> Dict[str, Any]:
+        """
+        Build the expression attribute values for the update expression
+
+        Args:
+            updated_keys (Dict[str, Any]): _description_
+
+        Returns:
+            Dict[str, Any]: _description_
+        """
+        expression_attribute_values = {f":{k}": v for k, v in updated_keys.items()}
+        return expression_attribute_values

boto3_assist/utilities/serialization_utility.py

@@ -470,7 +470,7 @@ class Serialization:
                 "To work around this create a boolean (bool) property named __actively_serializing_data__. \n"
                 "e.g. self.__actively_serializing_data__: bool = False\n\n"
                 "Only issue/raise your exception if __actively_serializing_data__ is not True. \n\n"
-                "e.g. if not self.some_propert and not self.__actively_serializing_data__:\n"
+                "e.g. if not self.some_property and not self.__actively_serializing_data__:\n"
                 '    raise ValueError("some_property must be set")\n\n'
                 "This procedure will update the property from False to True while serializing, "
                 "then back to False once serialization is complete. "

boto3_assist/version.py

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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: boto3_assist
-Version: 0.18.0
+Version: 0.20.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.18.0.dist-info → boto3_assist-0.20.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=xLQqGjpDoJw8wh7LhnSmkR_X41AAFaOxbyFZXuEbtfY,23
+boto3_assist/version.py,sha256=pJLteH9r0aOnAwnvPatmr2QSz7lO2BDXON0AKkXx0Pg,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,15 +19,16 @@ 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=Xkt-dRFVqvlUkDf8P_h9VX91qfY9kLxNgpV8e-QUzbk,15992
+boto3_assist/dynamodb/dynamodb.py,sha256=zq2Hqhmd3aXjnd1GAmYq5TkjMPiq_pHcMW6hClSv13Y,16679
 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_iservice.py,sha256=O9Aj0PFEvcuk2vhARifWTFnUwcQW5EXzwZS478Hm-N0,796
 boto3_assist/dynamodb/dynamodb_key.py,sha256=YD7o1EUlwVBQ55p9YCTKqAUU_np4nqtLIHnmp-BeolM,1803
-boto3_assist/dynamodb/dynamodb_model_base.py,sha256=OoSZ841YLHWTV_yx8MvVc6oHZEnvdqTYPhH9LTZ4M_M,11931
+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
 boto3_assist/dynamodb/dynamodb_reindexer.py,sha256=bCj6KIU0fQOgjkkiq9yF51PFZZr4Y9Lu3-hPlmsPG0Y,6164
 boto3_assist/dynamodb/dynamodb_reserved_words.py,sha256=p0irNBSqGe4rd2FwWQqbRJWrNr4svdbWiyIXmz9lj4c,1937
 boto3_assist/dynamodb/dynamodb_reserved_words.txt,sha256=rvctS63Cv3i9SHmPq2Unmj6RZyQ-OMqxUXsNhtbg1is,4136
@@ -54,10 +55,10 @@ boto3_assist/utilities/file_operations.py,sha256=IYhJkh8wUPMvGnyDRRa9yOCDdHN9wR3
 boto3_assist/utilities/http_utility.py,sha256=_K39Fq0V4QcgklAWctUktuMjqXDTwgMld77IOUfR2zc,1282
 boto3_assist/utilities/logging_utility.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 boto3_assist/utilities/numbers_utility.py,sha256=wzv9d0uXT_2_ZHHio7LBzibwxPqhGpvbq9HinrVn_4A,10160
-boto3_assist/utilities/serialization_utility.py,sha256=tYsFWvO1QTyhPgrYfC9etnMXKFYtHC78OAtvMGHuV9w,21646
+boto3_assist/utilities/serialization_utility.py,sha256=Jc6H0cpcZjLO7tdyUZdBWHzItduLkw6sh2YQh8Hc8D8,21647
 boto3_assist/utilities/string_utility.py,sha256=XxUIz19L2LFFTRDAAmdPa8Qhn40u9yO7g4nULFuvg0M,11033
-boto3_assist-0.18.0.dist-info/METADATA,sha256=PwQUzbuw2bGPgZ8mw3GROwhjW3FnIy6FI4rESPYZRgc,2875
-boto3_assist-0.18.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-boto3_assist-0.18.0.dist-info/licenses/LICENSE-EXPLAINED.txt,sha256=WFREvTpfTjPjDHpOLADxJpCKpIla3Ht87RUUGii4ODU,606
-boto3_assist-0.18.0.dist-info/licenses/LICENSE.txt,sha256=PXDhFWS5L5aOTkVhNvoitHKbAkgxqMI2uUPQyrnXGiI,1105
-boto3_assist-0.18.0.dist-info/RECORD,,
+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,,