awsimple 3.9.1__py3-none-any.whl → 3.11.0__py3-none-any.whl

awsimple/__init__.py

@@ -1,5 +1,6 @@
 from .__version__ import __application_name__, __version__, __author__, __title__
 from .mock import use_moto_mock_env_var, is_mock, use_localstack_env_var, is_using_localstack
+from .exceptions import DynamoDBItemAlreadyExists
 from .aws import AWSAccess, AWSimpleException, boto_error_to_string
 from .cache import get_disk_free, get_directory_size, lru_cache_write, CacheAccess, CACHE_DIR_ENV_VAR
 from .dynamodb import DynamoDBAccess, dict_to_dynamodb, DBItemNotFound, DynamoDBTableNotFound, dynamodb_to_json, dynamodb_to_dict, QuerySelection, DictKey, convert_serializable_special_cases

awsimple/__version__.py

@@ -1,7 +1,7 @@
 __application_name__ = "awsimple"
 __title__ = __application_name__
 __author__ = "abel"
-__version__ = "3.9.1"
+__version__ = "3.11.0"
 __author_email__ = "j@abel.co"
 __url__ = "https://github.com/jamesabel/awsimple"
 __download_url__ = "https://github.com/jamesabel/awsimple"

awsimple/dynamodb.py

@@ -17,6 +17,7 @@ from enum import Enum
 import decimal
 from decimal import Decimal
 from functools import lru_cache
+from collections.abc import Iterable
 from logging import getLogger
 
 
@@ -27,7 +28,8 @@ from typeguard import typechecked
 from dictim import dictim  # type: ignore
 from yasf import sf
 
-from awsimple import CacheAccess, __application_name__, AWSimpleException
+from . import CacheAccess, __application_name__, AWSimpleException
+from .exceptions import DynamoDBItemAlreadyExists
 
 # don't require pillow, but convert images with it if it exists
 pil_exists = False
@@ -218,6 +220,10 @@ def _is_valid_db_pickled_file(file_path: Path, cache_life: Union[float, int, Non
 
 
 class DynamoDBAccess(CacheAccess):
+    """
+    AWS DynamoDB access
+    """
+
     @typechecked()
     def __init__(self, table_name: Union[str, None] = None, **kwargs):
         """
@@ -732,6 +738,36 @@ class DynamoDBAccess(CacheAccess):
         except self.client.exceptions.ResourceNotFoundException:
             raise DynamoDBTableNotFound(str(self.table_name))
 
+    def put_item_if_not_exists(self, item: dict):
+        """
+        Put (write) a DynamoDB table dict item if it doesn't already exist.  If the item already exists, it is not modified and DynamoDBItemAlreadyExists is raised.
+
+        :param item: item
+        """
+        assert self.resource is not None
+        primary_partition_key = self.get_primary_partition_key()
+        primary_sort_key = self.get_primary_sort_key()
+        try:
+            table = self.resource.Table(self.table_name)
+            if primary_sort_key is None:
+                table.put_item(Item=item, ConditionExpression="attribute_not_exists(#pk)", ExpressionAttributeNames={"#pk": primary_partition_key})
+            else:
+                table.put_item(
+                    Item=item,
+                    ConditionExpression="attribute_not_exists(#pk) AND attribute_not_exists(#sk)",
+                    ExpressionAttributeNames={"#pk": primary_partition_key, "#sk": primary_sort_key},
+                )
+            self.metadata_table.update_table_mtime()
+            already_exists = False
+        except self.client.exceptions.ResourceNotFoundException:
+            raise DynamoDBTableNotFound(str(self.table_name))
+        except self.client.exceptions.ConditionalCheckFailedException:
+            already_exists = True
+        if already_exists:
+            primary_partition_value = str(item.get(primary_partition_key, ""))
+            primary_sort_value = str(item.get(primary_sort_key, ""))
+            raise DynamoDBItemAlreadyExists(str(self.table_name), primary_partition_value, primary_sort_value)
+
     # cant' do a @typechecked() since optional item requires a single type
     def get_item(
         self, partition_key: Union[str, None] = None, partition_value: Union[str, int, None] = None, sort_key: Union[str, None] = None, sort_value: Union[str, int, None] = None
@@ -858,6 +894,46 @@ class DynamoDBAccess(CacheAccess):
         self.metadata_table.update_table_mtime()
         return count
 
+    @typechecked()
+    def dump_to_csv(self, file_path: Path):
+        """
+        Dump the table to a CSV file.
+
+        :param file_path: output CSV file path
+        """
+        import csv
+
+        original_rows = self.scan_table()
+        if len(original_rows) == 0:
+            log.warning(f"table {self.table_name} is empty, not writing {file_path}")
+            return
+
+        # get all field names with simple data types (no iterables)
+        field_names_set = set()
+        filtered_rows = []
+        for original_row in original_rows:
+            filtered_row = {}
+            for key, value in original_row.items():
+                # only include "simple" data types (i.e. no lists, sets, dicts, etc.)
+                if not isinstance(value, Iterable) or isinstance(value, (str, bytes, bytearray)):
+                    field_names_set.add(key)
+                    filtered_row[key] = value
+            if len(filtered_row) > 0:
+                filtered_rows.append(filtered_row)
+        field_names = sorted(field_names_set)
+        primary_partition_key = self.get_primary_partition_key()
+        primary_sort_key = self.get_primary_sort_key()
+        filtered_rows.sort(key=lambda x: (x[primary_partition_key], x.get(primary_sort_key)))  # sort by primary partition key, then sort key if it exists
+
+        file_path.parent.mkdir(parents=True, exist_ok=True)
+        with open(file_path, "w", newline="") as csvfile:
+            writer = csv.DictWriter(csvfile, fieldnames=field_names)
+            writer.writeheader()
+            for filtered_row in filtered_rows:
+                writer.writerow(dynamodb_to_dict(filtered_row))
+
+        log.info(f"wrote {len(filtered_rows)} rows to {file_path}")
+
 
 metadata_table_name = f"__{__application_name__}_metadata__"
 

awsimple/exceptions.py

@@ -0,0 +1,16 @@
+class AWSimpleExceptionBase(Exception):
+    """Base exception for AWSimple errors."""
+
+    pass
+
+
+class DynamoDBItemAlreadyExists(AWSimpleExceptionBase):
+    """Raised when an item already exists in DynamoDB."""
+
+    def __init__(self, table_name: str, primary_partition_value: str, primary_sort_value: str):
+        if len(primary_sort_value) < 1:
+            sort_message = ""
+        else:
+            sort_message = f" and {primary_sort_value=}"
+        message = f"Item with {primary_partition_value=}{sort_message} already exists in table {table_name}"
+        super().__init__(message)

{awsimple-3.9.1.dist-info → awsimple-3.11.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: awsimple
-Version: 3.9.1
+Version: 3.11.0
 Summary: Simple AWS API for S3, DynamoDB, SNS, and SQS
 Home-page: https://github.com/jamesabel/awsimple
 Download-URL: https://github.com/jamesabel/awsimple

awsimple-3.11.0.dist-info/RECORD

@@ -0,0 +1,21 @@
+awsimple/__init__.py,sha256=X7MV9cg5V1dYf86tf3TonaU-LMQWenPIW2PnjxoXYB4,1015
+awsimple/__version__.py,sha256=ey8QJTcIT2kFHhegrTZ0d01xX-GQD2kvye8fTm8hdp4,324
+awsimple/aws.py,sha256=NbRu1v_J5j2-pcefNZ5Xggii3mM9nHpeHMz9L9K9r-U,7653
+awsimple/cache.py,sha256=_LvPx76215t8KhAJOin6Pe2b4lWpB6kbKpdzgR4FeA4,7206
+awsimple/dynamodb.py,sha256=FZTk_BWOZYr3wYW7jfIgQOYaKQ_SMRMfozAT1UbMXiM,42662
+awsimple/dynamodb_miv.py,sha256=4xPxQDYkIM-BVDGyAre6uqwJHsxguEbHbof8ztt-V7g,4645
+awsimple/exceptions.py,sha256=dZQn8BKmZVlIl2-MIT5SAHRcwYK_bjzzWeG1AFbDUEg,609
+awsimple/logs.py,sha256=s9FhdDFWjfxGCVDx-FNTPgJ-YN1AOAgz4HNxTVfRARE,4108
+awsimple/mock.py,sha256=eScbnxFF9xAosOAsL-NZgp_P-fezB6StQMkb85Y3TNo,574
+awsimple/platform.py,sha256=TObvLIVgRGh-Mh4ZCxFfxAmrn8KNMHktr6XkDZX8JYE,376
+awsimple/pubsub.py,sha256=HzwkjIwFicoV--30ctov8oVlKfXWe7eaLOF1dieV7qk,7692
+awsimple/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+awsimple/s3.py,sha256=ydYLDj51b38lYI6LsJlc4i0PDj2vnWBuSkzdRKcWAUg,23858
+awsimple/sns.py,sha256=T_FyN8eSmBPo213HOfB3UBlMrvtBK768IaRo_ks-7do,3526
+awsimple/sqs.py,sha256=9ZY7161CpmYpcxlCFIfW8bvMn9SGl4cgGR79I4MFLDk,17281
+awsimple-3.11.0.dist-info/licenses/LICENSE,sha256=d956YAgtDaxgxQmccyUk__EfhORZyBjvmJ8pq6zYTxk,1093
+awsimple-3.11.0.dist-info/licenses/LICENSE.txt,sha256=d956YAgtDaxgxQmccyUk__EfhORZyBjvmJ8pq6zYTxk,1093
+awsimple-3.11.0.dist-info/METADATA,sha256=eIOptt5qOoQFZMW6qipEzGLbIuBhA46K3JZNqSabPq0,6641
+awsimple-3.11.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+awsimple-3.11.0.dist-info/top_level.txt,sha256=mwqCoH_8vAaK6iYioiRbasXmVCQM7AK3grNWOKp2VHE,9
+awsimple-3.11.0.dist-info/RECORD,,

awsimple-3.9.1.dist-info/RECORD

@@ -1,20 +0,0 @@
-awsimple/__init__.py,sha256=yo9COyuJZonzuW_5h2yvsQOtTqnwh8e_iMsMBqQxir0,964
-awsimple/__version__.py,sha256=j9qPCE9XWQi2f7AWe1m9-8MYilnfMgESTbkSf6OE2LE,323
-awsimple/aws.py,sha256=NbRu1v_J5j2-pcefNZ5Xggii3mM9nHpeHMz9L9K9r-U,7653
-awsimple/cache.py,sha256=_LvPx76215t8KhAJOin6Pe2b4lWpB6kbKpdzgR4FeA4,7206
-awsimple/dynamodb.py,sha256=8OlGbMg7uU1rpWbkjK9HdHMSfopRBrLb3AFALGgfLHg,39156
-awsimple/dynamodb_miv.py,sha256=4xPxQDYkIM-BVDGyAre6uqwJHsxguEbHbof8ztt-V7g,4645
-awsimple/logs.py,sha256=s9FhdDFWjfxGCVDx-FNTPgJ-YN1AOAgz4HNxTVfRARE,4108
-awsimple/mock.py,sha256=eScbnxFF9xAosOAsL-NZgp_P-fezB6StQMkb85Y3TNo,574
-awsimple/platform.py,sha256=TObvLIVgRGh-Mh4ZCxFfxAmrn8KNMHktr6XkDZX8JYE,376
-awsimple/pubsub.py,sha256=HzwkjIwFicoV--30ctov8oVlKfXWe7eaLOF1dieV7qk,7692
-awsimple/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-awsimple/s3.py,sha256=ydYLDj51b38lYI6LsJlc4i0PDj2vnWBuSkzdRKcWAUg,23858
-awsimple/sns.py,sha256=T_FyN8eSmBPo213HOfB3UBlMrvtBK768IaRo_ks-7do,3526
-awsimple/sqs.py,sha256=9ZY7161CpmYpcxlCFIfW8bvMn9SGl4cgGR79I4MFLDk,17281
-awsimple-3.9.1.dist-info/licenses/LICENSE,sha256=d956YAgtDaxgxQmccyUk__EfhORZyBjvmJ8pq6zYTxk,1093
-awsimple-3.9.1.dist-info/licenses/LICENSE.txt,sha256=d956YAgtDaxgxQmccyUk__EfhORZyBjvmJ8pq6zYTxk,1093
-awsimple-3.9.1.dist-info/METADATA,sha256=KL-CjrA-YV-N3eY0YypcWlsbEQX3-kH5I6zMbL8swmY,6640
-awsimple-3.9.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-awsimple-3.9.1.dist-info/top_level.txt,sha256=mwqCoH_8vAaK6iYioiRbasXmVCQM7AK3grNWOKp2VHE,9
-awsimple-3.9.1.dist-info/RECORD,,