chore: rename AwsSsmSourceConfig to AwsSsmBaseSettings

Author: alukach

pydantic_ssm_settings/__init__.py

@@ -1,4 +1,4 @@
-from .settings import AwsSsmSourceConfig, SsmSettingsConfigDict
+from .settings import AwsSsmBaseSettings, SsmSettingsConfigDict
 from .source import AwsSsmSettingsSource
 
 __all__ = ("AwsSsmSourceConfig", "SsmSettingsConfigDict", "AwsSsmSettingsSource")

pydantic_ssm_settings/settings.py

@@ -19,26 +19,29 @@ class SsmSettingsConfigDict(SettingsConfigDict):
     ssm_prefix: str
 
 
-class BaseSettingsSsmWrapper(BaseSettings):
+class AwsSsmBaseSettings(BaseSettings):
     """
-    Wrapper to store the _ssm_prefix parameter as an instance attribute.
-    Need a direct access to the attributes dictionary to avoid raising an AttributeError:
-    __pydantic_private__ exception
+    Helper to configure the AWS SSM source for Pydantic settings and to pass
+    options from init args to settings.
     """
 
-    def __init__(self, *args, _ssm_prefix: Optional[str] = None, **kwargs: Any) -> None:
+    def __init__(
+        self,
+        *args,
+        _ssm_prefix: Optional[str] = None,
+        **kwargs: Any,
+    ) -> None:
         """
         Args:
             _ssm_prefix: Prefix for all ssm parameters. Must be an absolute path,
             separated by "/". NB:unlike its _env_prefix counterpart, _ssm_prefix
             is treated case sensitively regardless of the _case_sensitive
             parameter value.
         """
+        # NOTE: Need a direct access to the attributes dictionary to avoid raising an AttributeError: __pydantic_private__ exception
         self.__dict__["__ssm_prefix"] = _ssm_prefix
         super().__init__(self, *args, **kwargs)
 
-
-class AwsSsmSourceConfig(BaseSettingsSsmWrapper):
     def settings_customise_sources(
         self,
         settings_cls: Type[BaseSettings],

tests/test_main.py

@@ -2,14 +2,14 @@
 from pydantic import BaseModel
 from pydantic_settings import SettingsConfigDict
 
-from pydantic_ssm_settings import AwsSsmSourceConfig, SsmSettingsConfigDict
+from pydantic_ssm_settings import AwsSsmBaseSettings, SsmSettingsConfigDict
 
 
-class SimpleSettings(AwsSsmSourceConfig):
+class SimpleSettings(AwsSsmBaseSettings):
     foo: str
 
 
-class IntSettings(AwsSsmSourceConfig):
+class IntSettings(AwsSsmBaseSettings):
     foo: str
     bar: int
 
@@ -18,7 +18,7 @@ class ChildSetting(BaseModel):
     bar: str
 
 
-class ParentSetting(AwsSsmSourceConfig):
+class ParentSetting(AwsSsmBaseSettings):
     foo: ChildSetting
 
 
@@ -96,7 +96,7 @@ def test_ssm_parameter_json_override(ssm):
     assert settings.foo.bar == "overwritten"
 
 
-class CaseInsensitiveSettings(AwsSsmSourceConfig):
+class CaseInsensitiveSettings(AwsSsmBaseSettings):
     model_config = SettingsConfigDict(case_sensitive=False)
     foo: str
 
@@ -107,7 +107,7 @@ def test_case_insensitivity(ssm):
     assert settings.foo == "bar"
 
 
-class CustomConfigDict(AwsSsmSourceConfig):
+class CustomConfigDict(AwsSsmBaseSettings):
     model_config = SsmSettingsConfigDict(ssm_prefix="/asdf")
     foo: str