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

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

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

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

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

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

{boto3_assist-0.21.0 → boto3_assist-0.23.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
 
@@ -318,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-0.21.0 → boto3_assist-0.23.0}/src/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}"
                     )
@@ -160,9 +160,14 @@ class DynamoDBIndex:
     ) -> 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:
+        if (
+            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 differenet than query keys
+            # this is different than query keys
             key = {}
             key[self.partition_key.attribute_name] = self.partition_key.value
 

{boto3_assist-0.21.0 → boto3_assist-0.23.0}/src/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-0.21.0 → boto3_assist-0.23.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.23.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.23.0/src/boto3_assist/version.py

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

boto3_assist-0.23.0/tests/unit/dynamodb_tests/db_models/task.py

@@ -0,0 +1,76 @@
+from typing import Optional
+from boto3_assist.dynamodb.dynamodb_model_base import DynamoDBModelBase
+from boto3_assist.dynamodb.dynamodb_index import DynamoDBIndex
+from boto3_assist.dynamodb.dynamodb_key import DynamoDBKey
+from boto3_assist.utilities.string_utility import StringUtility
+
+
+class Task(DynamoDBModelBase):
+    """
+    A Generic Task Model
+
+    Using the same task.id, you can chain child elements via task.step_id
+
+    """
+
+    def __init__(self, id: Optional[str] = None):
+        super().__init__()
+        self.id: str = id or StringUtility.generate_uuid()
+        self._name: Optional[str] = None
+        self._step: Optional[str] = None
+        self._step_id: Optional[str] = None
+        self.metadata: dict = {}
+        self._setup_pk()
+
+    @property
+    def name(self) -> Optional[str]:
+        """
+        Returns the name for this task
+        """
+        return self._name
+
+    @name.setter
+    def name(self, value: str):
+        """
+        Sets the name for this task
+        """
+        self._name = value
+
+    @property
+    def step(self) -> Optional[str]:
+        """
+        Returns the step for this task
+        """
+        return self._step
+
+    @step.setter
+    def step(self, value: str):
+        """
+        Sets the step for this task
+        """
+        self._step = value
+
+    @property
+    def step_id(self) -> str | None:
+
+        return self._step_id
+
+    @step_id.setter
+    def step_id(self, value: str):
+        """
+        Sets the step_id for this task
+        """
+
+        self._step_id = value
+
+    def _setup_pk(self):
+        primary: DynamoDBIndex = DynamoDBIndex()
+        primary.name = "primary"
+        primary.partition_key.attribute_name = "pk"
+        primary.partition_key.value = lambda: DynamoDBKey.build_key(
+            (self.__class__.__name__, self.id)
+        )
+
+        primary.sort_key.attribute_name = "sk"
+        primary.sort_key.value = lambda: DynamoDBKey.build_key(("step", self.step_id))
+        self.indexes.add_primary(primary)

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

@@ -0,0 +1,59 @@
+"""
+Geek Cafe, LLC
+Maintainers: Eric Wilson
+MIT License.  See Project Root for the license information.
+"""
+
+import unittest
+import moto
+from typing import Optional
+from tests.unit.dynamodb_tests.db_models.task import Task
+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):
+
+        task_id: str = "123456789"
+
+        task = Task(task_id)
+        response = self.db.save(table_name=self.__table_name, item=task)
+
+        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=task,
+            fail_if_exists=True,
+        )
+
+        # this does not
+        response = self.db.save(table_name=self.__table_name, item=task)
+        self.assertEqual(response["ResponseMetadata"]["HTTPStatusCode"], 200)

boto3_assist-0.23.0/tests/unit/dynamodb_tests/dynamodb_primary_key_sort_test.py

@@ -0,0 +1,82 @@
+"""
+Geek Cafe, LLC
+Maintainers: Eric Wilson
+MIT License.  See Project Root for the license information.
+"""
+
+import unittest
+import moto
+from typing import Optional
+from tests.unit.dynamodb_tests.db_models.task import Task
+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 create_data_process_task(
+        self,
+        name: str,
+        step: str,
+        task_id: Optional[str] = None,
+        metadata: Optional[dict] = None,
+    ) -> Task:
+        task = Task()
+        if task_id:
+            task.id = task_id
+            task.step_id = Task.generate_uuid()
+        else:
+            task.step_id = task.id
+        task.name = name
+        task.step = step
+
+        task.metadata = metadata
+        response = self.db.save(
+            table_name=self.__table_name, item=task, fail_if_exists=True
+        )
+        assert response["ResponseMetadata"]["HTTPStatusCode"] == 200
+        return task
+
+    def test_primary_key_query_sort(self):
+        task: Task = self.create_data_process_task(
+            name="test", step="test", task_id=None
+        )
+
+        # no create a bunch of children
+        for i in range(0, 10):
+            self.create_data_process_task(
+                name="test",
+                step=f"child-{i}",
+                task_id=task.id,
+                metadata={"child": f"i"},
+            )
+
+        query_model: Task = Task()
+        query_model.id = task.id
+        key = query_model.get_key("primary")
+        query_response = self.db.query(table_name=self.__table_name, key=key)
+
+        # primary task and 10 children == 11
+        assert len(query_response["Items"]) == 11

boto3_assist-0.21.0/src/boto3_assist/version.py

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