boto3-assist 0.6.0__py3-none-any.whl → 0.7.0__py3-none-any.whl

boto3_assist/utilities/serialization_utility.py

@@ -1,16 +1,15 @@
 """Serialization Utility"""
 
-from datetime import datetime
-from decimal import Decimal
-from typing import Dict, List, TypeVar, Any
-import json
-import jsons
 import datetime as dt
 import decimal
 import inspect
+import json
 import uuid
-from aws_lambda_powertools import Logger
+from datetime import datetime
+from decimal import Decimal
+from typing import Any, Dict, List, TypeVar
 
+from aws_lambda_powertools import Logger
 
 T = TypeVar("T")
 
@@ -53,6 +52,15 @@ class SerializableModel:
             instance=self, serialize_fn=lambda x: x, include_none=True
         )
 
+    def to_wide_dictionary(self) -> Dict:
+        """
+        Dumps an object to dictionary structure
+        """
+
+        dump = Serialization.to_wide_dictionary(model=self)
+
+        return dump
+
 
 class JsonEncoder(json.JSONEncoder):
     """
@@ -108,6 +116,32 @@ class Serialization:
 
         return dump
 
+    @staticmethod
+    def to_wide_dictionary(model: object) -> Dict:
+        """
+        Dumps an object to dictionary structure
+        """
+
+        dump = Serialization.to_dict(
+            instance=model, serialize_fn=lambda x: x, include_none=True
+        )
+
+        # have a dictionary now let's flatten out
+        flat_dict = {}
+        for key, value in dump.items():
+            if isinstance(value, dict):
+                for sub_key, sub_value in value.items():
+                    flat_dict[f"{key}_{sub_key}"] = sub_value
+            elif isinstance(value, list):
+                for i, sub_value in enumerate(value):
+                    sub_dict = Serialization.to_wide_dictionary(sub_value)
+                    for sub_key, sub_value in sub_dict.items():
+                        flat_dict[f"{key}_{i}_{sub_key}"] = sub_value
+            else:
+                flat_dict[key] = value
+
+        return flat_dict
+
     @staticmethod
     def map(source: object, target: T, coerce: bool = True) -> T | None:
         """Map an object from one object to another"""
@@ -118,12 +152,92 @@ class Serialization:
             source_dict = Serialization.convert_object_to_dict(source)
             if not isinstance(source_dict, dict):
                 return None
-        return Serialization.load_properties(
+        return Serialization._load_properties(
             source=source_dict, target=target, coerce=coerce
         )
 
     @staticmethod
-    def load_properties(
+    def to_wide_dictionary_list(
+        data: Dict[str, Any] | List[Dict[str, Any]],
+        remove_collisions: bool = True,
+        raise_error_on_collision: bool = False,
+    ) -> List[Dict[str, Any]]:
+        """
+        Converts a dictionary or list of dictionaries to a list of dictionaries.
+
+        :param data: Dictionary or list of dictionaries to be converted
+        :param remove_collisions: If True, removes duplicate keys from the dictionaries
+        :return: List of dictionaries
+        """
+
+        collisions = []
+
+        def recursive_flatten(prefix, obj):
+            """
+            Recursively flattens a JSON object.
+
+            :param prefix: Current key prefix
+            :param obj: Object to flatten
+            :return: List of flattened dictionaries
+            """
+            if isinstance(obj, list):
+                result = []
+                for _, item in enumerate(obj):
+                    x = recursive_flatten("", item)
+                    result.extend(x)
+                return result
+            elif isinstance(obj, dict):
+                result = [{}]
+                for key, value in obj.items():
+                    sub_result = recursive_flatten(
+                        f"{prefix}_{key}" if prefix else key, value
+                    )
+                    new_result = []
+                    for entry in result:
+                        for sub_entry in sub_result:
+                            # remove any collisions
+
+                            for k in entry:
+                                if k in sub_entry:
+                                    if k not in collisions:
+                                        logger.debug(f"Collision detected: {k}")
+                                        collisions.append(k)
+                            merged = entry.copy()
+                            merged.update(sub_entry)
+                            new_result.append(merged)
+                    result = new_result
+                return result
+            else:
+                return [{prefix: obj}] if prefix else []
+
+        results = recursive_flatten("", data)
+        if remove_collisions:
+            results = Serialization.remove_collisions(results, collisions)
+
+        if raise_error_on_collision and len(collisions) > 0:
+            raise ValueError(f"Duplicate keys detected: {collisions}")
+
+        return results
+
+    @staticmethod
+    def remove_collisions(
+        data: List[Dict[str, Any]], collisions: List[str]
+    ) -> List[Dict[str, Any]]:
+        """
+        Removes collisions from a list of dictionaries.
+
+        :param data: List of dictionaries
+        :param collisions: List of collision keys
+        :return: List of dictionaries with collisions removed
+        """
+        for c in collisions:
+            for r in data:
+                if c in r:
+                    del r[c]
+        return data
+
+    @staticmethod
+    def _load_properties(
         source: dict,
         target: T,
         coerce: bool = True,
@@ -183,9 +297,9 @@ class Serialization:
                         attr.clear()
                         attr.extend(value)
                     elif isinstance(attr, dict) and isinstance(value, dict):
-                        Serialization.load_properties(value, attr, coerce=coerce)
+                        Serialization._load_properties(value, attr, coerce=coerce)
                     elif hasattr(attr, "__dict__") and isinstance(value, dict):
-                        Serialization.load_properties(value, attr, coerce=coerce)
+                        Serialization._load_properties(value, attr, coerce=coerce)
                     else:
                         setattr(target, key, value)
                 except ValueError as e:
@@ -230,12 +344,18 @@ class Serialization:
 
     @staticmethod
     def to_dict(
-        instance: SerializableModel,
+        instance: SerializableModel | dict,
         serialize_fn,
         include_none: bool = True,
     ) -> Dict[str, Any]:
         """To Dict / Dictionary"""
 
+        if instance is None:
+            return {}
+
+        if isinstance(instance, dict):
+            return instance
+
         def is_primitive(value):
             """Check if the value is a primitive data type."""
             return isinstance(value, (str, int, bool, type(None)))

boto3_assist/utilities/string_utility.py

@@ -195,6 +195,36 @@ class StringUtility:
         hash_object.update(encoded_string)
         return hash_object.hexdigest()
 
+    @staticmethod
+    def generate_idempotent_uuid(
+        namespace: uuid.UUID | str, unique_string: str, case_sensitive: bool = False
+    ) -> str:
+        """
+        Generates an idempotnent 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
+            unique_string (str): A unique string like an email address, a tenant name.
+                Use a combination for more granularity:
+                    tenant-name:email
+                    vendor:product-name
+                    vendor:product-id
+                    etc
+
+        Returns:
+            str: a string representation of a UUID
+        """
+        if isinstance(namespace, str):
+            namespace = uuid.UUID(namespace)
+
+        if not unique_string:
+            raise ValueError("unique_string cannot be empty")
+
+        if not case_sensitive:
+            unique_string = unique_string.lower()
+
+        return str(uuid.uuid5(namespace, unique_string))
+
     @staticmethod
     def get_size_in_kb(input_string: str | dict) -> float:
         """

boto3_assist/version.py

@@ -1 +1 @@
-__version__ = '0.6.0'
+__version__ = '0.7.0'

{boto3_assist-0.6.0.dist-info → boto3_assist-0.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: boto3_assist
-Version: 0.6.0
+Version: 0.7.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.6.0.dist-info → boto3_assist-0.7.0.dist-info}/RECORD

@@ -1,9 +1,9 @@
 boto3_assist/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 boto3_assist/boto3session.py,sha256=Q9sByNC0r_aMQfHnIEnxtTaiCMUqikm8UeSTxV7-Np0,6632
 boto3_assist/connection.py,sha256=CNGkAIRyfrELoWrV0ziQBA3oHacNFuLL3i8faUPRiO0,3486
-boto3_assist/connection_tracker.py,sha256=bfImvNVX-0Lhb-ombOurWUpNLdI0qVDil-kokBdIFkY,4345
+boto3_assist/connection_tracker.py,sha256=UgfR9RlvXf3A4ssMr3gDMpw89ka8mSRvJn4M34SzhbU,4378
 boto3_assist/http_status_codes.py,sha256=G0zRSWenwavYKETvDF9tNVUXQz3Ae2gXdBETYbjvJe8,3284
-boto3_assist/version.py,sha256=CBY3jsC-9HCm7eZ6CKD-sYLCejqOJ1pYWPQM4LGIXcI,22
+boto3_assist/version.py,sha256=09hol5ovL6ArILJIJZ-MiscnOjKa6RjaETmtdgJpW2c,22
 boto3_assist/aws_lambda/event_info.py,sha256=OkZ4WzuGaHEu_T8sB188KBgShAJhZpWASALKRGBOhMg,14648
 boto3_assist/cloudwatch/cloudwatch_connection.py,sha256=mnGWaLSQpHh5EeY7Ek_2o9JKHJxOELIYtQVMX1IaHn4,2480
 boto3_assist/cloudwatch/cloudwatch_connection_tracker.py,sha256=mzRtO1uHrcfJNh1XrGEiXdTqxwEP8d1RqJkraMNkgK0,410
@@ -34,19 +34,21 @@ boto3_assist/environment_services/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeR
 boto3_assist/environment_services/environment_loader.py,sha256=zCA4mRdVWMLKzjDRvrJbhQfRVP4HAMGpuQFi07zzULk,3396
 boto3_assist/environment_services/environment_variables.py,sha256=4ccBKdPt6O7hcRT3zBHd8vqu8yQU8udmoD5RLAT3iMs,6801
 boto3_assist/errors/custom_exceptions.py,sha256=zC2V2Y4PUtKj3uLPn8mB-JessksKWJWvKM9kp1dmvt8,760
-boto3_assist/models/serializable_model.py,sha256=nzGdkggAzmrIukPPyumB9EPUNrPfvQrCqbTSndnwT1c,257
-boto3_assist/s3/s3.py,sha256=DFCJs5z1mMIT8nZfnqPyr_cvhi9-FePuYH--tzD7b5E,17104
-boto3_assist/s3/s3_connection.py,sha256=FI1AhZV4UbTXQRTb4TqL9mv88Gt018rPZVFBvLetVAw,2163
+boto3_assist/models/serializable_model.py,sha256=ZMrRJRvJWLY8PBSKK_nPCgYKv1qUxDPEVdcADKbIHsI,266
+boto3_assist/s3/s3.py,sha256=ESTPXtyDi8mrwHaYNWjQLNGTuTUV4CxKDqw-O_KGzKs,2052
+boto3_assist/s3/s3_bucket.py,sha256=GfyBbuI5BWz_ybwU_nDqUZiC0wt24PNt49GKZmb05OY,2018
+boto3_assist/s3/s3_connection.py,sha256=0JgEDNoDFPQTo5hQe-lS8mWnFBJ2S8MDSl0LPG__lZo,2008
+boto3_assist/s3/s3_object.py,sha256=kH9apiVZ-lWGtcSqcLvaAI-2g011ecrvg8wP7y9u140,19482
 boto3_assist/utilities/datetime_utility.py,sha256=dgAMB9VqakrYIPXlSoVQiLSsc_yhrJK4gMfJO9mX90w,11112
 boto3_assist/utilities/dictionaroy_utility.py,sha256=PjUrerEd6uhmw37A-k7xe_DWHvXZGGoMqT6xjUqmWBI,893
 boto3_assist/utilities/file_operations.py,sha256=Zy8fu8fpuVNf7U9NimrLdy5FRF71XSI159cnRdzmzGY,3411
 boto3_assist/utilities/http_utility.py,sha256=koFv7Va-8ng-47Nt1K2Sh7Ti95e62IYs9VMLlGh9Kt4,1173
 boto3_assist/utilities/logging_utility.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 boto3_assist/utilities/numbers_utility.py,sha256=KIiNkBSRbfNWvtXG5SdHp625LTiW12VtADUa4ZlWMFo,8709
-boto3_assist/utilities/serialization_utility.py,sha256=fj5FDQjA7pC_mhX22n0N1UwRXl7S__q0VrisQTc0GHg,12415
-boto3_assist/utilities/string_utility.py,sha256=sBY80aQO-fTRanlHryZFMQBxdo6OvLRvnZjZrQepHlI,9283
-boto3_assist-0.6.0.dist-info/METADATA,sha256=DFeAHlHVbA3lVP2ZKQPfSc9y8pvUWleUq8G649h8iy4,1728
-boto3_assist-0.6.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-boto3_assist-0.6.0.dist-info/licenses/LICENSE-EXPLAINED.txt,sha256=WFREvTpfTjPjDHpOLADxJpCKpIla3Ht87RUUGii4ODU,606
-boto3_assist-0.6.0.dist-info/licenses/LICENSE.txt,sha256=PXDhFWS5L5aOTkVhNvoitHKbAkgxqMI2uUPQyrnXGiI,1105
-boto3_assist-0.6.0.dist-info/RECORD,,
+boto3_assist/utilities/serialization_utility.py,sha256=KJhit0lI1lr8hhndW6UhKQSZD3c2RH555Ni7eP-e5Ms,16557
+boto3_assist/utilities/string_utility.py,sha256=5BpDaqGZI8cSM-3YFQLU1fKcWcqG9r1_GPgDstCWFIs,10318
+boto3_assist-0.7.0.dist-info/METADATA,sha256=0cBmMT5N4of5YzMQhUlK3S_ovOEaxRItYa_JQnjH16I,1728
+boto3_assist-0.7.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+boto3_assist-0.7.0.dist-info/licenses/LICENSE-EXPLAINED.txt,sha256=WFREvTpfTjPjDHpOLADxJpCKpIla3Ht87RUUGii4ODU,606
+boto3_assist-0.7.0.dist-info/licenses/LICENSE.txt,sha256=PXDhFWS5L5aOTkVhNvoitHKbAkgxqMI2uUPQyrnXGiI,1105
+boto3_assist-0.7.0.dist-info/RECORD,,