Add support for pydantic_settings.BaseSettings in dependencies #250

Author: zmievsa

CHANGELOG.md

@@ -5,6 +5,12 @@ Please follow [the Keep a Changelog standard](https://keepachangelog.com/en/1.0.
 
 ## [Unreleased]
 
+## [5.3.2]
+
+### Fixed
+
+* Add support for `pydantic_settings.BaseSettings` in dependencies
+
 ## [5.3.1]
 
 ### Fixed

cadwyn/schema_generation.py

@@ -102,6 +102,14 @@
     ComputedFieldInfo: pydantic.computed_field,
 }
 _PYDANTIC_ALL_EXPORTED_NAMES = set(pydantic.__all__)
+_DEFAULT_PYDANTIC_CLASSES = (BaseModel, RootModel)
+
+try:
+    from pydantic_settings import BaseSettings
+
+    _DEFAULT_PYDANTIC_CLASSES = (*_DEFAULT_PYDANTIC_CLASSES, BaseSettings)
+except ImportError:  # pragma: no cover
+    pass
 
 
 VALIDATOR_CONFIG_KEY = "__validators__"
@@ -757,7 +765,7 @@ def __getitem__(self, model: type[_T_ANY_MODEL], /) -> type[_T_ANY_MODEL]:
         if (
             not isinstance(model, type)
             or not lenient_issubclass(model, (BaseModel, Enum))
-            or model in (BaseModel, RootModel)
+            or model in _DEFAULT_PYDANTIC_CLASSES
         ):
             return model
         model = _unwrap_model(model)

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cadwyn"
-version = "5.3.1"
+version = "5.3.2"
 description = "Production-ready community-driven modern Stripe-like API versioning in FastAPI"
 authors = [{ name = "Stanislav Zmiev", email = "zmievsa@gmail.com" }]
 license = "MIT"
@@ -88,6 +88,7 @@ dev-dependencies = [
     "pdbpp>=0.10.3",
     "markdown-include-variants>=0.0.4",
     "inline-snapshot>=0.20.7",
+    "pydantic-settings>=2.8.1",
 ]
 
 [project.urls]

tests/test_router_generation.py

@@ -14,7 +14,8 @@
 from fastapi.security.http import HTTPBasic
 from fastapi.testclient import TestClient
 from inline_snapshot import snapshot
-from pydantic import BaseModel, JsonValue
+from pydantic import BaseModel, Field, JsonValue
+from pydantic_settings import BaseSettings
 from pytest_fixture_classes import fixture_class
 from starlette.responses import FileResponse
 from typing_extensions import Any, NewType, TypeAlias, TypeAliasType, get_args
@@ -1355,6 +1356,32 @@ async def test(
     )
 
 
+def test__router_generation__with_pydantic_settings_dependency(
+    create_versioned_app: CreateVersionedApp,
+    router: VersionedAPIRouter,
+) -> None:
+    class Settings(BaseSettings):
+        foo: str = Field(default="bar")
+
+    async def settings() -> Settings:
+        return Settings()
+
+    @router.get("/test")
+    def read_root(settings: Annotated[Settings, Depends(settings)]):
+        assert settings
+        return {"foo": settings.foo}
+
+    app = create_versioned_app(version_change())
+    with TestClient(app) as client:
+        resp = client.get("/test", headers={"x-api-version": "2000-01-01"})
+        assert resp.status_code == 200
+        assert resp.json() == {"foo": "bar"}
+
+        resp = client.get("/test", headers={"x-api-version": "2001-01-01"})
+        assert resp.status_code == 200
+        assert resp.json() == {"foo": "bar"}
+
+
 ######################
 # External lib testing
 ######################