boto3-assist 0.5.0__py3-none-any.whl → 0.5.1__py3-none-any.whl

boto3_assist/cognito/user.py

@@ -1,7 +1,14 @@
+"""
+Geek Cafe, LLC
+Maintainers: Eric Wilson
+MIT License.  See Project Root for the license information.
+"""
+
 from typing import Optional
+from boto3_assist.models.serializable_model import SerializableModel
 
 
-class CognitoUser:
+class CognitoUser(SerializableModel):
     """A generic way to represent a cognito user"""
 
     def __init__(

boto3_assist/models/serializable_model.py

@@ -0,0 +1,30 @@
+"""
+Geek Cafe, LLC
+Maintainers: Eric Wilson
+MIT License.  See Project Root for the license information.
+"""
+
+from __future__ import annotations
+from typing import TypeVar
+from boto3_assist.utilities.serialization_utility import Serialization
+
+
+class SerializableModel:
+    """Library to Serialize object to a DynamoDB Format"""
+
+    T = TypeVar("T", bound="SerializableModel")
+
+    @staticmethod
+    def map(source: dict | object, target: T, coerce: bool = True) -> T:
+        """
+        Map the source dictionary to the target object.
+
+        Args:
+        - source: The dictionary to map from.
+        - target: The object to map to.
+        """
+        mapped = Serialization.map(source, target, coerce=coerce)
+        if mapped is None:
+            raise ValueError("Unable to map source to target")
+
+        return mapped

boto3_assist/utilities/serialization_utility.py

@@ -5,11 +5,11 @@ from decimal import Decimal
 from typing import Dict, List, TypeVar
 import json
 import jsons
-from aws_lambda_powertools import Logger, Tracer
+from aws_lambda_powertools import Logger
 
 T = TypeVar("T")
 
-tracer = Tracer()
+
 logger = Logger()
 
 
@@ -67,7 +67,7 @@ class Serialization:
         raise ValueError("Unable to convert object to dictionary")
 
     @staticmethod
-    def map(source: object, target: T) -> T | None:
+    def map(source: object, target: T, coerce: bool = True) -> T | None:
         """Map an object from one object to another"""
         source_dict: dict | object
         if isinstance(source, dict):
@@ -76,12 +76,26 @@ class Serialization:
             source_dict = Serialization.convert_object_to_dict(source)
             if not isinstance(source_dict, dict):
                 return None
-        return Serialization.load_properties(source_dict, target=target)
+        return Serialization.load_properties(
+            source=source_dict, target=target, coerce=coerce
+        )
 
     @staticmethod
-    def load_properties(source: dict, target: T) -> T | None:
+    def load_properties(
+        source: dict,
+        target: T,
+        coerce: bool = True,
+    ) -> T | None:
         """
-        Converts a source to an object
+        Converts a source dictionary to a target object.
+
+        Args:
+            source (dict): The source dictionary containing properties.
+            target (T): The target object to populate.
+            coerce (bool): If True, attempts to convert values to the target attribute types. If False, raises an error for type mismatches.
+
+        Returns:
+            T | None: The populated target object, or None if an error occurred.
         """
         # Ensure target is an instance of the class
         if isinstance(target, type):
@@ -95,28 +109,56 @@ class Serialization:
             setattr(target, "__actively_serializing_data__", True)
 
         for key, value in source.items():
-            if Serialization.has_attribute(target, key):  # hasattr(target, key):
+            if Serialization.has_attribute(target, key):
                 attr = getattr(target, key)
-                if isinstance(attr, (int, float, str, bool, type(None))):
-                    try:
+                expected_type = type(attr)
+
+                try:
+                    if isinstance(attr, (int, float, str, bool)):
+                        if not isinstance(value, expected_type):
+                            if coerce:
+                                # Attempt to coerce the value to the expected type
+                                try:
+                                    value = expected_type(value)
+                                except ValueError as e:
+                                    logger.warning(
+                                        f"Warning coercing attribute {key} with value {value}: {e}"
+                                    )
+                                    # TODO: should we set numbers to 0 or a NaN or raise an error
+
+                                    setattr(target, key, value)
+                                    # raise ValueError(  # pylint: disable=w0707
+                                    #     f"Type mismatch for attribute {key}. Expected {expected_type}, got {type(value)}."
+                                    # )
+                            else:
+                                raise ValueError(
+                                    f"Type mismatch for attribute {key}. Expected {expected_type}, got {type(value)}."
+                                )
+                        setattr(target, key, value)
+                    elif isinstance(attr, type(None)):
+                        setattr(target, key, value)
+                    elif isinstance(attr, list) and isinstance(value, list):
+                        attr.clear()
+                        attr.extend(value)
+                    elif isinstance(attr, dict) and isinstance(value, dict):
+                        Serialization.load_properties(value, attr, coerce=coerce)
+                    elif hasattr(attr, "__dict__") and isinstance(value, dict):
+                        Serialization.load_properties(value, attr, coerce=coerce)
+                    else:
                         setattr(target, key, value)
-                    except Exception as e:  # pylint: disable=w0718
-                        logger.error(
-                            f"Error setting attribute {key} with value {value}: {e}. "
-                            "This usually occurs on properties that don't have setters. "
-                            "You can add a setter (even with a pass action) for this property, "
-                            "decorate it with the @exclude_from_serialization "
-                            "or ignore this error. "
-                        )
-                elif isinstance(attr, list) and isinstance(value, list):
-                    attr.clear()
-                    attr.extend(value)
-                elif isinstance(attr, dict) and isinstance(value, dict):
-                    Serialization.load_properties(value, attr)
-                elif hasattr(attr, "__dict__") and isinstance(value, dict):
-                    Serialization.load_properties(value, attr)
-                else:
-                    setattr(target, key, value)
+                except ValueError as e:
+                    logger.error(
+                        f"Error setting attribute {key} with value {value}: {e}"
+                    )
+                    raise
+                except Exception as e:  # pylint: disable=w0718
+                    logger.error(
+                        f"Error setting attribute {key} with value {value}: {e}. "
+                        "This usually occurs on properties that don't have setters. "
+                        "You can add a setter (even with a pass action) for this property, "
+                        "decorate it with the @exclude_from_serialization "
+                        "or ignore this error. "
+                    )
 
         if hasattr(target, "__actively_serializing_data__"):
             setattr(target, "__actively_serializing_data__", False)

boto3_assist/version.py

@@ -1 +1 @@
-__version__ = '0.5.0'
+__version__ = '0.5.1'

{boto3_assist-0.5.0.dist-info → boto3_assist-0.5.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: boto3_assist
-Version: 0.5.0
+Version: 0.5.1
 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.5.0.dist-info → boto3_assist-0.5.1.dist-info}/RECORD

@@ -3,7 +3,7 @@ boto3_assist/boto3session.py,sha256=Q9sByNC0r_aMQfHnIEnxtTaiCMUqikm8UeSTxV7-Np0,
 boto3_assist/connection.py,sha256=CNGkAIRyfrELoWrV0ziQBA3oHacNFuLL3i8faUPRiO0,3486
 boto3_assist/connection_tracker.py,sha256=bfImvNVX-0Lhb-ombOurWUpNLdI0qVDil-kokBdIFkY,4345
 boto3_assist/http_status_codes.py,sha256=G0zRSWenwavYKETvDF9tNVUXQz3Ae2gXdBETYbjvJe8,3284
-boto3_assist/version.py,sha256=0PaI2eSOCp5kkNcpKpUSbLHf66rL9xQzFpYyLGpEtyM,22
+boto3_assist/version.py,sha256=s8Yq9Om1yBxrMA7xYQ5Y13Paeuxnq99NxhyjuPlnH6A,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
@@ -14,7 +14,7 @@ boto3_assist/cognito/cognito_authorizer.py,sha256=ONcxzjTACgVYl6qI9kJAQ5SoRMtVHY
 boto3_assist/cognito/cognito_connection.py,sha256=deuXR3cNHz0mCYff2k0LfAvK--9OkqehWp0Bl--lDuw,1607
 boto3_assist/cognito/cognito_utility.py,sha256=kjzd2PcCCP9GbxlMlgYEIQE1FSyPPjsRPjr6-kN08Jc,18238
 boto3_assist/cognito/jwks_cache.py,sha256=1Y9r-YfQ8qrgZN5xYPvjUEEV0vthbdcPdAIaPbZP7kU,373
-boto3_assist/cognito/user.py,sha256=H8Sgu1tSkd22flwGkAa_9Im2jYw5ra7YhVJdtcoFMOs,623
+boto3_assist/cognito/user.py,sha256=qc44qLx3gwq6q2zMxcPQze1EjeZwy5Kuav93vbe-4WU,820
 boto3_assist/dynamodb/dynamodb.py,sha256=q3U4uYqnKX1_u5TXv8Iq94JrBad16q0rL_vKxQyR_3k,15772
 boto3_assist/dynamodb/dynamodb_connection.py,sha256=x6Ylb_uVAY5TS0AIBUNOSyywKIqros3xX8diLTjZUsc,3275
 boto3_assist/dynamodb/dynamodb_helpers.py,sha256=ajpTJ5bJOm9PDgE2Zx9p2zkTRFV4xswqJRS81SOTn1s,12198
@@ -34,6 +34,7 @@ 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=8CunaU2YDWs9vK2BShShnyAdktmeZ3R_o7p8Yt70nYQ,829
 boto3_assist/s3/s3.py,sha256=DFCJs5z1mMIT8nZfnqPyr_cvhi9-FePuYH--tzD7b5E,17104
 boto3_assist/s3/s3_connection.py,sha256=FI1AhZV4UbTXQRTb4TqL9mv88Gt018rPZVFBvLetVAw,2163
 boto3_assist/utilities/datetime_utility.py,sha256=dgAMB9VqakrYIPXlSoVQiLSsc_yhrJK4gMfJO9mX90w,11112
@@ -42,10 +43,10 @@ boto3_assist/utilities/file_operations.py,sha256=Zy8fu8fpuVNf7U9NimrLdy5FRF71XSI
 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=vsipCQZu91hApkJ8tKRTxBa8kNRvn06ED-isquqAVQQ,5744
+boto3_assist/utilities/serialization_utility.py,sha256=p9QQfc6EDOtD-mB6Ujhv-BRpDn3DCCG2z5VmXG1kmb0,7768
 boto3_assist/utilities/string_utility.py,sha256=sBY80aQO-fTRanlHryZFMQBxdo6OvLRvnZjZrQepHlI,9283
-boto3_assist-0.5.0.dist-info/METADATA,sha256=PnVWeXj0gPTylAWn97RKzRoTN1bS6YSZdk4yRETGJaY,1728
-boto3_assist-0.5.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-boto3_assist-0.5.0.dist-info/licenses/LICENSE-EXPLAINED.txt,sha256=WFREvTpfTjPjDHpOLADxJpCKpIla3Ht87RUUGii4ODU,606
-boto3_assist-0.5.0.dist-info/licenses/LICENSE.txt,sha256=PXDhFWS5L5aOTkVhNvoitHKbAkgxqMI2uUPQyrnXGiI,1105
-boto3_assist-0.5.0.dist-info/RECORD,,
+boto3_assist-0.5.1.dist-info/METADATA,sha256=r5iNwKDiUS06CIskAGuHnpvW3wXfD97QznVQhe07jWQ,1728
+boto3_assist-0.5.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+boto3_assist-0.5.1.dist-info/licenses/LICENSE-EXPLAINED.txt,sha256=WFREvTpfTjPjDHpOLADxJpCKpIla3Ht87RUUGii4ODU,606
+boto3_assist-0.5.1.dist-info/licenses/LICENSE.txt,sha256=PXDhFWS5L5aOTkVhNvoitHKbAkgxqMI2uUPQyrnXGiI,1105
+boto3_assist-0.5.1.dist-info/RECORD,,