Replace tomlkit with tomli and remove toml_file_encoding config (#236)

Author: hramezani

.github/workflows/ci.yml

@@ -57,7 +57,7 @@ jobs:
         CONTEXT: ${{ runner.os }}-py${{ matrix.python }}
 
     - name: uninstall deps
-      run: pip uninstall -y tomlkit PyYAML
+      run: pip uninstall -y PyYAML
 
     - name: test without deps
       run: make test

docs/index.md

@@ -539,7 +539,7 @@ docker service create --name pydantic-with-secrets --secret my_secret_data pydan
 
 Other settings sources are available for common configuration files:
 
-- `TomlConfigSettingsSource` using `toml_file` and toml_file_encoding arguments
+- `TomlConfigSettingsSource` using `toml_file` argument
 - `YamlConfigSettingsSource` using `yaml_file` and yaml_file_encoding arguments
 - `JsonConfigSettingsSource` using `json_file` and `json_file_encoding` arguments
 
@@ -570,9 +570,7 @@ class Nested(BaseModel):
 class Settings(BaseSettings):
     foobar: str
     nested: Nested
-    model_config = SettingsConfigDict(
-        toml_file='config.toml', toml_file_encoding='utf-8'
-    )
+    model_config = SettingsConfigDict(toml_file='config.toml')
 
     @classmethod
     def settings_customise_sources(

pydantic_settings/main.py

@@ -34,7 +34,6 @@ class SettingsConfigDict(ConfigDict, total=False):
     yaml_file: PathType | None
     yaml_file_encoding: str | None
     toml_file: PathType | None
-    toml_file_encoding: str | None
 
 
 # Extend `config_keys` by pydantic settings config keys to
@@ -207,7 +206,6 @@ def _settings_build_values(
         yaml_file=None,
         yaml_file_encoding=None,
         toml_file=None,
-        toml_file_encoding=None,
         secrets_dir=None,
         protected_namespaces=('model_', 'settings_'),
     )

pydantic_settings/sources.py

@@ -24,14 +24,14 @@
         import tomllib
     else:
         tomllib = None
-    import tomlkit
+    import tomli
     import yaml
 
     from pydantic_settings.main import BaseSettings
 else:
     yaml = None
     tomllib = None
-    tomlkit = None
+    tomli = None
 
 
 def import_yaml() -> None:
@@ -45,15 +45,15 @@ def import_yaml() -> None:
 
 
 def import_toml() -> None:
-    global tomlkit
+    global tomli
     global tomllib
     if sys.version_info < (3, 11):
-        if tomlkit is not None:
+        if tomli is not None:
             return
         try:
-            import tomlkit
+            import tomli
         except ImportError as e:
-            raise ImportError('tomlkit is not installed, run `pip install pydantic-settings[toml]`') from e
+            raise ImportError('tomli is not installed, run `pip install pydantic-settings[toml]`') from e
     else:
         if tomllib is not None:
             return
@@ -764,22 +764,16 @@ def __init__(
         self,
         settings_cls: type[BaseSettings],
         toml_file: PathType | None = DEFAULT_PATH,
-        toml_file_encoding: str | None = None,
     ):
         self.toml_file_path = toml_file if toml_file != DEFAULT_PATH else settings_cls.model_config.get('toml_file')
-        self.toml_file_encoding = (
-            toml_file_encoding
-            if toml_file_encoding is not None
-            else settings_cls.model_config.get('toml_file_encoding')
-        )
         self.toml_data = self._read_files(self.toml_file_path)
         super().__init__(settings_cls, self.toml_data)
 
     def _read_file(self, file_path: Path) -> dict[str, Any]:
         import_toml()
-        with open(file_path, mode='rb', encoding=self.toml_file_encoding) as toml_file:
+        with open(file_path, mode='rb') as toml_file:
             if sys.version_info < (3, 11):
-                return tomlkit.load(toml_file)
+                return tomli.load(toml_file)
             return tomllib.load(toml_file)
 
 

pyproject.toml

@@ -47,7 +47,7 @@ dynamic = ['version']
 
 [project.optional-dependencies]
 yaml = ["pyyaml>=6.0.1"]
-toml = ["tomlkit>=0.12"]
+toml = ["tomli>=2.0.1"]
 
 [project.urls]
 Homepage = 'https://github.com/pydantic/pydantic-settings'

requirements/linting.txt

@@ -1,5 +1,5 @@
 #
-# This file is autogenerated by pip-compile with Python 3.11
+# This file is autogenerated by pip-compile with Python 3.8
 # by the following command:
 #
 #    pip-compile --output-file=requirements/linting.txt requirements/linting.in
@@ -32,22 +32,28 @@ platformdirs==4.2.0
     # via
     #   black
     #   virtualenv
-pre-commit==3.6.1
+pre-commit==3.5.0
     # via -r requirements/linting.in
 pyupgrade==3.15.0
     # via -r requirements/linting.in
 pyyaml==6.0.1
     # via
     #   -r requirements/linting.in
     #   pre-commit
-ruff==0.2.1
+ruff==0.2.2
     # via -r requirements/linting.in
 tokenize-rt==5.2.0
     # via pyupgrade
+tomli==2.0.1
+    # via
+    #   black
+    #   mypy
 types-pyyaml==6.0.12.12
     # via -r requirements/linting.in
 typing-extensions==4.9.0
-    # via mypy
+    # via
+    #   black
+    #   mypy
 virtualenv==20.25.0
     # via pre-commit
 

requirements/pyproject.txt

@@ -14,7 +14,7 @@ python-dotenv==1.0.1
     # via pydantic-settings (pyproject.toml)
 pyyaml==6.0.1
     # via pydantic-settings (pyproject.toml)
-tomlkit==0.12.3
+tomli==2.0.1
     # via pydantic-settings (pyproject.toml)
 typing-extensions==4.9.0
     # via

requirements/testing.txt

@@ -32,7 +32,7 @@ pluggy==1.4.0
     # via pytest
 pygments==2.17.2
     # via rich
-pytest==8.0.0
+pytest==8.0.1
     # via
     #   -r requirements/testing.in
     #   pytest-examples
@@ -46,7 +46,7 @@ pytest-pretty==1.2.0
     # via -r requirements/testing.in
 rich==13.7.0
     # via pytest-pretty
-ruff==0.2.1
+ruff==0.2.2
     # via pytest-examples
 tomli==2.0.1
     # via

tests/test_settings.py

@@ -49,9 +49,9 @@
 except ImportError:
     yaml = None
 try:
-    import tomlkit
+    import tomli
 except ImportError:
-    tomlkit = None
+    tomli = None
 
 
 class SimpleSettings(BaseSettings):
@@ -1187,34 +1187,6 @@ def settings_customise_sources(
         Settings()
 
 
-@pytest.mark.skipif(sys.version_info >= (3, 11) or tomlkit, reason='tomlkit/tomllib is installed')
-def test_toml_not_installed(tmp_path):
-    p = tmp_path / '.env'
-    p.write_text(
-        """
-    foobar = "Hello"
-    """
-    )
-
-    class Settings(BaseSettings):
-        foobar: str
-        model_config = SettingsConfigDict(toml_file=p)
-
-        @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 (TomlConfigSettingsSource(settings_cls),)
-
-    with pytest.raises(ImportError, match=r'^tomlkit is not installed, run `pip install pydantic-settings\[toml\]`$'):
-        Settings()
-
-
 def test_alias_set(env):
     class Settings(BaseSettings):
         foo: str = Field('default foo', validation_alias='foo_env')
@@ -2159,7 +2131,7 @@ def settings_customise_sources(
     assert s.model_dump() == {}
 
 
-@pytest.mark.skipif(sys.version_info <= (3, 11) and tomlkit is None, reason='tomlkit/tomllib is not installed')
+@pytest.mark.skipif(sys.version_info <= (3, 11) and tomli is None, reason='tomli/tomllib is not installed')
 def test_toml_file(tmp_path):
     p = tmp_path / '.env'
     p.write_text(
@@ -2195,7 +2167,7 @@ def settings_customise_sources(
     assert s.nested.nested_field == 'world!'
 
 
-@pytest.mark.skipif(sys.version_info <= (3, 11) and tomlkit is None, reason='tomlkit/tomllib is not installed')
+@pytest.mark.skipif(sys.version_info <= (3, 11) and tomli is None, reason='tomli/tomllib is not installed')
 def test_toml_no_file():
     class Settings(BaseSettings):
         model_config = SettingsConfigDict(toml_file=None)
@@ -2215,7 +2187,7 @@ def settings_customise_sources(
     assert s.model_dump() == {}
 
 
-@pytest.mark.skipif(sys.version_info <= (3, 11) and tomlkit is None, reason='tomlkit/tomllib is not installed')
+@pytest.mark.skipif(sys.version_info <= (3, 11) and tomli is None, reason='tomli/tomllib is not installed')
 def test_multiple_file_toml(tmp_path):
     p1 = tmp_path / '.env.toml1'
     p2 = tmp_path / '.env.toml2'