✨ Migrate from Pydantic V1 to V2 [WIP]

docs/python_snippets/client_generated_id/schematic_example.py

@@ -4,12 +4,12 @@
 
 import uvicorn
 from fastapi import APIRouter, Depends, FastAPI
+from pydantic import ConfigDict
 from fastapi_jsonapi.schema_base import Field, BaseModel as PydanticBaseModel
 from sqlalchemy import Column, Integer, Text
 from sqlalchemy.engine import make_url
-from sqlalchemy.ext.asyncio import AsyncSession, create_async_engine
-from sqlalchemy.ext.declarative import declarative_base
-from sqlalchemy.orm import sessionmaker
+from sqlalchemy.ext.asyncio import AsyncSession, create_async_engine, async_sessionmaker
+from sqlalchemy.orm import DeclarativeBase
 
 from fastapi_jsonapi import RoutersJSONAPI, init
 from fastapi_jsonapi.misc.sqla.generics.base import DetailViewBaseGeneric, ListViewBaseGeneric
@@ -22,7 +22,9 @@
 DB_URL = f"sqlite+aiosqlite:///{CURRENT_DIR.absolute()}/db.sqlite3"
 sys.path.append(str(PROJECT_DIR))
 
-Base = declarative_base()
+
+class Base(DeclarativeBase):
+    pass
 
 
 class User(Base):
@@ -32,8 +34,7 @@ class User(Base):
 
 
 class BaseModel(PydanticBaseModel):
-    class Config:
-        orm_mode = True
+    model_config = ConfigDict(from_attributes=True)
 
 
 class UserAttributesBaseSchema(BaseModel):
@@ -51,11 +52,11 @@ class UserPatchSchema(UserAttributesBaseSchema):
 class UserInSchema(UserAttributesBaseSchema):
     """User input schema."""
 
-    id: int = Field(client_can_set_id=True)
+    id: int = Field(json_schema_extra={"client_can_set_id": True})
 
 
 async def get_session():
-    sess = sessionmaker(
+    sess = async_sessionmaker(
         bind=create_async_engine(url=make_url(DB_URL)),
         class_=AsyncSession,
         expire_on_commit=False,
@@ -74,8 +75,7 @@ async def sqlalchemy_init() -> None:
 class SessionDependency(BaseModel):
     session: AsyncSession = Depends(get_session)
 
-    class Config:
-        arbitrary_types_allowed = True
+    model_config = ConfigDict(arbitrary_types_allowed=True)
 
 
 def session_dependency_handler(view: ViewBase, dto: SessionDependency) -> dict:

docs/python_snippets/relationships/relationships_info_example.py

@@ -1,28 +1,31 @@
 from typing import Optional
 
-from pydantic import BaseModel as PydanticBaseModel
+from pydantic import BaseModel as PydanticBaseModel, ConfigDict
 
 from fastapi_jsonapi.schema_base import Field, RelationshipInfo
 
 
 class BaseModel(PydanticBaseModel):
-    class Config:
-        orm_mode = True
+    model_config = ConfigDict(from_attributes=True)
 
 
 class UserBaseSchema(BaseModel):
     id: int
     name: str
     bio: Optional["UserBioSchema"] = Field(
-        relationship=RelationshipInfo(
-            resource_type="user_bio",
-        ),
+        json_schema_extra={
+            "relationship": RelationshipInfo(
+                resource_type="user_bio",
+            ),
+        },
     )
     computers: Optional["ComputerSchema"] = Field(
-        relationship=RelationshipInfo(
-            resource_type="computer",
-            many=True,
-        ),
+        json_schema_extra={
+            "relationship": RelationshipInfo(
+                resource_type="computer",
+                many=True,
+            ),
+        },
     )
 
 
@@ -37,17 +40,21 @@ class UserBioBaseSchema(BaseModel):
     keys_to_ids_list: dict[str, list[int]] = None
 
     user: "UserSchema" = Field(
-        relationship=RelationshipInfo(
-            resource_type="user",
-        ),
+        json_schema_extra={
+            "relationship": RelationshipInfo(
+                resource_type="user",
+            ),
+        },
     )
 
 
 class ComputerBaseSchema(BaseModel):
     id: int
     name: str
     user: Optional["UserSchema"] = Field(
-        relationship=RelationshipInfo(
-            resource_type="user",
-        ),
+        json_schema_extra={
+            "relationship": RelationshipInfo(
+                resource_type="user",
+            ),
+        },
     )

docs/python_snippets/view_dependencies/main_example.py

@@ -3,7 +3,7 @@
 from typing import ClassVar, Dict
 
 from fastapi import Depends, Header
-from pydantic import BaseModel
+from pydantic import BaseModel, ConfigDict
 from sqlalchemy.engine import make_url
 from sqlalchemy.ext.asyncio import AsyncSession
 from sqlalchemy.ext.asyncio import create_async_engine
@@ -50,8 +50,7 @@ async def async_session_dependency():
 class SessionDependency(BaseModel):
     session: AsyncSession = Depends(async_session_dependency)
 
-    class Config:
-        arbitrary_types_allowed = True
+    model_config = ConfigDict(arbitrary_types_allowed=True)
 
 
 async def common_handler(view: ViewBase, dto: SessionDependency) -> dict:

examples/api_for_sqlalchemy/api/views_base.py

@@ -1,7 +1,7 @@
 from typing import ClassVar, Dict
 
 from fastapi import Depends
-from pydantic import BaseModel
+from pydantic import BaseModel, ConfigDict
 from sqlalchemy.ext.asyncio import AsyncSession
 
 from examples.api_for_sqlalchemy.extensions.sqlalchemy import Connector
@@ -14,8 +14,7 @@
 class SessionDependency(BaseModel):
     session: AsyncSession = Depends(Connector.get_session)
 
-    class Config:
-        arbitrary_types_allowed = True
+    model_config = ConfigDict(arbitrary_types_allowed=True)
 
 
 def handler(view: ViewBase, dto: SessionDependency) -> Dict:

examples/api_for_sqlalchemy/extensions/sqlalchemy.py

@@ -1,11 +1,12 @@
 from sqlalchemy.engine import make_url
 from sqlalchemy.ext.asyncio import AsyncSession, create_async_engine
-from sqlalchemy.ext.declarative import declarative_base
-from sqlalchemy.orm import sessionmaker
+from sqlalchemy.orm import DeclarativeBase, sessionmaker
 
 from examples.api_for_sqlalchemy import config
 
-Base = declarative_base()
+
+class Base(DeclarativeBase):
+    pass
 
 
 def async_session() -> sessionmaker:

examples/api_for_sqlalchemy/models/schemas/child.py

@@ -1,5 +1,7 @@
 from typing import TYPE_CHECKING, List
 
+from pydantic import ConfigDict
+
 from fastapi_jsonapi.schema_base import BaseModel, Field, RelationshipInfo
 
 if TYPE_CHECKING:
@@ -9,17 +11,17 @@
 class ChildBaseSchema(BaseModel):
     """Child base schema."""
 
-    class Config:
-        orm_mode = True
+    model_config = ConfigDict(from_attributes=True)
 
     name: str
-
     parents: List["ParentToChildAssociationSchema"] = Field(
         default=None,
-        relationship=RelationshipInfo(
-            resource_type="parent_child_association",
-            many=True,
-        ),
+        json_schema_extra={
+            "relationship": RelationshipInfo(
+                resource_type="parent_child_association",
+                many=True,
+            ),
+        },
     )
 
 

examples/api_for_sqlalchemy/models/schemas/computer.py

@@ -2,6 +2,8 @@
 
 from typing import TYPE_CHECKING, Optional
 
+from pydantic import ConfigDict
+
 from fastapi_jsonapi.schema_base import BaseModel, Field, RelationshipInfo
 
 if TYPE_CHECKING:
@@ -11,16 +13,15 @@
 class ComputerBaseSchema(BaseModel):
     """Computer base schema."""
 
-    class Config:
-        """Pydantic schema config."""
-
-        orm_mode = True
+    model_config = ConfigDict(from_attributes=True)
 
     name: str
     user: Optional["UserSchema"] = Field(
-        relationship=RelationshipInfo(
-            resource_type="user",
-        ),
+        json_schema_extra={
+            "relationship": RelationshipInfo(
+                resource_type="user",
+            ),
+        },
     )
 
 
@@ -35,9 +36,6 @@ class ComputerInSchema(ComputerBaseSchema):
 class ComputerSchema(ComputerInSchema):
     """Computer item schema."""
 
-    class Config:
-        """Pydantic model config."""
-
-        orm_mode = True
+    model_config = ConfigDict(from_attributes=True)
 
     id: int

examples/api_for_sqlalchemy/models/schemas/parent.py

@@ -1,5 +1,7 @@
 from typing import TYPE_CHECKING, List
 
+from pydantic import ConfigDict
+
 from fastapi_jsonapi.schema_base import BaseModel, Field, RelationshipInfo
 
 if TYPE_CHECKING:
@@ -9,8 +11,7 @@
 class ParentBaseSchema(BaseModel):
     """Parent base schema."""
 
-    class Config:
-        orm_mode = True
+    model_config = ConfigDict(from_attributes=True)
 
     name: str
 

examples/api_for_sqlalchemy/models/schemas/post.py

@@ -3,6 +3,8 @@
 from datetime import datetime
 from typing import TYPE_CHECKING, List
 
+from pydantic import ConfigDict
+
 from fastapi_jsonapi.schema_base import BaseModel, Field, RelationshipInfo
 
 if TYPE_CHECKING:
@@ -13,10 +15,7 @@
 class PostBaseSchema(BaseModel):
     """Post base schema."""
 
-    class Config:
-        """Pydantic schema config."""
-
-        orm_mode = True
+    model_config = ConfigDict(from_attributes=True)
 
     title: str
     body: str
@@ -46,10 +45,7 @@ class PostInSchema(PostBaseSchema):
 class PostSchema(PostInSchema):
     """Post item schema."""
 
-    class Config:
-        """Pydantic model config."""
-
-        orm_mode = True
+    model_config = ConfigDict(from_attributes=True)
 
     id: int
     created_at: datetime = Field(description="Create datetime")

examples/api_for_sqlalchemy/models/schemas/post_comment.py

@@ -2,6 +2,8 @@
 from datetime import datetime
 from typing import TYPE_CHECKING
 
+from pydantic import ConfigDict
+
 from fastapi_jsonapi.schema_base import BaseModel, Field, RelationshipInfo
 
 if TYPE_CHECKING:
@@ -12,10 +14,7 @@
 class PostCommentBaseSchema(BaseModel):
     """PostComment base schema."""
 
-    class Config:
-        """Pydantic schema config."""
-
-        orm_mode = True
+    model_config = ConfigDict(from_attributes=True)
 
     text: str
     created_at: datetime = Field(description="Create datetime")
@@ -44,9 +43,6 @@ class PostCommentInSchema(PostCommentBaseSchema):
 class PostCommentSchema(PostCommentInSchema):
     """PostComment item schema."""
 
-    class Config:
-        """Pydantic model config."""
-
-        orm_mode = True
+    model_config = ConfigDict(from_attributes=True)
 
     id: int

examples/api_for_sqlalchemy/models/schemas/user.py

@@ -4,6 +4,8 @@
 from datetime import datetime
 from typing import TYPE_CHECKING, List, Optional
 
+from pydantic import ConfigDict
+
 from examples.api_for_sqlalchemy.models.enums import UserStatusEnum
 from fastapi_jsonapi.schema_base import BaseModel, Field, RelationshipInfo
 
@@ -16,10 +18,7 @@
 class UserBaseSchema(BaseModel):
     """User base schema."""
 
-    class Config:
-        """Pydantic schema config."""
-
-        orm_mode = True
+    model_config = ConfigDict(from_attributes=True)
 
     class Enum:
         """User enums."""
@@ -64,10 +63,7 @@ class UserInSchema(UserBaseSchema):
 class UserSchema(UserInSchema):
     """User item schema."""
 
-    class Config:
-        """Pydantic model config."""
-
-        orm_mode = True
+    model_config = ConfigDict(from_attributes=True)
 
     id: int
     created_at: datetime = Field(description="Create datetime")