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

{boto3_assist-0.21.0 → boto3_assist-0.22.0}/.vscode/settings.json

@@ -28,7 +28,8 @@
     },
     "cSpell.words": [
         "addopts",
-        "geekcafe"
+        "geekcafe",
+        "relativedelta"
     ],
     
 }

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

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

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

{boto3_assist-0.21.0 → boto3_assist-0.22.0}/src/boto3_assist/dynamodb/dynamodb.py

@@ -6,6 +6,8 @@ MIT License.  See Project Root for the license information.
 
 import os
 from typing import List, Optional, overload, Dict, Any
+from botocore.exceptions import ClientError
+from boto3.dynamodb.conditions import Attr
 
 from aws_lambda_powertools import Logger
 from boto3.dynamodb.conditions import (
@@ -65,17 +67,22 @@ class DynamoDB(DynamoDBConnection):
         item: dict | DynamoDBModelBase,
         table_name: str,
         source: Optional[str] = None,
+        fail_if_exists: bool = False,
     ) -> dict:
         """
         Save an item to the database
         Args:
-            item (dict): DynamoDB Dictionary Object or DynamoDBModelBase.  Supports the "client" or
-            "resource" syntax
+            item (dict): DynamoDB Dictionary Object or DynamoDBModelBase.
+                Supports the "client" or "resource" syntax
             table_name (str): The DynamoDb Table Name
             source (str, optional): The source of the call, used for logging. Defaults to None.
+            fail_if_exists (bool, optional): Only allow it to insert once.
+                Fail if it already exits. This is useful for loggers, historical records,
+                tasks, etc. that should only be created once
 
         Raises:
-            e: Any Error Raised
+            ClientError: Client specific errors
+            Exception: Any Error Raised
 
         Returns:
             dict: The Response from DynamoDB's put_item actions.
@@ -85,7 +92,7 @@ class DynamoDB(DynamoDBConnection):
 
         try:
             if not isinstance(item, dict):
-                # attemp to convert it
+                # attempt to convert it
                 if not isinstance(item, DynamoDBModelBase):
                     raise RuntimeError(
                         f"Item is not a dictionary or DynamoDBModelBase. Type: {type(item).__name__}. "
@@ -106,19 +113,49 @@ class DynamoDB(DynamoDBConnection):
 
             if isinstance(item, dict) and isinstance(next(iter(item.values())), dict):
                 # Use boto3.client syntax
-                response = dict(
-                    self.dynamodb_client.put_item(TableName=table_name, Item=item)
-                )
+                # client API style
+                params = {
+                    "TableName": table_name,
+                    "Item": item,
+                }
+                if fail_if_exists:
+                    # only insert if the item does *not* already exist
+                    params["ConditionExpression"] = (
+                        "attribute_not_exists(#pk) AND attribute_not_exists(#sk)"
+                    )
+                    params["ExpressionAttributeNames"] = {"#pk": "pk", "#sk": "sk"}
+                response = dict(self.dynamodb_client.put_item(**params))
+
             else:
                 # Use boto3.resource syntax
                 table = self.dynamodb_resource.Table(table_name)
-                response = dict(table.put_item(Item=item))  # type: ignore[arg-type]
+                if fail_if_exists:
+                    cond = Attr("pk").not_exists() & Attr("sk").not_exists()
+                    response = dict(table.put_item(Item=item, ConditionExpression=cond))
+                else:
+                    response = dict(table.put_item(Item=item))
+                    # response = dict(table.put_item(Item=item))  # type: ignore[arg-type]
+
+        except ClientError as e:
+            if (
+                fail_if_exists
+                and e.response["Error"]["Code"] == "ConditionalCheckFailedException"
+            ):
+                raise RuntimeError(
+                    f"Item with pk={item['pk']} already exists in {table_name} "
+                    f"and fail_if_exists was set to {fail_if_exists}"
+                ) from e
+
+            logger.exception(
+                {"source": f"{source}", "metric_filter": "put_item", "error": str(e)}
+            )
+            raise
 
         except Exception as e:  # pylint: disable=w0718
             logger.exception(
                 {"source": f"{source}", "metric_filter": "put_item", "error": str(e)}
             )
-            raise e
+            raise
 
         return response
 

{boto3_assist-0.21.0 → boto3_assist-0.22.0}/src/boto3_assist/dynamodb/dynamodb_model_base_interfaces.py

@@ -25,10 +25,10 @@ class HasKeys(Protocol):
     """Interface for classes that have primary and sort keys"""
 
     def get_pk(self, index_name: str) -> Optional[str]:
-        """Inteface to get_pk"""
+        """Interface to get_pk"""
 
     def get_sk(self, index_name: str) -> Optional[str]:
-        """Inteface to get_sk"""
+        """Interface to get_sk"""
 
     def get_key(self, index_name: str) -> And | Equals:
         """Get the index name and key"""

{boto3_assist-0.21.0 → boto3_assist-0.22.0}/src/boto3_assist/utilities/datetime_utility.py

@@ -12,7 +12,6 @@ from aws_lambda_powertools import Logger
 from dateutil.relativedelta import relativedelta
 
 
-
 logger = Logger()
 
 _last_timestamp = None
@@ -43,11 +42,10 @@ class DatetimeUtility:
     @staticmethod
     def get_utc_now() -> datetime:
         # datetime.utcnow()
-        # below is the prefered over datetime.utcnow()
+        # below is the preferred over datetime.utcnow()
         return datetime.now(timezone.utc)
 
     @staticmethod
-    
     def string_to_date(string_date: str | datetime) -> datetime | None:
         """
         Description: takes a string value and returns it as a datetime.
@@ -269,7 +267,7 @@ class DatetimeUtility:
             months (int): the number of months
 
         Returns:
-            datetime: One Month added to the input dt
+            datetime: X Month(s) added to the input dt
         """
         new_date = dt + relativedelta(months=+months)
         new_date = new_date + relativedelta(microseconds=-1)
@@ -278,14 +276,14 @@ class DatetimeUtility:
 
     @staticmethod
     def add_days(dt: datetime, days: int = 1) -> datetime:
-        """Add a month to the current date
+        """Add a day to the current date
 
         Args:
             dt (datetime): datetime
-            months (int): the number of months
+            days (int): the number of days, use a negative number to subtract
 
         Returns:
-            datetime: One Month added to the input dt
+            datetime: X days added to the input dt
         """
         new_date = dt + relativedelta(days=+days)
         new_date = new_date + relativedelta(microseconds=-1)
@@ -314,7 +312,7 @@ class DatetimeUtility:
 
         Args:
             utc_datetime (datetime): datetime in utc
-            timezone (str): 'US/Eastern', 'US/Moutain', etc
+            timezone (str): 'US/Eastern', 'US/Mountain', etc
 
         Returns:
             datetime: in the correct timezone
@@ -326,7 +324,7 @@ class DatetimeUtility:
 
     @staticmethod
     def get_timestamp(value: datetime | None | str) -> float:
-        """Get a timestampe from a date or 0.0"""
+        """Get a timestamp from a date or 0.0"""
         if value is None:
             return 0.0
         if not isinstance(value, datetime):
@@ -339,7 +337,7 @@ class DatetimeUtility:
 
     @staticmethod
     def get_timestamp_or_none(value: datetime | None | str) -> float | None:
-        """Get a timestampe from a date or None"""
+        """Get a timestamp from a date or None"""
         if value is None:
             return None
         if not isinstance(value, datetime):

boto3_assist-0.22.0/src/boto3_assist/version.py

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

boto3_assist-0.22.0/tests/unit/dynamodb_tests/dynamodb_fail_if_exists_test.py

@@ -0,0 +1,61 @@
+"""
+Geek Cafe, LLC
+Maintainers: Eric Wilson
+MIT License.  See Project Root for the license information.
+"""
+
+import unittest
+import moto
+
+from tests.unit.dynamodb_tests.db_models.user_model import User
+from boto3_assist.environment_services.environment_loader import EnvironmentLoader
+from boto3_assist.dynamodb.dynamodb import DynamoDB
+from tests.unit.common.db_test_helpers import DbTestHelper
+
+
+@moto.mock_aws
+class DbQueryTest(unittest.TestCase):
+    "Serialization Tests"
+
+    def __init__(self, methodName="runTest"):
+        super().__init__(methodName)
+
+        ev: EnvironmentLoader = EnvironmentLoader()
+        # NOTE: you need to make sure the the env file below exists or you will get an error
+        ev.load_environment_file(file_name=".env.unittest")
+        self.__table_name = "mock_test_table"
+
+        self.db: DynamoDB = DynamoDB()
+
+    def setUp(self):
+        # load our test environment file to make sure we override any default AWS Environment Vars setup
+        # we don't want to accidentally connect to live environments
+        # https://docs.getmoto.org/en/latest/docs/getting_started.html
+
+        self.db: DynamoDB = self.db or DynamoDB()
+        DbTestHelper().helper_create_mock_table(self.__table_name, self.db.client)
+        print("Setup Complete")
+
+    def test_fail_if_exists(self):
+
+        # create a few users
+
+        user_id: str = "123456789"
+
+        user = User(user_id)
+        response = self.db.save(table_name=self.__table_name, item=user)
+
+        self.assertEqual(response["ResponseMetadata"]["HTTPStatusCode"], 200)
+
+        # this will fail, fail_if_exists is set to true
+        self.assertRaises(
+            Exception,
+            self.db.save,
+            table_name=self.__table_name,
+            item=user,
+            fail_if_exists=True,
+        )
+
+        # this does not
+        response = self.db.save(table_name=self.__table_name, item=user)
+        self.assertEqual(response["ResponseMetadata"]["HTTPStatusCode"], 200)

boto3_assist-0.21.0/src/boto3_assist/version.py

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