Merge pull request #226 from FullStackWithLawrence/next

refactor settings to use a singleton

Author: lpm0073

CHANGELOG.md

@@ -7,11 +7,10 @@
 
 ## [0.8.1](https://github.com/FullStackWithLawrence/aws-openai/compare/v0.8.0...v0.8.1) (2023-12-30)
 
-
 ### Bug Fixes
 
-* ensure that AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY are set when running CI ([3d788b0](https://github.com/FullStackWithLawrence/aws-openai/commit/3d788b0d72f327d9f4711586499807c06831f5db))
-* fix indentation error ([806865b](https://github.com/FullStackWithLawrence/aws-openai/commit/806865b2c5a0a250862b956319fe121ca452d423))
+- ensure that AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY are set when running CI ([3d788b0](https://github.com/FullStackWithLawrence/aws-openai/commit/3d788b0d72f327d9f4711586499807c06831f5db))
+- fix indentation error ([806865b](https://github.com/FullStackWithLawrence/aws-openai/commit/806865b2c5a0a250862b956319fe121ca452d423))
 
 # [0.8.0](https://github.com/FullStackWithLawrence/aws-openai/compare/v0.7.2...v0.8.0) (2023-12-30)
 

api/terraform/python/openai_api/__version__.py

@@ -1,4 +1,4 @@
 # -*- coding: utf-8 -*-
 # DO NOT EDIT.
 # Managed via automated CI/CD in .github/workflows/semanticVersionBump.yml.
-__version__ = "0.8.1"
+__version__ = "0.8.2"

api/terraform/python/openai_api/common/conf.py

@@ -37,7 +37,7 @@
     OpenAIAPIConfigurationError,
     OpenAIAPIValueError,
 )
-from pydantic import Field, SecretStr, ValidationInfo, field_validator
+from pydantic import Field, SecretStr, ValidationError, ValidationInfo, field_validator
 from pydantic_settings import BaseSettings
 
 
@@ -217,7 +217,7 @@ class Settings(BaseSettings):
     _initialized: bool = False
 
     # pylint: disable=too-many-branches,too-many-statements
-    def __init__(self, **data: Any):
+    def __init__(self, **data: Any):  # noqa: C901
         super().__init__(**data)
         if not Services.enabled(Services.AWS_CLI):
             self._initialized = True
@@ -240,14 +240,12 @@ def __init__(self, **data: Any):
             logger.info("running inside GitHub Actions")
             aws_access_key_id = os.environ.get("AWS_ACCESS_KEY_ID", None)
             aws_secret_access_key = os.environ.get("AWS_SECRET_ACCESS_KEY", None)
-            if not aws_access_key_id or not aws_secret_access_key:
+            if not aws_access_key_id or not aws_secret_access_key and not self.aws_profile:
                 raise OpenAIAPIConfigurationError(
                     "required environment variable(s) AWS_ACCESS_KEY_ID and/or AWS_SECRET_ACCESS_KEY not set"
                 )
-            self._aws_access_key_id_source = "environ"
-            self._aws_secret_access_key_source = "environ"
             region_name = os.environ.get("AWS_REGION", None)
-            if not region_name:
+            if not region_name and not self.aws_profile:
                 raise OpenAIAPIConfigurationError("required environment variable AWS_REGION not set")
             try:
                 self._aws_session = boto3.Session(
@@ -259,11 +257,17 @@ def __init__(self, **data: Any):
                 self._aws_access_key_id_source = "environ"
                 self._aws_secret_access_key_source = "environ"
             except ProfileNotFound:
-                logger.warning("aws_profile %s not found", self.aws_profile)
+                # only log this if the aws_profile is set
+                if self.aws_profile:
+                    logger.warning("aws_profile %s not found", self.aws_profile)
 
-            if self.aws_profile and self._aws_access_key_id_source == "unset":
+            if self.aws_profile:
                 self._aws_access_key_id_source = "aws_profile"
                 self._aws_secret_access_key_source = "aws_profile"
+            else:
+                self._aws_access_key_id_source = "environ"
+                self._aws_secret_access_key_source = "environ"
+
             self._initialized = True
 
         if not self.initialized:
@@ -392,6 +396,7 @@ def aws_auth(self) -> dict:
         }
         if self.init_info:
             retval["init_info"] = self.init_info
+        return retval
 
     @property
     def aws_session(self):
@@ -702,4 +707,25 @@ def check_pinecone_api_key(cls, v) -> SecretStr:
         return v
 
 
-settings = Settings()
+class SingletonSettings:
+    """Singleton for Settings"""
+
+    _instance = None
+
+    def __new__(cls):
+        """Create a new instance of Settings"""
+        if cls._instance is None:
+            cls._instance = super(SingletonSettings, cls).__new__(cls)
+            try:
+                cls._instance._settings = Settings()
+            except ValidationError as e:
+                raise OpenAIAPIConfigurationError("Invalid configuration: " + str(e)) from e
+        return cls._instance
+
+    @property
+    def settings(self):
+        """Return the settings"""
+        return self._settings
+
+
+settings = SingletonSettings().settings