Fix repr() for (Json|Toml|Yaml)ConfigSettingsSource

Previously, the __repr__() method of those settings source classes was
inherited from InitSettingsSource's thus returning a misleading
'InitSettingsSource(init_kwargs={})'. We here define a specific __repr__()
method implementation for classes using a config file (json, toml,
yaml).

Author: dlax

pydantic_settings/sources.py

@@ -1951,6 +1951,9 @@ def _read_file(self, file_path: Path) -> dict[str, Any]:
         with open(file_path, encoding=self.json_file_encoding) as json_file:
             return json.load(json_file)
 
+    def __repr__(self) -> str:
+        return f'JsonConfigSettingsSource(json_file={self.json_file_path})'
+
 
 class TomlConfigSettingsSource(InitSettingsSource, ConfigFileSourceMixin):
     """
@@ -1973,6 +1976,9 @@ def _read_file(self, file_path: Path) -> dict[str, Any]:
                 return tomli.load(toml_file)
             return tomllib.load(toml_file)
 
+    def __repr__(self) -> str:
+        return f'TomlConfigSettingsSource(toml_file={self.toml_file_path})'
+
 
 class PyprojectTomlConfigSettingsSource(TomlConfigSettingsSource):
     """
@@ -2045,6 +2051,9 @@ def _read_file(self, file_path: Path) -> dict[str, Any]:
         with open(file_path, encoding=self.yaml_file_encoding) as yaml_file:
             return yaml.safe_load(yaml_file) or {}
 
+    def __repr__(self) -> str:
+        return f'YamlConfigSettingsSource(yaml_file={self.yaml_file_path})'
+
 
 class AzureKeyVaultMapping(Mapping[str, Optional[str]]):
     _loaded_secrets: dict[str, str | None]

tests/test_source_json.py

@@ -3,6 +3,7 @@
 """
 
 import json
+from pathlib import Path
 from typing import Tuple, Type, Union
 
 from pydantic import BaseModel
@@ -15,6 +16,11 @@
 )
 
 
+def test_repr() -> None:
+    source = JsonConfigSettingsSource(BaseSettings(), Path('config.json'))
+    assert repr(source) == 'JsonConfigSettingsSource(json_file=config.json)'
+
+
 def test_json_file(tmp_path):
     p = tmp_path / '.env'
     p.write_text(

tests/test_source_toml.py

@@ -3,6 +3,7 @@
 """
 
 import sys
+from pathlib import Path
 from typing import Tuple, Type
 
 import pytest
@@ -21,6 +22,11 @@
     tomli = None
 
 
+def test_repr() -> None:
+    source = TomlConfigSettingsSource(BaseSettings(), Path('config.toml'))
+    assert repr(source) == 'TomlConfigSettingsSource(toml_file=config.toml)'
+
+
 @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'

tests/test_source_yaml.py

@@ -2,6 +2,7 @@
 Test pydantic_settings.YamlConfigSettingsSource.
 """
 
+from pathlib import Path
 from typing import Tuple, Type, Union
 
 import pytest
@@ -20,6 +21,11 @@
     yaml = None
 
 
+def test_repr() -> None:
+    source = YamlConfigSettingsSource(BaseSettings(), Path('config.yaml'))
+    assert repr(source) == 'YamlConfigSettingsSource(yaml_file=config.yaml)'
+
+
 @pytest.mark.skipif(yaml, reason='PyYAML is installed')
 def test_yaml_not_installed(tmp_path):
     p = tmp_path / '.env'