boto3-assist 0.9.5__py3-none-any.whl → 0.11.0__py3-none-any.whl

boto3_assist/cloudwatch/cloudwatch_connection_tracker.py

@@ -14,4 +14,4 @@ class CloudWatchConnectionTracker(ConnectionTracker):
     """
 
     def __init__(self) -> None:
-        super().__init__("CloudWatch")
+        super().__init__()

boto3_assist/cognito/cognito_utility.py

@@ -5,7 +5,7 @@ MIT License.  See Project Root for the license information.
 """
 
 import time
-from typing import List, Dict, Any, Optional
+from typing import List, Dict, Any, Optional, Literal
 
 
 from aws_lambda_powertools import Logger
@@ -130,7 +130,7 @@ class CognitoUtility(CognitoConnection):
                 is_permanent=True,
             )
 
-            return response
+            return dict(response)
 
         except self.client.exceptions.UsernameExistsException as e:
             logger.error(f"Error: {e.response['Error']['Message']}")
@@ -185,7 +185,7 @@ class CognitoUtility(CognitoConnection):
             UserPoolId=user_pool_id, Username=user_name
         )
 
-        return response
+        return dict(response)
 
     def admin_enable_user(
         self, user_name: str, user_pool_id: str, reset_password: bool = True
@@ -271,7 +271,7 @@ class CognitoUtility(CognitoConnection):
             logger.debug(
                 f"User {email} created successfully. Confirmation code sent to {email}."
             )
-            return response
+            return dict(response)
 
         except self.client.exceptions.UsernameExistsException as e:
             logger.error(f"Error: {e.response['Error']['Message']}")
@@ -324,11 +324,11 @@ class CognitoUtility(CognitoConnection):
         user_pool_id,
         client_name,
         id_token_time_out=60,
-        id_token_units="minutes",
+        id_token_units: Literal["days", "hours", "minutes", "seconds"] = "minutes",
         access_token_time_out=60,
-        access_token_units="minutes",
+        access_token_units: Literal["days", "hours", "minutes", "seconds"] = "minutes",
         refresh_token_time_out=60,
-        refresh_token_units="minutes",
+        refresh_token_units: Literal["days", "hours", "minutes", "seconds"] = "minutes",
     ) -> dict:
         # valid units: 'seconds'|'minutes'|'hours'|'days'
 
@@ -340,9 +340,9 @@ class CognitoUtility(CognitoConnection):
             AccessTokenValidity=access_token_time_out,
             IdTokenValidity=id_token_time_out,
             TokenValidityUnits={
-                "AccessToken": f"{access_token_units}",
-                "IdToken": f"{id_token_units}",
-                "RefreshToken": f"{refresh_token_units}",
+                "AccessToken": access_token_units,
+                "IdToken": id_token_units,
+                "RefreshToken": refresh_token_units,
             },
             # ReadAttributes=[
             #     'string',
@@ -381,18 +381,18 @@ class CognitoUtility(CognitoConnection):
             # AuthSessionValidity=123
         )
 
-        return response
+        return dict(response)
 
     def search_cognito(self, email: str, user_pool_id: str) -> dict:
         """Search cognito for an existing user"""
 
-        email = self.__format_email(email=email)
+        email = self.__format_email(email=email) or ""
         filter_string = f'email = "{email}"'
 
         # Call the admin_list_users method with the filter
         response = self.client.list_users(UserPoolId=user_pool_id, Filter=filter_string)
 
-        return response
+        return dict(response)
 
     def __set_user_attributes(self, *, user: CognitoUser) -> List[dict]:
         """

boto3_assist/dynamodb/dynamodb.py

@@ -7,7 +7,7 @@ MIT License.  See Project Root for the license information.
 import os
 from typing import List, Optional, overload, Dict, Any
 
-from aws_lambda_powertools import Tracer, Logger
+from aws_lambda_powertools import Logger
 from boto3.dynamodb.conditions import (
     Key,
     # And,
@@ -22,7 +22,7 @@ from boto3_assist.utilities.string_utility import StringUtility
 
 
 logger = Logger()
-tracer = Tracer()
+
 
 
 class DynamoDB(DynamoDBConnection):
@@ -55,7 +55,7 @@ class DynamoDB(DynamoDBConnection):
         )
         logger.setLevel(os.getenv("LOG_LEVEL", "INFO"))
 
-    @tracer.capture_method
+    
     def save(
         self,
         item: dict | DynamoDBModelBase,
@@ -169,7 +169,7 @@ class DynamoDB(DynamoDBConnection):
         call_type: str = "resource",
     ) -> Dict[str, Any]: ...
 
-    @tracer.capture_method
+    
     def get(
         self,
         key: Optional[dict] = None,
@@ -344,7 +344,7 @@ class DynamoDB(DynamoDBConnection):
     ) -> dict:
         pass
 
-    @tracer.capture_method
+    
     def delete(
         self,
         *,

boto3_assist/dynamodb/dynamodb_helpers.py

@@ -7,11 +7,11 @@ MIT License.  See Project Root for the license information.
 from typing import List, Any, Dict
 
 from boto3.dynamodb.conditions import ConditionBase, Key, And, Equals
-from aws_lambda_powertools import Tracer, Logger
+from aws_lambda_powertools import Logger
 from boto3_assist.dynamodb.dynamodb_index import DynamoDBIndex
 
 logger = Logger()
-tracer = Tracer()
+
 
 
 class DynamoDBHelpers:
@@ -118,7 +118,7 @@ class DynamoDBHelpers:
             logger.error({"exception": str(e)})
             return "unknown"
 
-    @tracer.capture_method(capture_response=False)
+    
     def wrap_response(self, items, dynamodb_response: dict, diagnostics) -> dict:
         """A wrapper for response data"""
         last_key = dynamodb_response.get("LastEvaluatedKey", None)
@@ -135,8 +135,7 @@ class DynamoDBHelpers:
         }
 
         return response
-
-    @tracer.capture_method(capture_response=False)
+    
     def wrap_collection_response(self, collection: List[dict]) -> dict[str, List]:
         """
         Wraps Up Some usefull information when dealing with

boto3_assist/dynamodb/dynamodb_model_base.py

@@ -249,6 +249,7 @@ class DynamoDBModelBase(SerializableModel):
         """
 
         value = DatetimeUtility.to_datetime_utc(value)
+        return value
 
 
 class DynamoDBSerializer:

boto3_assist/s3/s3_event_data.py

@@ -15,37 +15,37 @@ class EventData:
         self.__event = event
 
     @property
-    def version(self) -> str:
+    def version(self) -> str | None:
         """Event Version"""
         return self.__event.get("version")
 
     @property
-    def id(self) -> str:
+    def id(self) -> str | None:
         """Event Id"""
         return self.__event.get("id")
 
     @property
-    def detail_type(self) -> str:
+    def detail_type(self) -> str | None:
         """Event Detail Type"""
         return self.__event.get("detail-type")
 
     @property
-    def source(self) -> str:
+    def source(self) -> str | None:
         """Event Source"""
         return self.__event.get("source")
 
     @property
-    def account(self) -> str:
+    def account(self) -> str | None:
         """Event Account"""
         return self.__event.get("account")
 
     @property
-    def time(self) -> str:
+    def time(self) -> str | None:
         """Event Time"""
         return self.__event.get("time")
 
     @property
-    def region(self) -> str:
+    def region(self) -> str | None:
         """Event Region"""
         return self.__event.get("region")
 

boto3_assist/s3/s3_object.py

@@ -217,7 +217,7 @@ class S3Object:
         )
         try:
             # convert if necessary
-            file_obj: bytes = (
+            file_obj = (
                 file_obj.encode("utf-8") if isinstance(file_obj, str) else file_obj
             )
             self.connection.client.upload_fileobj(
@@ -658,7 +658,7 @@ class S3Object:
             Key=destination_key,
         )
 
-        return response
+        return dict(response)
 
     def move(
         self,

boto3_assist/securityhub/securityhub.py

@@ -5,7 +5,7 @@ MIT License.  See Project Root for the license information.
 """
 
 import os
-from typing import Optional
+from typing import Optional, Literal
 
 from aws_lambda_powertools import Logger
 
@@ -20,7 +20,7 @@ class SecurityHub(SecurityHubConnection):
     def update_findings_status(
         self,
         region_name: str,
-        workflow_status: str,
+        workflow_status: Literal["NEW", "NOTIFIED", "RESOLVED", "SUPPRESSED"],
         note_text: Optional[str] = None,
         updated_by: Optional[str] = None,
     ):

boto3_assist/utilities/datetime_utility.py

@@ -8,11 +8,11 @@ import uuid
 from datetime import UTC, datetime, timedelta, timezone
 from typing import Any
 import pytz  # type: ignore
-from aws_lambda_powertools import Tracer, Logger
+from aws_lambda_powertools import Logger
 from dateutil.relativedelta import relativedelta
 
 
-tracer = Tracer()
+
 logger = Logger()
 
 _last_timestamp = None
@@ -47,7 +47,7 @@ class DatetimeUtility:
         return datetime.now(timezone.utc)
 
     @staticmethod
-    @tracer.capture_method(capture_response=False)
+    
     def string_to_date(string_date: str | datetime) -> datetime | None:
         """
         Description: takes a string value and returns it as a datetime.

boto3_assist/utilities/serialization_utility.py

@@ -148,9 +148,11 @@ class JsonConversions:
         elif isinstance(data, list):
             # For lists, if deep conversion is enabled, process each element.
             return [
-                JsonConversions._convert_keys(item, convert_func, deep)
-                if deep
-                else item
+                (
+                    JsonConversions._convert_keys(item, convert_func, deep)
+                    if deep
+                    else item
+                )
                 for item in data
             ]
         else:
@@ -377,7 +379,10 @@ class Serialization:
             setattr(target, "__actively_serializing_data__", True)
 
         for key, value in source.items():
-            if Serialization.has_attribute(target, key):
+            if isinstance(target, dict):
+                # our target is a dictionary, so we need to handle this differently
+                target[key] = value
+            elif Serialization.has_attribute(target, key):
                 attr = getattr(target, key)
                 expected_type = type(attr)
 

boto3_assist/utilities/string_utility.py

@@ -313,6 +313,7 @@ class StringUtility:
                 return True
             if value in ("false", "0", "f", "n", "no"):
                 return False
+            raise ValueError(f"Invalid boolean value: {value}")
         elif isinstance(value, int):
             return bool(value)
         elif value is None:

boto3_assist/version.py

@@ -1 +1 @@
-__version__ = '0.9.5'
+__version__ = '0.11.0'

{boto3_assist-0.9.5.dist-info → boto3_assist-0.11.0.dist-info}/METADATA

@@ -1,13 +1,16 @@
 Metadata-Version: 2.4
 Name: boto3_assist
-Version: 0.9.5
+Version: 0.11.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
 License-File: LICENSE.txt
-Classifier: License :: Other/Proprietary License
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development
 Requires-Python: >=3.10
 Requires-Dist: aws-lambda-powertools
 Requires-Dist: aws-xray-sdk
@@ -23,6 +26,10 @@ Description-Content-Type: text/markdown
 
 # boto3 assist
 
+[![PyPI version](https://img.shields.io/pypi/v/boto3-assist.svg)](https://pypi.org/project/boto3-assist/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Downloads](https://static.pepy.tech/badge/boto3-assist)](https://pepy.tech/project/boto3-assist)
+
 This is in beta and subject to changes before it's initial 1.0.0 release
 
 This libary was created to make life a little easier when using boto3.
@@ -51,3 +58,19 @@ pip install boto3-assist
 
 ```
 
+## Running Unit Tests
+Several of our tests use a mocking library to simulate connections to S3, DynamoDB, etc.  In order to use those tests, you will need to have a `.env.unittest` file at the root of this project (which our tests will attempt to locate and load).  
+
+For your convenince the `.evn.unittest` file has been added to this project.  The values should not point to live AWS profiles, instead it should use the values added.
+
+Since we also point to a profile, you should create the profile in the `~/.aws/config` file.  The entry should look like the following:
+
+```toml
+[profile moto-mock-tests]
+region = us-east-1
+output = json
+aws_access_key_id = test
+aws_secret_access_key = test
+
+```
+

{boto3_assist-0.9.5.dist-info → boto3_assist-0.11.0.dist-info}/RECORD

@@ -3,27 +3,27 @@ boto3_assist/boto3session.py,sha256=JnZIRbut5R_C_r50bY2xiF6CjR93jQSOeVmhdK97mDg,
 boto3_assist/connection.py,sha256=-z_OZtZmSVjSSECpoqx1FnqW7B9A_LovfN_cJ_nhHgg,4361
 boto3_assist/connection_tracker.py,sha256=UgfR9RlvXf3A4ssMr3gDMpw89ka8mSRvJn4M34SzhbU,4378
 boto3_assist/http_status_codes.py,sha256=G0zRSWenwavYKETvDF9tNVUXQz3Ae2gXdBETYbjvJe8,3284
-boto3_assist/version.py,sha256=KdjdLD2Ih8isiZGr12GUg7fDzQKGgS2c2XOqkmiFJOM,22
+boto3_assist/version.py,sha256=UHGsGhGjMtfvoaFMaJdv4diSXG2uXo8Y2yCo7kiUOdk,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
-boto3_assist/cloudwatch/cloudwatch_connection_tracker.py,sha256=mzRtO1uHrcfJNh1XrGEiXdTqxwEP8d1RqJkraMNkgK0,410
+boto3_assist/cloudwatch/cloudwatch_connection_tracker.py,sha256=Y59WfjrB71qYlgmRngenElFEYHA35zK6DQkXY2anD5w,398
 boto3_assist/cloudwatch/cloudwatch_log_connection.py,sha256=qQMZHjUJ6gA8wU9utjQhOURXNSPH2RjxSoAy83bvoCs,1737
 boto3_assist/cloudwatch/cloudwatch_logs.py,sha256=VtI0OnFjX1l4RYVvA8tvveGkPwAogtrplnflZ4dQSNM,1204
 boto3_assist/cloudwatch/cloudwatch_query.py,sha256=uNhSb1Gfp99v8BaHmCnCKs63j4MMU4WveqBavCJyhGY,6409
 boto3_assist/cognito/cognito_authorizer.py,sha256=ONcxzjTACgVYl6qI9kJAQ5SoRMtVHYGDeuKi5QqJvOY,5837
 boto3_assist/cognito/cognito_connection.py,sha256=deuXR3cNHz0mCYff2k0LfAvK--9OkqehWp0Bl--lDuw,1607
-boto3_assist/cognito/cognito_utility.py,sha256=Vd9Fy_URJsG5IC87a19h0J7RE_bcrrTz1_80LzAZfvY,18237
+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=q3U4uYqnKX1_u5TXv8Iq94JrBad16q0rL_vKxQyR_3k,15772
+boto3_assist/dynamodb/dynamodb.py,sha256=ARbxuAQitqDBdEb_vHiRaC7x9nDMr71SgRA7tD6NVKk,15681
 boto3_assist/dynamodb/dynamodb_connection.py,sha256=x6Ylb_uVAY5TS0AIBUNOSyywKIqros3xX8diLTjZUsc,3275
-boto3_assist/dynamodb/dynamodb_helpers.py,sha256=ajpTJ5bJOm9PDgE2Zx9p2zkTRFV4xswqJRS81SOTn1s,12198
+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=D0Lq121qk1cXeMetPeqnzvv6CXd0XfEygfdUXaljLG8,8551
 boto3_assist/dynamodb/dynamodb_iservice.py,sha256=O9Aj0PFEvcuk2vhARifWTFnUwcQW5EXzwZS478Hm-N0,796
 boto3_assist/dynamodb/dynamodb_key.py,sha256=YD7o1EUlwVBQ55p9YCTKqAUU_np4nqtLIHnmp-BeolM,1803
-boto3_assist/dynamodb/dynamodb_model_base.py,sha256=Jmy0GAblYqdLlVOT7H-1li50bacemeduocgNs75Yvt8,11910
+boto3_assist/dynamodb/dynamodb_model_base.py,sha256=OoSZ841YLHWTV_yx8MvVc6oHZEnvdqTYPhH9LTZ4M_M,11931
 boto3_assist/dynamodb/dynamodb_model_base_interfaces.py,sha256=yT4zDRI8vP15WVOHnCvY3FsEy_QSIta5-bnUby70Xow,747
 boto3_assist/dynamodb/dynamodb_reindexer.py,sha256=bCj6KIU0fQOgjkkiq9yF51PFZZr4Y9Lu3-hPlmsPG0Y,6164
 boto3_assist/dynamodb/dynamodb_reserved_words.py,sha256=p0irNBSqGe4rd2FwWQqbRJWrNr4svdbWiyIXmz9lj4c,1937
@@ -39,22 +39,22 @@ boto3_assist/models/serializable_model.py,sha256=ZMrRJRvJWLY8PBSKK_nPCgYKv1qUxDP
 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_event_data.py,sha256=vwty34zDgTeSLNCLAWVxvhSQKT7hIpM7fZrWm5w6znM,4063
-boto3_assist/s3/s3_object.py,sha256=MsDjp-TlAHjONNZznGT_VT_ls_z9OSSovxBUxFimLus,22519
-boto3_assist/securityhub/securityhub.py,sha256=nGmHd_R3awDeB_QRzPfNAtQauLdVA1hlRlkaZA4oZjg,5409
+boto3_assist/s3/s3_event_data.py,sha256=Q7QUI1pwkc7g6yZ3IZWMXBIAfsMlPRC7wac2RvrQoA4,4112
+boto3_assist/s3/s3_object.py,sha256=77jZeIUFpQX3cFYGGwRFBvL-peCe54iILnthm-GFjMc,22518
+boto3_assist/securityhub/securityhub.py,sha256=ne-J_v4DaCVZm5YgJa_-LKVomLJQo5Gpw6wleAKSsws,5467
 boto3_assist/securityhub/securityhub_connection.py,sha256=hWfcj9gjS2lNXUObyw4cShtveoqJPIp8kKFuz-fz1J4,1449
 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=o4k_0tTQmgBty5tnJRCG5j_SH_XQIrX-iLc6w0rbWVI,11221
+boto3_assist/utilities/datetime_utility.py,sha256=kxUV-pYraTx18gaRb2LxXB7sRTBxffgksdOszcM3fg8,11150
 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
 boto3_assist/utilities/logging_utility.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 boto3_assist/utilities/numbers_utility.py,sha256=wzv9d0uXT_2_ZHHio7LBzibwxPqhGpvbq9HinrVn_4A,10160
-boto3_assist/utilities/serialization_utility.py,sha256=dP93TrMQzCbJXXMI7O1HNQOfKZuHyBLwdtuDQyvnlA8,21519
-boto3_assist/utilities/string_utility.py,sha256=5BpDaqGZI8cSM-3YFQLU1fKcWcqG9r1_GPgDstCWFIs,10318
-boto3_assist-0.9.5.dist-info/METADATA,sha256=oSBjbWCQpAQMGiII6jHNGcE4OCOS-MvXXpqWIGp9CbY,1728
-boto3_assist-0.9.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-boto3_assist-0.9.5.dist-info/licenses/LICENSE-EXPLAINED.txt,sha256=WFREvTpfTjPjDHpOLADxJpCKpIla3Ht87RUUGii4ODU,606
-boto3_assist-0.9.5.dist-info/licenses/LICENSE.txt,sha256=PXDhFWS5L5aOTkVhNvoitHKbAkgxqMI2uUPQyrnXGiI,1105
-boto3_assist-0.9.5.dist-info/RECORD,,
+boto3_assist/utilities/serialization_utility.py,sha256=nieqW9b71Dr0X2HPsNmCei6zoIbsPRl9fDAigBQkaUg,21730
+boto3_assist/utilities/string_utility.py,sha256=0ChxbuT37xdG4y3cKzbNTHk4T3fl8lNMdOT7L5aJBQk,10382
+boto3_assist-0.11.0.dist-info/METADATA,sha256=bXUuUsYCrxXCm125R0K6pI13n3oh8rfRdJPj9mNrCdA,2875
+boto3_assist-0.11.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+boto3_assist-0.11.0.dist-info/licenses/LICENSE-EXPLAINED.txt,sha256=WFREvTpfTjPjDHpOLADxJpCKpIla3Ht87RUUGii4ODU,606
+boto3_assist-0.11.0.dist-info/licenses/LICENSE.txt,sha256=PXDhFWS5L5aOTkVhNvoitHKbAkgxqMI2uUPQyrnXGiI,1105
+boto3_assist-0.11.0.dist-info/RECORD,,