boto3-assist 0.28.0__py3-none-any.whl → 0.29.0__py3-none-any.whl

boto3_assist/dynamodb/dynamodb.py

@@ -21,6 +21,7 @@ from .dynamodb_connection import DynamoDBConnection
 from .dynamodb_helpers import DynamoDBHelpers
 from .dynamodb_model_base import DynamoDBModelBase
 from ..utilities.string_utility import StringUtility
+from ..utilities.decimal_conversion_utility import DecimalConversionUtility
 from .dynamodb_index import DynamoDBIndex
 
 logger = Logger()
@@ -51,17 +52,34 @@ class DynamoDB(DynamoDBConnection):
             aws_region=aws_region,
             aws_end_point_url=aws_end_point_url,
             aws_access_key_id=aws_access_key_id,
-            aws_secret_access_key=aws_secret_access_key,
             assume_role_arn=assume_role_arn,
             assume_role_chain=assume_role_chain,
             assume_role_duration_seconds=assume_role_duration_seconds,
         )
         self.helpers: DynamoDBHelpers = DynamoDBHelpers()
-        self.log_dynamodb_item_size = (
-            str(os.getenv("LOG_DYNAMODB_ITEM_SIZE", "false")).lower() == "true"
+        self.log_dynamodb_item_size: bool = bool(
+            os.getenv("LOG_DYNAMODB_ITEM_SIZE", "False").lower() == "true"
+        )
+        self.convert_decimals: bool = bool(
+            os.getenv("DYNAMODB_CONVERT_DECIMALS", "True").lower() == "true"
         )
         logger.setLevel(os.getenv("LOG_LEVEL", "INFO"))
 
+    def _apply_decimal_conversion(self, response: Dict[str, Any]) -> Dict[str, Any]:
+        """
+        Apply decimal conversion to DynamoDB response if enabled.
+        
+        Args:
+            response: The DynamoDB response dictionary
+            
+        Returns:
+            The response with decimal conversion applied if enabled
+        """
+        if not self.convert_decimals:
+            return response
+            
+        return DecimalConversionUtility.convert_decimals_to_native_types(response)
+
     def save(
         self,
         item: dict | DynamoDBModelBase,
@@ -283,7 +301,8 @@ class DynamoDB(DynamoDBConnection):
             if self.raise_on_error:
                 raise e
 
-        return response
+        # Apply decimal conversion to the response
+        return self._apply_decimal_conversion(response)
 
     def update_item(
         self,
@@ -391,7 +410,8 @@ class DynamoDB(DynamoDBConnection):
             if self.raise_on_error:
                 raise e
 
-        return response
+        # Apply decimal conversion to the response
+        return self._apply_decimal_conversion(response)
 
     @overload
     def delete(self, *, table_name: str, model: DynamoDBModelBase) -> dict:

boto3_assist/dynamodb/dynamodb_model_base.py

@@ -11,8 +11,9 @@ import datetime as dt
 # import inspect
 # import uuid
 from typing import TypeVar, List, Dict, Any
-from boto3.dynamodb.types import TypeSerializer
+from boto3.dynamodb.types import TypeSerializer, TypeDeserializer
 from boto3_assist.utilities.serialization_utility import Serialization
+from boto3_assist.utilities.decimal_conversion_utility import DecimalConversionUtility
 from boto3_assist.dynamodb.dynamodb_helpers import DynamoDBHelpers
 from boto3_assist.dynamodb.dynamodb_index import (
     DynamoDBIndexes,
@@ -156,14 +157,20 @@ class DynamoDBModelBase(SerializableModel):
             item = item.to_resource_dictionary()
 
         if isinstance(item, dict):
-            # see if this is coming directly from dynamodb
+            # Handle DynamoDB response structures
             if "ResponseMetadata" in item:
+                # Full DynamoDB response with metadata
                 response: dict | None = item.get("Item")
-
                 if response is None:
                     response = {}
-
                 item = response
+            elif "Item" in item and not any(key in item for key in ["id", "name", "pk", "sk"]):
+                # Response with Item key but no direct model attributes (likely a DynamoDB response)
+                # This handles cases like {'Item': {...}} or {'Item': {...}, 'Count': 1}
+                item = item.get("Item", {})
+            
+            # Convert any Decimal objects to native Python types for easier handling
+            item = DecimalConversionUtility.convert_decimals_to_native_types(item)
 
         else:
             raise ValueError("Item must be a dictionary or DynamoDBModelBase")
@@ -283,6 +290,7 @@ class DynamoDBSerializer:
 
         return mapped
 
+
     @staticmethod
     def to_client_dictionary(
         instance: DynamoDBModelBase, include_indexes: bool = True

boto3_assist/utilities/decimal_conversion_utility.py

@@ -0,0 +1,140 @@
+"""
+Geek Cafe, LLC
+Maintainers: Eric Wilson
+MIT License.  See Project Root for the license information.
+"""
+
+from decimal import Decimal
+from typing import Any, Dict, List, Union
+
+
+class DecimalConversionUtility:
+    """
+    Utility class for handling decimal conversions between Python types and DynamoDB.
+    
+    DynamoDB stores all numbers as Decimal types, but Python applications often
+    expect int or float types. This utility provides conversion methods to handle
+    the transformation seamlessly.
+    """
+
+    @staticmethod
+    def convert_decimals_to_native_types(data: Any) -> Any:
+        """
+        Recursively converts Decimal objects to native Python types (int or float).
+        
+        This is typically used when deserializing data from DynamoDB, where all
+        numbers are stored as Decimal objects but the application expects native
+        Python numeric types.
+        
+        Args:
+            data: The data structure to convert. Can be dict, list, or any other type.
+            
+        Returns:
+            The data structure with Decimal objects converted to int or float.
+        """
+        if isinstance(data, dict):
+            return {
+                key: DecimalConversionUtility.convert_decimals_to_native_types(value)
+                for key, value in data.items()
+            }
+        elif isinstance(data, list):
+            return [
+                DecimalConversionUtility.convert_decimals_to_native_types(item)
+                for item in data
+            ]
+        elif isinstance(data, Decimal):
+            # Convert Decimal to int if it's a whole number, otherwise to float
+            if data % 1 == 0:
+                return int(data)
+            else:
+                return float(data)
+        else:
+            return data
+
+    @staticmethod
+    def convert_native_types_to_decimals(data: Any) -> Any:
+        """
+        Recursively converts native Python numeric types (int, float) to Decimal objects.
+        
+        This is typically used when serializing data for DynamoDB, where all
+        numbers should be stored as Decimal objects for precision.
+        
+        Args:
+            data: The data structure to convert. Can be dict, list, or any other type.
+            
+        Returns:
+            The data structure with int and float objects converted to Decimal.
+        """
+        if isinstance(data, dict):
+            return {
+                key: DecimalConversionUtility.convert_native_types_to_decimals(value)
+                for key, value in data.items()
+            }
+        elif isinstance(data, list):
+            return [
+                DecimalConversionUtility.convert_native_types_to_decimals(item)
+                for item in data
+            ]
+        elif isinstance(data, float):
+            # Convert float to Decimal using string representation for precision
+            return Decimal(str(data))
+        elif isinstance(data, int) and not isinstance(data, bool):
+            # Convert int to Decimal, but exclude bool (which is a subclass of int)
+            return Decimal(data)
+        else:
+            return data
+
+    @staticmethod
+    def is_numeric_type(value: Any) -> bool:
+        """
+        Check if a value is a numeric type (int, float, or Decimal).
+        
+        Args:
+            value: The value to check.
+            
+        Returns:
+            True if the value is a numeric type, False otherwise.
+        """
+        return isinstance(value, (int, float, Decimal)) and not isinstance(value, bool)
+
+    @staticmethod
+    def safe_decimal_conversion(value: Any, default: Any = None) -> Union[Decimal, Any]:
+        """
+        Safely convert a value to Decimal, returning a default if conversion fails.
+        
+        Args:
+            value: The value to convert to Decimal.
+            default: The default value to return if conversion fails.
+            
+        Returns:
+            Decimal representation of the value, or the default if conversion fails.
+        """
+        try:
+            if isinstance(value, Decimal):
+                return value
+            elif isinstance(value, (int, float)):
+                return Decimal(str(value))
+            elif isinstance(value, str):
+                return Decimal(value)
+            else:
+                return default
+        except (ValueError, TypeError, ArithmeticError):
+            return default
+
+    @staticmethod
+    def format_decimal_for_display(value: Decimal, precision: int = 2) -> str:
+        """
+        Format a Decimal value for display with specified precision.
+        
+        Args:
+            value: The Decimal value to format.
+            precision: Number of decimal places to display.
+            
+        Returns:
+            Formatted string representation of the Decimal.
+        """
+        if not isinstance(value, Decimal):
+            value = DecimalConversionUtility.safe_decimal_conversion(value, Decimal('0'))
+        
+        format_string = f"{{:.{precision}f}}"
+        return format_string.format(float(value))

boto3_assist/version.py

@@ -1 +1 @@
-__version__ = "0.28.0"
+__version__ = "0.29.0"

{boto3_assist-0.28.0.dist-info → boto3_assist-0.29.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: boto3_assist
-Version: 0.28.0
+Version: 0.29.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.28.0.dist-info → boto3_assist-0.29.0.dist-info}/RECORD

@@ -6,7 +6,7 @@ boto3_assist/connection_tracker.py,sha256=UgfR9RlvXf3A4ssMr3gDMpw89ka8mSRvJn4M34
 boto3_assist/http_status_codes.py,sha256=G0zRSWenwavYKETvDF9tNVUXQz3Ae2gXdBETYbjvJe8,3284
 boto3_assist/role_assumption_mixin.py,sha256=PMUU5yC2FUBjFD1UokVkRY3CPB5zTw85AhIB5BMtbc8,1031
 boto3_assist/session_setup_mixin.py,sha256=X-JQKyyaWNA8Z8kKgf2V2I5vsiLAH8udLTX_xepnsdQ,3140
-boto3_assist/version.py,sha256=MRQGtOXBhcDKeeNOL0LiB-cllo6kfd8_KGJOvaDp0XQ,23
+boto3_assist/version.py,sha256=RvbohpnoJRSLAwJOFoWTtu5c5Vpi5vWAfsKR12hwJVI,23
 boto3_assist/aws_lambda/event_info.py,sha256=OkZ4WzuGaHEu_T8sB188KBgShAJhZpWASALKRGBOhMg,14648
 boto3_assist/aws_lambda/mock_context.py,sha256=LPjHP-3YSoY6iPl1kPqJDwSVf1zLNTcukUunDtYcbK0,116
 boto3_assist/cloudwatch/cloudwatch_connection.py,sha256=mnGWaLSQpHh5EeY7Ek_2o9JKHJxOELIYtQVMX1IaHn4,2480
@@ -19,14 +19,14 @@ boto3_assist/cognito/cognito_connection.py,sha256=deuXR3cNHz0mCYff2k0LfAvK--9Okq
 boto3_assist/cognito/cognito_utility.py,sha256=IVZAg58nHG1U7uxe7FsTYpqwwZiwwdIBGiVTZuLCFqg,18417
 boto3_assist/cognito/jwks_cache.py,sha256=1Y9r-YfQ8qrgZN5xYPvjUEEV0vthbdcPdAIaPbZP7kU,373
 boto3_assist/cognito/user.py,sha256=qc44qLx3gwq6q2zMxcPQze1EjeZwy5Kuav93vbe-4WU,820
-boto3_assist/dynamodb/dynamodb.py,sha256=TiO1lnQGiWxaWZ5-nnaWMMThFl3PMkD2r5ApIxEhBC8,18495
+boto3_assist/dynamodb/dynamodb.py,sha256=vZvGerbiUy3J9KYjHHcoU97F_Fi85HYMK1KOzdMebc0,19330
 boto3_assist/dynamodb/dynamodb_connection.py,sha256=D4KmVpMpE0OuVOwW5g4JBWllUNkwy0hMXEGUiToAMBc,3608
 boto3_assist/dynamodb/dynamodb_helpers.py,sha256=RoRRqKjdwfC-2-gvlkLvCoNWhIoMrHm-68dkyhXI_Xk,12080
 boto3_assist/dynamodb/dynamodb_importer.py,sha256=nCKsyRQeMqDSf0Q5mQ_X_oVIg4PRnu0hcUzZnBli610,3471
 boto3_assist/dynamodb/dynamodb_index.py,sha256=MKQU4837rjYExMGCucGe2HBkPQPGszb8O6LR9EZBqek,8902
 boto3_assist/dynamodb/dynamodb_iservice.py,sha256=O9Aj0PFEvcuk2vhARifWTFnUwcQW5EXzwZS478Hm-N0,796
 boto3_assist/dynamodb/dynamodb_key.py,sha256=4IYnG4a99AjdOKUcDaWhNF_lvZJRZcKOIPzBQQzVdB0,3294
-boto3_assist/dynamodb/dynamodb_model_base.py,sha256=Bgnjs62lHTqqJ2nZbPV1JHvcK6d2-aaRsJtcc8DEqKk,12291
+boto3_assist/dynamodb/dynamodb_model_base.py,sha256=SjV43lkP14YjfCH7j9KfEZAC89FYV3MLM6Ci40vTccY,12952
 boto3_assist/dynamodb/dynamodb_model_base_interfaces.py,sha256=SFw-yK7TDPL4cK52bpn2zMm5G4mX7eYNU7eFytEw0-A,749
 boto3_assist/dynamodb/dynamodb_re_indexer.py,sha256=Y0qRrvpmjS68w8ci6Au7Hg02W_ktqhUGGALeN-9XTls,6164
 boto3_assist/dynamodb/dynamodb_reindexer.py,sha256=bCj6KIU0fQOgjkkiq9yF51PFZZr4Y9Lu3-hPlmsPG0Y,6164
@@ -52,6 +52,7 @@ boto3_assist/securityhub/securityhub_connection.py,sha256=hWfcj9gjS2lNXUObyw4cSh
 boto3_assist/ssm/connection.py,sha256=gYpKn5HsUR3hcRUqJzF5QcTITCk0DReq9KhoE_8-Htg,1370
 boto3_assist/ssm/parameter_store/parameter_store.py,sha256=2ISi-SmR29mESHFH-onJkxPX1aThIgBRojA3ZoNcP9s,3949
 boto3_assist/utilities/datetime_utility.py,sha256=yQa9winN661Gt837zeQQWl4ARMYtZcU4pQEYMnTESC0,11171
+boto3_assist/utilities/decimal_conversion_utility.py,sha256=E87lXpgOTDQpHU2wCE916YzNQeIFSc_nl02le0o9v4E,5037
 boto3_assist/utilities/dictionary_utility.py,sha256=IrN5Q3gJ_KWQ_3KCjyXEJyV8oLk2n3tQOO52dVbY6sk,1002
 boto3_assist/utilities/file_operations.py,sha256=IYhJkh8wUPMvGnyDRRa9yOCDdHN9wR3N6m_xpJS51TM,3949
 boto3_assist/utilities/http_utility.py,sha256=_K39Fq0V4QcgklAWctUktuMjqXDTwgMld77IOUfR2zc,1282
@@ -59,8 +60,8 @@ boto3_assist/utilities/logging_utility.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5N
 boto3_assist/utilities/numbers_utility.py,sha256=wzv9d0uXT_2_ZHHio7LBzibwxPqhGpvbq9HinrVn_4A,10160
 boto3_assist/utilities/serialization_utility.py,sha256=m5wRZNeWW9VltQPVNziR27OGKO3MDJm6mFmcDHwN-n4,24479
 boto3_assist/utilities/string_utility.py,sha256=XxUIz19L2LFFTRDAAmdPa8Qhn40u9yO7g4nULFuvg0M,11033
-boto3_assist-0.28.0.dist-info/METADATA,sha256=XrwSSxvnnUASG0OPp4ulP99LgF8CTTcwExXgXbZG1UE,2879
-boto3_assist-0.28.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-boto3_assist-0.28.0.dist-info/licenses/LICENSE-EXPLAINED.txt,sha256=WFREvTpfTjPjDHpOLADxJpCKpIla3Ht87RUUGii4ODU,606
-boto3_assist-0.28.0.dist-info/licenses/LICENSE.txt,sha256=PXDhFWS5L5aOTkVhNvoitHKbAkgxqMI2uUPQyrnXGiI,1105
-boto3_assist-0.28.0.dist-info/RECORD,,
+boto3_assist-0.29.0.dist-info/METADATA,sha256=LqQDqSXK3yioOtRe_GZipXzZKhY56CeWJlPECd2ZSsg,2879
+boto3_assist-0.29.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+boto3_assist-0.29.0.dist-info/licenses/LICENSE-EXPLAINED.txt,sha256=WFREvTpfTjPjDHpOLADxJpCKpIla3Ht87RUUGii4ODU,606
+boto3_assist-0.29.0.dist-info/licenses/LICENSE.txt,sha256=PXDhFWS5L5aOTkVhNvoitHKbAkgxqMI2uUPQyrnXGiI,1105
+boto3_assist-0.29.0.dist-info/RECORD,,