add Traversable support and tests

Author: mahenzon

pydantic_settings/sources/base.py

@@ -200,7 +200,13 @@ def _read_files(self, files: PathType | None, deep_merge: bool = False) -> dict[
             files = [files]
         vars: dict[str, Any] = {}
         for file in files:
-            file_path = Path(file).expanduser()
+            if isinstance(file, str):
+                file_path = Path(file)
+            else:
+                file_path = file
+            if isinstance(file_path, Path):
+                file_path = file_path.expanduser()
+
             if not file_path.is_file():
                 continue
 

tests/test_source_json.py

@@ -2,6 +2,7 @@
 Test pydantic_settings.JsonConfigSettingsSource.
 """
 
+import importlib.resources
 import json
 from pathlib import Path
 
@@ -132,3 +133,33 @@ def settings_customise_sources(
 
     s = Settings()
     assert s.model_dump() == {'hello': 'world', 'nested': {'foo': 3, 'bar': 2 if deep_merge else 0}}
+
+
+def test_traversable_support():
+    # get Traversable object
+    tests_package_dir = importlib.resources.files('tests')
+    json_config_path = tests_package_dir / 'example_test_config.json'
+    assert json_config_path.is_file()
+
+    class Settings(BaseSettings):
+        foobar: str
+
+        model_config = SettingsConfigDict(
+            # Traversable is not added in annotation, but is supported
+            json_file=json_config_path,
+        )
+
+        @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 (JsonConfigSettingsSource(settings_cls),)
+
+    s = Settings()
+    # "test" value in file
+    assert s.foobar == 'test'