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

boto3_assist/connection_tracker.py

@@ -1,80 +1,120 @@
 """
 Geek Cafe, LLC
 Maintainers: Eric Wilson
-MIT License.  See Project Root for the license information.
+MIT License. See Project Root for the license information.
 """
 
 import traceback
 import os
+from typing import Dict
 
 
 class ConnectionTracker:
     """
-    Tracks Connection Requests.
-    Useful in for performance tuning and debugging.
+    Tracks Boto3 connection requests for performance tuning and debugging.
+
+    Attributes:
+        __stack_trace_env_var (str): Environment variable name to enable stack trace logging.
+        __issue_stack_trace (bool | None): Caches the result of whether stack trace logging is enabled.
+        __connection_counter (Dict[str, int]): Tracks the number of connections per service.
     """
 
-    def __init__(self, service_name: str) -> None:
+    def __init__(self) -> None:
         self.__stack_trace_env_var: str = "BOTO3_ASSIST_CONNECTION_STACK_TRACE"
-        self.__connection_counter: int = 0
-        self.__service_name: str = service_name
         self.__issue_stack_trace: bool | None = None
+        self.__connection_counter: Dict[str, int] = {}
+
+    def add(self, service_name: str) -> None:
+        """
+        Increments the connection count for a given service and
+        performs a check on the number of connections.
+
+        Args:
+            service_name (str): Name of the AWS service.
+        """
+        self.__connection_counter[service_name] = (
+            self.__connection_counter.get(service_name, 0) + 1
+        )
+
+        self.check(service_name=service_name)
 
     @property
     def issue_stack_trace(self) -> bool:
-        """Returns True if the stack trace should be issued"""
+        """
+        Checks if stack trace logging is enabled by the environment variable.
+
+        Returns:
+            bool: True if stack trace logging is enabled, False otherwise.
+        """
         if self.__issue_stack_trace is None:
             self.__issue_stack_trace = (
                 os.getenv(self.__stack_trace_env_var, "").lower() == "true"
             )
         return self.__issue_stack_trace
 
-    def increment_connection(self) -> None:
-        """Increments the connection counter"""
-        self.__connection_counter += 1
+    def check(self, service_name: str) -> None:
+        """
+        Checks the connection count for a service and logs warnings if needed.
 
-        if self.connection_count > 1:
-            service_message = ""
-            stack_trace_message = ""
-            if self.__service_name:
-                service_message = f"Your {self.__service_name} service has more than one connection.\n"
+        Args:
+            service_name (str): Name of the AWS service.
+        """
+        connection_count = self.__connection_counter.get(service_name, 0)
+        if connection_count > 1:
+            service_message = (
+                f"Your {service_name} service has more than one connection.\n"
+            )
 
             if not self.issue_stack_trace:
                 stack_trace_message = (
-                    f"\nTo add addtional information to the log and determine where additional connections are being created"
-                    f", set the environment variable {self.__stack_trace_env_var} to true.\n"
+                    f"\nTo add additional information to the log and determine where additional connections are being created, "
+                    f"set the environment variable {self.__stack_trace_env_var} to true.\n"
                 )
             else:
                 stack = "\n".join(traceback.format_stack())
                 stack_trace_message = (
-                    f"\nStack Trace Enabeld with {self.__stack_trace_env_var}"
-                    f"\n{stack}"
+                    f"\nStack Trace Enabled with {self.__stack_trace_env_var}\n{stack}"
                 )
 
             self.__log_warning(
                 f"{service_message}"
-                f"Your boto3 connection count is {self.connection_count}. "
-                "Under most circumstances you should be able to use the same connection "
-                "vs. creating a new one.  Connections are expensive in terms of time / latency. "
-                "If you are seeing perforance issues, check how and where you are creating your "
-                "connections.  You should be able to pass the connection to your other objects "
+                f"Your boto3 connection count is {connection_count}. "
+                "Under most circumstances, you should be able to use the same connection "
+                "instead of creating a new one. Connections are expensive in terms of time and latency. "
+                "If you are seeing performance issues, check how and where you are creating your "
+                "connections. You should be able to pass the connection to your other objects "
                 "and reuse your boto3 connections."
+                "\n\nMOCK Testing may show this message as well, in which case you can dismiss this warning.\n\n"
                 f"{stack_trace_message}"
             )
 
-    def decrement_connection(self) -> None:
-        """Decrements the connection counter"""
-        self.__connection_counter -= 1
+    def decrement_connection(self, service_name: str) -> None:
+        """
+        Decrements the connection count for a service.
 
-    @property
-    def connection_count(self) -> int:
-        """Returns the current connection count"""
-        return self.__connection_counter
+        Args:
+            service_name (str): Name of the AWS service.
+        """
+        if (
+            service_name in self.__connection_counter
+            and self.__connection_counter[service_name] > 0
+        ):
+            self.__connection_counter[service_name] -= 1
 
-    def reset(self) -> None:
-        """Resets the connection counter"""
-        self.__connection_counter = 0
+    def reset(self, service_name: str) -> None:
+        """
+        Resets the connection count for a service to zero.
+
+        Args:
+            service_name (str): Name of the AWS service.
+        """
+        self.__connection_counter[service_name] = 0
 
     def __log_warning(self, message: str) -> None:
-        """Logs a warning message"""
+        """
+        Logs a warning message.
+
+        Args:
+            message (str): The warning message to log.
+        """
         print(f"Warning: {message}")

boto3_assist/dynamodb/dynamodb_connection.py

@@ -8,11 +8,8 @@ from typing import Optional
 from typing import TYPE_CHECKING
 
 from aws_lambda_powertools import Logger
-from boto3_assist.boto3session import Boto3SessionManager
-from boto3_assist.environment_services.environment_variables import (
-    EnvironmentVariables,
-)
-from boto3_assist.dynamodb.dynamodb_connection_tracker import DynamoDBConnectionTracker
+from boto3_assist.connection import Connection
+
 
 if TYPE_CHECKING:
     from mypy_boto3_dynamodb import DynamoDBClient, DynamoDBServiceResource
@@ -22,10 +19,9 @@ else:
 
 
 logger = Logger()
-tracker: DynamoDBConnectionTracker = DynamoDBConnectionTracker()
 
 
-class DynamoDBConnection:
+class DynamoDBConnection(Connection):
     """DB Environment"""
 
     def __init__(
@@ -37,66 +33,20 @@ class DynamoDBConnection:
         aws_access_key_id: Optional[str] = None,
         aws_secret_access_key: Optional[str] = None,
     ) -> None:
-        self.aws_profile = aws_profile or EnvironmentVariables.AWS.profile()
-        self.aws_region = aws_region or EnvironmentVariables.AWS.region()
-        self.end_point_url = (
-            aws_end_point_url or EnvironmentVariables.AWS.DynamoDB.endpoint_url()
-        )
-        self.aws_access_key_id = (
-            aws_access_key_id or EnvironmentVariables.AWS.DynamoDB.aws_access_key_id()
-        )
-        self.aws_secret_access_key = (
-            aws_secret_access_key
-            or EnvironmentVariables.AWS.DynamoDB.aws_secret_access_key()
+        super().__init__(
+            service_name="dynamodb",
+            aws_profile=aws_profile,
+            aws_region=aws_region,
+            aws_access_key_id=aws_access_key_id,
+            aws_secret_access_key=aws_secret_access_key,
+            aws_end_point_url=aws_end_point_url,
         )
-        self.__session: Boto3SessionManager | None = None
+
         self.__dynamodb_client: DynamoDBClient | None = None
         self.__dynamodb_resource: DynamoDBServiceResource | None = None
 
         self.raise_on_error: bool = True
 
-    def setup(self, setup_source: Optional[str] = None) -> None:
-        """
-        Setup the environment.  Automatically called via init.
-        You can run setup at anytime with new parameters.
-        Args: setup_source: Optional[str] = None
-            Defines the source of the setup.  Useful for logging.
-        Returns: None
-        """
-
-        logger.info(
-            {
-                "metric_filter": "db_connection_setup",
-                "source": "DynamoDBConnection",
-                "aws_profile": self.aws_profile,
-                "aws_region": self.aws_region,
-                "setup_source": setup_source,
-            }
-        )
-
-        self.__session = Boto3SessionManager(
-            service_name="dynamodb",
-            aws_profile=self.aws_profile,
-            aws_region=self.aws_region,
-            aws_access_key_id=self.aws_access_key_id,
-            aws_secret_access_key=self.aws_secret_access_key,
-            aws_endpoint_url=self.end_point_url,
-        )
-
-        tracker.increment_connection()
-
-        self.raise_on_error = EnvironmentVariables.AWS.DynamoDB.raise_on_error_setting()
-
-    @property
-    def session(self) -> Boto3SessionManager:
-        """Session"""
-        if self.__session is None:
-            self.setup(setup_source="session init")
-
-        if self.__session is None:
-            raise RuntimeError("Session is not available")
-        return self.__session
-
     @property
     def client(self) -> DynamoDBClient:
         """DynamoDB Client Connection"""

boto3_assist/ec2/ec2_connection.py

@@ -8,24 +8,20 @@ from typing import Optional
 from typing import TYPE_CHECKING
 
 from aws_lambda_powertools import Logger
-from boto3_assist.boto3session import Boto3SessionManager
-from boto3_assist.environment_services.environment_variables import (
-    EnvironmentVariables,
-)
-from boto3_assist.connection_tracker import ConnectionTracker
+
+from boto3_assist.connection import Connection
 
 if TYPE_CHECKING:
     from mypy_boto3_ec2 import Client
 else:
     Client = object
 
-SERVICE_NAME = "ec2"
+
 logger = Logger()
-tracker: ConnectionTracker = ConnectionTracker(service_name=SERVICE_NAME)
 
 
-class EC2Connection:
-    """DB Environment"""
+class EC2Connection(Connection):
+    """EC2 Connection"""
 
     def __init__(
         self,
@@ -35,69 +31,24 @@ class EC2Connection:
         aws_access_key_id: Optional[str] = None,
         aws_secret_access_key: Optional[str] = None,
     ) -> None:
-        self.aws_profile = aws_profile
-        self.aws_region = aws_region
+        super().__init__(
+            service_name="ec2",
+            aws_profile=aws_profile,
+            aws_region=aws_region,
+            aws_access_key_id=aws_access_key_id,
+            aws_secret_access_key=aws_secret_access_key,
+        )
 
-        self.aws_access_key_id = aws_access_key_id
-        self.aws_secret_access_key = aws_secret_access_key
-        self.__session: Boto3SessionManager | None = None
         self.__client: Client | None = None
 
         self.raise_on_error: bool = True
 
-    def setup(self, setup_source: Optional[str] = None) -> None:
-        """
-        Setup the environment.  Automatically called via init.
-        You can run setup at anytime with new parameters.
-        Args: setup_source: Optional[str] = None
-            Defines the source of the setup.  Useful for logging.
-        Returns: None
-        """
-
-        logger.info(
-            {
-                "metric_filter": "connection_setup",
-                "source": "setup",
-                "aws_profile": self.aws_profile,
-                "aws_region": self.aws_region,
-                "setup_source": setup_source,
-            }
-        )
-
-        # lazy load the session
-        self.__session = Boto3SessionManager(
-            service_name=SERVICE_NAME,
-            aws_profile=self.aws_profile,
-            aws_region=self.aws_region or EnvironmentVariables.AWS.region(),
-            aws_access_key_id=self.aws_access_key_id
-            or EnvironmentVariables.AWS.aws_access_key_id(),
-            aws_secret_access_key=self.aws_secret_access_key
-            or EnvironmentVariables.AWS.aws_secret_access_key(),
-        )
-
-        tracker.increment_connection()
-
-        self.raise_on_error = EnvironmentVariables.AWS.DynamoDB.raise_on_error_setting()
-
-    @property
-    def session(self) -> Boto3SessionManager:
-        """Session"""
-        if self.__session is None:
-            self.setup(setup_source="session init")
-
-        if self.__session is None:
-            raise RuntimeError("Session is not available")
-        return self.__session
-
     @property
     def client(self) -> Client:
         """Client Connection"""
         if self.__client is None:
-            logger.info("Creating Client")
             self.__client = self.session.client
 
-        if self.raise_on_error and self.__client is None:
-            raise RuntimeError("Client is not available")
         return self.__client
 
     @client.setter

boto3_assist/environment_services/environment_loader.py

@@ -96,7 +96,7 @@ class EnvironmentLoader:
         paths: List[str] = []
         for parent in range(parents):
             path = Path(starting_path).parents[parent].absolute()
-            print(f"searching: {path}")
+            logger.debug(f"searching for {file_name} in: {path}")
             tmp = os.path.join(path, file_name)
             paths.append(tmp)
             if os.path.exists(tmp):

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/s3/s3_connection.py

@@ -12,7 +12,7 @@ from boto3_assist.boto3session import Boto3SessionManager
 from boto3_assist.environment_services.environment_variables import (
     EnvironmentVariables,
 )
-from boto3_assist.connection_tracker import ConnectionTracker
+from boto3_assist.connection import Connection
 
 if TYPE_CHECKING:
     from mypy_boto3_s3 import S3Client, S3ServiceResource
@@ -22,10 +22,9 @@ else:
 
 
 logger = Logger()
-tracker: ConnectionTracker = ConnectionTracker(service_name="s3")
 
 
-class S3Connection:
+class S3Connection(Connection):
     """Connection"""
 
     def __init__(
@@ -37,64 +36,24 @@ class S3Connection:
         aws_access_key_id: Optional[str] = None,
         aws_secret_access_key: Optional[str] = None,
     ) -> None:
-        self.aws_profile = aws_profile or EnvironmentVariables.AWS.profile()
-        self.aws_region = aws_region or EnvironmentVariables.AWS.region()
-        self.end_point_url = (
-            aws_end_point_url or EnvironmentVariables.AWS.endpoint_url()
-        )
-        self.aws_access_key_id = (
-            aws_access_key_id or EnvironmentVariables.AWS.aws_access_key_id()
-        )
-        self.aws_secret_access_key = (
-            aws_secret_access_key or EnvironmentVariables.AWS.aws_secret_access_key()
-        )
-        self.__session: Boto3SessionManager | None = None
-        self.__client: S3Client | None = None
-        self.__resource: S3ServiceResource | None = None
-
-        self.raise_on_error: bool = True
-
-    def setup(self, setup_source: Optional[str] = None) -> None:
-        """
-        Setup the environment.  Automatically called via init.
-        You can run setup at anytime with new parameters.
-        Args: setup_source: Optional[str] = None
-            Defines the source of the setup.  Useful for logging.
-        Returns: None
-        """
-
-        self.__session = Boto3SessionManager(
+        super().__init__(
             service_name="s3",
-            aws_profile=self.aws_profile,
-            aws_region=self.aws_region,
-            aws_access_key_id=self.aws_access_key_id,
-            aws_secret_access_key=self.aws_secret_access_key,
-            aws_endpoint_url=self.end_point_url,
+            aws_profile=aws_profile,
+            aws_region=aws_region,
+            aws_access_key_id=aws_access_key_id,
+            aws_secret_access_key=aws_secret_access_key,
+            aws_end_point_url=aws_end_point_url,
         )
 
-        tracker.increment_connection()
-
-        self.raise_on_error = False
-
-    @property
-    def session(self) -> Boto3SessionManager:
-        """Session"""
-        if self.__session is None:
-            self.setup(setup_source="session init")
-
-        if self.__session is None:
-            raise RuntimeError("Session is not available")
-        return self.__session
+        self.__client: S3Client | None = None
+        self.__resource: S3ServiceResource | None = None
 
     @property
     def client(self) -> S3Client:
         """Client Connection"""
         if self.__client is None:
-            logger.info("Creating Client")
             self.__client = self.session.client
 
-        if self.raise_on_error and self.__client is None:
-            raise RuntimeError("Client is not available")
         return self.__client
 
     @client.setter

boto3_assist/utilities/datetime_utility.py

@@ -317,3 +317,29 @@ class DatetimeUtility:
         tz = pytz.timezone(timezone_name)
         result = utc_datetime.astimezone(tz)
         return result
+
+    @staticmethod
+    def get_timestamp(value: datetime | None | str) -> float:
+        """Get a timestampe from a date or 0.0"""
+        if value is None:
+            return 0.0
+        if not isinstance(value, datetime):
+            value = DatetimeUtility.to_datetime_utc(value=value)
+
+        if not isinstance(value, datetime):
+            return 0.0
+        ts = value.timestamp()
+        return ts
+
+    @staticmethod
+    def get_timestamp_or_none(value: datetime | None | str) -> float | None:
+        """Get a timestampe from a date or None"""
+        if value is None:
+            return None
+        if not isinstance(value, datetime):
+            value = DatetimeUtility.to_datetime_utc(value=value)
+
+        if not isinstance(value, datetime):
+            return None
+        ts = value.timestamp()
+        return ts

boto3_assist/utilities/dictionaroy_utility.py

@@ -0,0 +1,26 @@
+from typing import List
+
+
+class DictionaryUtilitiy:
+    """
+    A class to provide utility methods for working with dictionaries.
+    """
+
+    @staticmethod
+    def find_dict_by_name(
+        dict_list: List[dict], key_field: str, name: str
+    ) -> List[dict] | dict | str:
+        """
+        Searches for dictionaries in a list where the key 'name' matches the specified value.
+
+        Args:
+        dict_list (list): A list of dictionaries to search through.
+        key_field (str): The key to search for in each dictionary.
+        name (str): The value to search for in the 'key_field' key.
+
+        Returns:
+        list: A list of dictionaries where the 'key_field' key matches the specified value.
+        """
+        # List comprehension to filter dictionaries that have the 'name' key equal to the specified name
+
+        return [d for d in dict_list if d.get(key_field) == name]