boto3-assist 0.17.0__py3-none-any.whl → 0.19.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_reindexer.py → dynamodb_re_indexer.py}

@@ -16,8 +16,8 @@ from boto3_assist.dynamodb.dynamodb_iservice import IDynamoDBService
 logger = Logger()
 
 
-class DynamoDBReindexer:
-    """Reindexing your database"""
+class DynamoDBReIndexer:
+    """ReIndexing your database"""
 
     def __init__(
         self,

boto3_assist/utilities/serialization_utility.py

@@ -12,8 +12,8 @@ import uuid
 from datetime import datetime
 from decimal import Decimal
 from typing import Any, Dict, List, TypeVar
-import re
 from aws_lambda_powertools import Logger
+from boto3_assist.utilities.string_utility import StringUtility
 
 T = TypeVar("T")
 
@@ -119,16 +119,12 @@ class JsonConversions:
     @staticmethod
     def _camel_to_snake(value: str) -> str:
         """Converts a camelCase to a snake_case"""
-        # Insert underscores before uppercase letters, then convert to lowercase.
-        s1 = re.sub(r"(.)([A-Z][a-z]+)", r"\1_\2", value)
-        return re.sub(r"([a-z0-9])([A-Z])", r"\1_\2", s1).lower()
+        return StringUtility.camel_to_snake(value)
 
     @staticmethod
     def _snake_to_camel(value: str) -> str:
         """Converts a value from snake_case to camelCase"""
-        # Split the value by underscores and capitalize each component except the first.
-        components = value.split("_")
-        return components[0] + "".join(x.title() for x in components[1:])
+        return StringUtility.snake_to_camel(value)
 
     @staticmethod
     def _convert_keys(data, convert_func, deep: bool = True):
@@ -474,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/utilities/string_utility.py

@@ -12,6 +12,7 @@ from datetime import datetime
 from decimal import Decimal
 import uuid
 import json
+import re
 from aws_lambda_powertools import Logger
 from boto3_assist.utilities.datetime_utility import DatetimeUtility
 
@@ -200,7 +201,7 @@ class StringUtility:
         namespace: uuid.UUID | str, unique_string: str, case_sensitive: bool = False
     ) -> str:
         """
-        Generates an idempotnent UUID, which is useful for creates
+        Generates an idempotent UUID, which is useful for creates
 
         Args:
             namespace (GUID | str): A namespace for your id, it must be a UUID or a string in a UUID format
@@ -320,3 +321,17 @@ class StringUtility:
             return False
         else:
             raise ValueError(f"Invalid boolean value: {value}")
+
+    @staticmethod
+    def camel_to_snake(value: str) -> str:
+        """Converts a camelCase to a snake_case"""
+        # Insert underscores before uppercase letters, then convert to lowercase.
+        s1 = re.sub(r"(.)([A-Z][a-z]+)", r"\1_\2", value)
+        return re.sub(r"([a-z0-9])([A-Z])", r"\1_\2", s1).lower()
+
+    @staticmethod
+    def snake_to_camel(value: str) -> str:
+        """Converts a value from snake_case to camelCase"""
+        # Split the value by underscores and capitalize each component except the first.
+        components = value.split("_")
+        return components[0] + "".join(x.title() for x in components[1:])

boto3_assist/version.py

@@ -1 +1 @@
-__version__ = '0.17.0'
+__version__ = '0.19.0'

{boto3_assist-0.17.0.dist-info → boto3_assist-0.19.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: boto3_assist
-Version: 0.17.0
+Version: 0.19.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.17.0.dist-info → boto3_assist-0.19.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=ctD9pjqBvASXR0DHHzalDZFaQsnMJWDpTalYrvY3e_Y,23
+boto3_assist/version.py,sha256=0oosv1io7ZLWIP51h3aW4WiUU6JK4g80JBajmF2xLAM,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,7 +19,7 @@ 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
@@ -28,7 +28,7 @@ boto3_assist/dynamodb/dynamodb_iservice.py,sha256=O9Aj0PFEvcuk2vhARifWTFnUwcQW5E
 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_interfaces.py,sha256=yT4zDRI8vP15WVOHnCvY3FsEy_QSIta5-bnUby70Xow,747
-boto3_assist/dynamodb/dynamodb_reindexer.py,sha256=bCj6KIU0fQOgjkkiq9yF51PFZZr4Y9Lu3-hPlmsPG0Y,6164
+boto3_assist/dynamodb/dynamodb_re_indexer.py,sha256=Y0qRrvpmjS68w8ci6Au7Hg02W_ktqhUGGALeN-9XTls,6164
 boto3_assist/dynamodb/dynamodb_reserved_words.py,sha256=p0irNBSqGe4rd2FwWQqbRJWrNr4svdbWiyIXmz9lj4c,1937
 boto3_assist/dynamodb/dynamodb_reserved_words.txt,sha256=rvctS63Cv3i9SHmPq2Unmj6RZyQ-OMqxUXsNhtbg1is,4136
 boto3_assist/dynamodb/readme.md,sha256=wNMzdRwk0qRV0kE88UUYnJos3pEK0HNjEIVkq2PATf8,1490
@@ -54,10 +54,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=_soAHu2Ym6SVwMBafMPcP4t9QwtxVC03MP0cm0L3A4g,21897
-boto3_assist/utilities/string_utility.py,sha256=0ChxbuT37xdG4y3cKzbNTHk4T3fl8lNMdOT7L5aJBQk,10382
-boto3_assist-0.17.0.dist-info/METADATA,sha256=V7dNLKqmVvQFMXjNf7rIMwCRFE5vbshObvHp3ROOIIs,2875
-boto3_assist-0.17.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-boto3_assist-0.17.0.dist-info/licenses/LICENSE-EXPLAINED.txt,sha256=WFREvTpfTjPjDHpOLADxJpCKpIla3Ht87RUUGii4ODU,606
-boto3_assist-0.17.0.dist-info/licenses/LICENSE.txt,sha256=PXDhFWS5L5aOTkVhNvoitHKbAkgxqMI2uUPQyrnXGiI,1105
-boto3_assist-0.17.0.dist-info/RECORD,,
+boto3_assist/utilities/serialization_utility.py,sha256=Jc6H0cpcZjLO7tdyUZdBWHzItduLkw6sh2YQh8Hc8D8,21647
+boto3_assist/utilities/string_utility.py,sha256=XxUIz19L2LFFTRDAAmdPa8Qhn40u9yO7g4nULFuvg0M,11033
+boto3_assist-0.19.0.dist-info/METADATA,sha256=MHPwm_oTiAFN_Rq5puNzMqLQnEe2c3YwubHc30sb3Mg,2875
+boto3_assist-0.19.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+boto3_assist-0.19.0.dist-info/licenses/LICENSE-EXPLAINED.txt,sha256=WFREvTpfTjPjDHpOLADxJpCKpIla3Ht87RUUGii4ODU,606
+boto3_assist-0.19.0.dist-info/licenses/LICENSE.txt,sha256=PXDhFWS5L5aOTkVhNvoitHKbAkgxqMI2uUPQyrnXGiI,1105
+boto3_assist-0.19.0.dist-info/RECORD,,