Add support for pydantic v2 (Intility#144)

* update dependencies

* update trio to fix a test issue

* fix pydantic v2 compatibility issue

* add pydantic v2 to ci

* setup pydantic version before fastapi version in ci

* remove pydantic settings before downgrading to pydantic v1

* update python patch version in ci

* update pytest-aiohttp

* no cover for line only run by pydantic v1

.github/workflows/testing.yaml

@@ -27,14 +27,21 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [ "3.8.13", "3.11.2", "3.12.0-alpha.5" ]
-        fastapi-version: [ "0.68.0", "0.86.0", "0.95.0"]
+        python-version: [ "3.8.17", "3.11.4", "3.12.0-beta.4" ]
+        fastapi-version: [ "0.68.0", "0.86.0", "0.95.0", "0.100.1"]
+        pydantic-version: [ "1.10.12", "2.1.1"]
         exclude:
           # Don't test python 3.12 on old FastAPI versions
-          - python-version: "3.12.0-alpha.5"
+          - python-version: "3.12.0-beta.4"
             fastapi-version: "0.68.0"
-          - python-version: "3.12.0-alpha.5"
+          - python-version: "3.12.0-beta.4"
             fastapi-version: "0.86.0"
+          - fastapi-version: "0.68.0"
+            pydantic-version: "2.1.1"
+          - fastapi-version: "0.86.0"
+            pydantic-version: "2.1.1"
+          - fastapi-version: "0.95.0"
+            pydantic-version: "2.1.1"
     steps:
       - name: Check out repository
         uses: actions/checkout@v3
@@ -58,6 +65,15 @@ jobs:
         if: steps.cache-venv.outputs.cache-hit != 'true'
       - name: Install package
         run: poetry install --no-interaction
+      - name: Remove pydantic-settings
+        if: matrix.pydantic-version == '1.10.12'
+        run: |
+          source .venv/bin/activate
+          poetry remove pydantic-settings
+      - name: Install Pydantic ${{ matrix.pydantic-version }}
+        run: |
+          source .venv/bin/activate
+          poetry add "pydantic==${{ matrix.pydantic-version }}"
       - name: Install FastAPI ${{ matrix.fastapi-version }}
         run: |
           source .venv/bin/activate

.pre-commit-config.yaml

@@ -49,6 +49,7 @@ repos:
           [
             fastapi,
             pydantic,
+            pydantic-settings,
             starlette,
             httpx
           ]

demo_project/api/dependencies.py

@@ -75,9 +75,9 @@ async def __call__(self, tid: str) -> str:
 
 azure_scheme_auto_error_false_b2c = B2CMultiTenantAuthorizationCodeBearer(
     app_client_id=settings.APP_CLIENT_ID,
-    openapi_authorization_url=settings.AUTH_URL,
-    openapi_token_url=settings.TOKEN_URL,
-    openid_config_url=settings.CONFIG_URL,
+    openapi_authorization_url=str(settings.AUTH_URL),
+    openapi_token_url=str(settings.TOKEN_URL),
+    openid_config_url=str(settings.CONFIG_URL),
     scopes={
         f'api://{settings.APP_CLIENT_ID}/user_impersonation': 'User impersonation',
     },

demo_project/core/config.py

@@ -1,9 +1,15 @@
 from typing import List, Optional, Union
 
-from pydantic import AnyHttpUrl, BaseSettings, Field, HttpUrl
+import pydantic
+from pydantic import AnyHttpUrl, Field, HttpUrl
 
+if pydantic.VERSION.startswith('1.'):
+    from pydantic import BaseSettings
+else:
+    from pydantic_settings import BaseSettings
 
-class AzureActiveDirectory(BaseSettings):
+
+class AzureActiveDirectory(BaseSettings):  # type: ignore[misc, valid-type]
     OPENAPI_CLIENT_ID: str = Field(default='', env='OPENAPI_CLIENT_ID')
     TENANT_ID: str = Field(default='', env='TENANT_ID')
     APP_CLIENT_ID: str = Field(default='', env='APP_CLIENT_ID')

fastapi_azure_auth/user.py

@@ -239,7 +239,7 @@ def scopes_to_list(cls, v: object) -> object:
         """
         if isinstance(v, str):
             return v.split(' ')
-        return v
+        return v  # pragma: no cover
 
 
 class User(Claims):

pyproject.toml

@@ -45,6 +45,7 @@ fastapi = ">0.68.0"
 cryptography = ">=40.0.1"
 python-jose = {extras = ["cryptography"], version = "^3.3.0"}
 httpx = ">0.18.2"
+pydantic-settings = "^2.0.2"
 
 
 [tool.poetry.group.dev.dependencies]
@@ -57,12 +58,12 @@ pytest-mock = "^3.5.1"
 requests-mock = "^1.8.0"
 pytest-socket = "^0.4.0"
 pytest-dotenv = "^0.5.2"
-pytest-aiohttp = "^0.3.0"
+pytest-aiohttp = "^1.0.4"
 uvicorn = "^0.17.5"
 pytest-freezegun = "^0.4.2"
 pytest-cases = "^3.6.3"
 anyio = "^3.3.4"
-trio = "^0.19.0"
+trio = "^0.22.2"
 respx = "^0.20.1"
 ipython = "^8.2.0"
 

tests/multi_tenant_b2c/conftest.py

@@ -68,8 +68,8 @@ async def issuer_fetcher(tid):
         current_issuer = issuer
     return B2CMultiTenantAuthorizationCodeBearer(
         app_client_id=settings.APP_CLIENT_ID,
-        openapi_authorization_url=settings.AUTH_URL,
-        openapi_token_url=settings.TOKEN_URL,
+        openapi_authorization_url=str(settings.AUTH_URL),
+        openapi_token_url=str(settings.TOKEN_URL),
         # The value below is used only for testing purpose you should use:
         # https://login.microsoftonline.com/common/v2.0/oauth2/token
         openid_config_url='https://login.microsoftonline.com/common/v2.0/.well-known/openid-configuration',