Adopt pydantic-settings with Pydantic V2 (#17)

Co-authored-by: David Montague <[email protected]>
Co-authored-by: Samuel Colvin <[email protected]>

Author: 3 people

pydantic_settings/main.py

@@ -1,13 +1,11 @@
 from __future__ import annotations as _annotations
 
-import warnings
-from typing import AbstractSet, Any, ClassVar, Dict, List, Optional, Tuple, Type, Union
+from pathlib import Path
+from typing import Any, Dict, Optional, Tuple, Type, Union
 
-from pydantic.config import BaseConfig, Extra
-from pydantic.fields import ModelField
+from pydantic import ConfigDict
+from pydantic._internal._utils import deep_update
 from pydantic.main import BaseModel
-from pydantic.typing import StrPath, display_as_type
-from pydantic.utils import deep_update, sequence_like
 
 from .sources import (
     DotEnvSettingsSource,
@@ -18,7 +16,16 @@
     SecretsSettingsSource,
 )
 
-env_file_sentinel = str(object())
+env_file_sentinel: DotenvType = Path('')
+
+
+class SettingsConfigDict(ConfigDict):
+    case_sensitive: bool
+    env_prefix: str
+    env_file: Optional[DotenvType]
+    env_file_encoding: Optional[str]
+    env_nested_delimiter: Optional[str]
+    secrets_dir: Optional[Union[str, Path]]
 
 
 class BaseSettings(BaseModel):
@@ -34,12 +41,12 @@ def __init__(
         _env_file: Optional[DotenvType] = env_file_sentinel,
         _env_file_encoding: Optional[str] = None,
         _env_nested_delimiter: Optional[str] = None,
-        _secrets_dir: Optional[StrPath] = None,
+        _secrets_dir: Optional[Union[str, Path]] = None,
         **values: Any,
     ) -> None:
         # Uses something other than `self` the first arg to allow "self" as a settable attribute
         super().__init__(
-            **__pydantic_self__._build_values(
+            **__pydantic_self__._settings_build_values(
                 values,
                 _env_file=_env_file,
                 _env_file_encoding=_env_file_encoding,
@@ -48,40 +55,55 @@ def __init__(
             )
         )
 
-    def _build_values(
+    @classmethod
+    def settings_customise_sources(
+        cls,
+        settings_cls: Type[BaseSettings],
+        init_settings: PydanticBaseSettingsSource,
+        env_settings: PydanticBaseSettingsSource,
+        dotenv_settings: PydanticBaseSettingsSource,
+        file_secret_settings: PydanticBaseSettingsSource,
+    ) -> Tuple[PydanticBaseSettingsSource, ...]:
+        return init_settings, env_settings, dotenv_settings, file_secret_settings
+
+    def _settings_build_values(
         self,
         init_kwargs: Dict[str, Any],
         _env_file: Optional[DotenvType] = None,
         _env_file_encoding: Optional[str] = None,
         _env_nested_delimiter: Optional[str] = None,
-        _secrets_dir: Optional[StrPath] = None,
+        _secrets_dir: Optional[Union[str, Path]] = None,
     ) -> Dict[str, Any]:
         # Configure built-in sources
         init_settings = InitSettingsSource(self.__class__, init_kwargs=init_kwargs)
         env_settings = EnvSettingsSource(
             self.__class__,
             env_nested_delimiter=(
-                _env_nested_delimiter if _env_nested_delimiter is not None else self.__config__.env_nested_delimiter
+                _env_nested_delimiter
+                if _env_nested_delimiter is not None
+                else self.model_config.get('env_nested_delimiter')
             ),
-            env_prefix_len=len(self.__config__.env_prefix),
+            env_prefix_len=len(self.model_config.get('env_prefix', '')),
         )
         dotenv_settings = DotEnvSettingsSource(
             self.__class__,
-            env_file=(_env_file if _env_file != env_file_sentinel else self.__config__.env_file),
+            env_file=(_env_file if _env_file != env_file_sentinel else self.model_config.get('env_file')),
             env_file_encoding=(
-                _env_file_encoding if _env_file_encoding is not None else self.__config__.env_file_encoding
+                _env_file_encoding if _env_file_encoding is not None else self.model_config.get('env_file_encoding')
             ),
             env_nested_delimiter=(
-                _env_nested_delimiter if _env_nested_delimiter is not None else self.__config__.env_nested_delimiter
+                _env_nested_delimiter
+                if _env_nested_delimiter is not None
+                else self.model_config.get('env_nested_delimiter')
             ),
-            env_prefix_len=len(self.__config__.env_prefix),
+            env_prefix_len=len(self.model_config.get('env_prefix', '')),
         )
 
         file_secret_settings = SecretsSettingsSource(
-            self.__class__, secrets_dir=_secrets_dir or self.__config__.secrets_dir
+            self.__class__, secrets_dir=_secrets_dir or self.model_config.get('secrets_dir')
         )
         # Provide a hook to set built-in sources priority and add / remove sources
-        sources = self.__config__.customise_sources(
+        sources = self.settings_customise_sources(
             self.__class__,
             init_settings=init_settings,
             env_settings=env_settings,
@@ -95,59 +117,14 @@ def _build_values(
             # to an informative error and much better than a confusing error
             return {}
 
-    class Config(BaseConfig):
-        env_prefix: str = ''
-        env_file: Optional[DotenvType] = None
-        env_file_encoding: Optional[str] = None
-        env_nested_delimiter: Optional[str] = None
-        secrets_dir: Optional[StrPath] = None
-        validate_all: bool = True
-        extra: Extra = Extra.forbid
-        arbitrary_types_allowed: bool = True
-        case_sensitive: bool = False
-
-        @classmethod
-        def prepare_field(cls, field: ModelField) -> None:
-            env_names: Union[List[str], AbstractSet[str]]
-            field_info_from_config = cls.get_field_info(field.name)
-
-            env = field_info_from_config.get('env') or field.field_info.extra.get('env')
-            if env is None:
-                if field.has_alias:
-                    warnings.warn(
-                        'aliases are no longer used by BaseSettings to define which environment variables to read. '
-                        'Instead use the "env" field setting. '
-                        'See https://pydantic-docs.helpmanual.io/usage/settings/#environment-variable-names',
-                        FutureWarning,
-                    )
-                env_names = {cls.env_prefix + field.name}
-            elif isinstance(env, str):
-                env_names = {env}
-            elif isinstance(env, (set, frozenset)):
-                env_names = env
-            elif sequence_like(env):
-                env_names = list(env)
-            else:
-                raise TypeError(f'invalid field env: {env!r} ({display_as_type(env)}); should be string, list or set')
-
-            if not cls.case_sensitive:
-                env_names = env_names.__class__(n.lower() for n in env_names)
-            field.field_info.extra['env_names'] = env_names
-
-        @classmethod
-        def customise_sources(
-            cls,
-            settings_cls: Type[BaseSettings],
-            init_settings: PydanticBaseSettingsSource,
-            env_settings: PydanticBaseSettingsSource,
-            dotenv_settings: PydanticBaseSettingsSource,
-            file_secret_settings: PydanticBaseSettingsSource,
-        ) -> Tuple[PydanticBaseSettingsSource, ...]:
-            return init_settings, env_settings, dotenv_settings, file_secret_settings
-
-        @classmethod
-        def parse_env_var(cls, field_name: str, raw_val: str) -> Any:
-            return cls.json_loads(raw_val)
-
-    # populated by the metaclass using the Config class defined above, annotated here to help IDEs only
-    __config__: ClassVar[Type[Config]]
+    model_config = SettingsConfigDict(
+        extra='forbid',
+        arbitrary_types_allowed=True,
+        validate_default=True,
+        case_sensitive=False,
+        env_prefix='',
+        env_file=None,
+        env_file_encoding=None,
+        env_nested_delimiter=None,
+        secrets_dir=None,
+    )