✨ Migrate from Pydantic V1 to V2 [WIP]

.github/workflows/testing.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - main
+      - dev-3.x
     paths:
       - ".github/workflows/testing.yml"
       - "fastapi_jsonapi/**"
@@ -13,6 +14,7 @@ on:
   pull_request:
     branches:
       - main
+      - dev-3.x
     paths:
       - ".github/workflows/testing.yml"
       - "fastapi_jsonapi/**"

docs/python_snippets/client_generated_id/schematic_example.py

@@ -4,6 +4,7 @@
 
 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
@@ -32,8 +33,7 @@ class User(Base):
 
 
 class BaseModel(PydanticBaseModel):
-    class Config:
-        orm_mode = True
+    model_config = ConfigDict(from_attributes=True)
 
 
 class UserAttributesBaseSchema(BaseModel):

docs/python_snippets/relationships/relationships_info_example.py

@@ -1,13 +1,12 @@
 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):

examples/api_for_sqlalchemy/extensions/sqlalchemy.py

@@ -1,7 +1,6 @@
 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 declarative_base, sessionmaker
 
 from examples.api_for_sqlalchemy import config
 

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,8 +11,7 @@
 class ChildBaseSchema(BaseModel):
     """Child base schema."""
 
-    class Config:
-        orm_mode = True
+    model_config = ConfigDict(from_attributes=True)
 
     name: str
 

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,10 +13,7 @@
 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(
@@ -35,9 +34,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")

examples/api_for_sqlalchemy/models/schemas/user_bio.py

@@ -3,6 +3,8 @@
 from datetime import datetime
 from typing import TYPE_CHECKING, Dict, List
 
+from pydantic import ConfigDict
+
 from fastapi_jsonapi.schema_base import BaseModel, Field, RelationshipInfo
 
 if TYPE_CHECKING:
@@ -12,10 +14,7 @@
 class UserBioBaseSchema(BaseModel):
     """UserBio base schema."""
 
-    class Config:
-        """Pydantic schema config."""
-
-        orm_mode = True
+    model_config = ConfigDict(from_attributes=True)
 
     birth_city: str
     favourite_movies: str
@@ -39,10 +38,7 @@ class UserBioInSchema(UserBioBaseSchema):
 class UserBioSchema(UserBioInSchema):
     """UserBio 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_tortoise_orm/api/user.py

@@ -48,23 +48,23 @@ async def get_user(cls, user_id: int, query_params: QueryStringManager) -> User:
     @classmethod
     async def get(cls, obj_id: int, query_params: QueryStringManager) -> UserSchema:
         user: User = await cls.get_user(user_id=obj_id, query_params=query_params)
-        return UserSchema.from_orm(user)
+        return UserSchema.model_validate(user)
 
     @classmethod
     async def patch(cls, obj_id: int, data: UserPatchSchema, query_params: QueryStringManager) -> UserSchema:
         user_obj: User
         try:
             user_obj = await UpdateUser.update(
                 obj_id,
-                data.dict(exclude_unset=True),
+                data.model_dump(exclude_unset=True),
                 query_params.headers,
             )
         except ErrorUpdateUserObject as ex:
             raise BadRequest(ex.description, ex.field)
         except ObjectNotFound as ex:
             raise HTTPException(status_code=HTTPStatus.NOT_FOUND, detail=ex.description)
 
-        user = UserSchema.from_orm(user_obj)
+        user = UserSchema.model_validate(user_obj)
         return user
 
 
@@ -75,22 +75,22 @@ async def get(cls, query_params: QueryStringManager) -> Union[QuerySet, JSONAPIR
         dl = TortoiseDataLayer(query=user_query, schema=UserSchema, model=User)
         count, users_db = await dl.get_collection(qs=query_params)
         total_pages = count // query_params.pagination.size + (count % query_params.pagination.size and 1)
-        users: List[UserSchema] = [UserSchema.from_orm(i_user) for i_user in users_db]
+        users: List[UserSchema] = [UserSchema.model_validate(i_user) for i_user in users_db]
         return JSONAPIResultListSchema(
             meta={"count": count, "totalPages": total_pages},
-            data=[{"id": i_obj.id, "attributes": i_obj.dict(), "type": "user"} for i_obj in users],
+            data=[{"id": i_obj.id, "attributes": i_obj.model_dump(), "type": "user"} for i_obj in users],
         )
 
     @classmethod
     async def post(cls, data: UserInSchema, query_params: QueryStringManager) -> UserSchema:
         try:
             user_obj = await UserFactory.create(
-                data=data.dict(),
+                data=data.model_dump(),
                 mode=FactoryUseMode.production,
                 header=query_params.headers,
             )
         except ErrorCreateUserObject as ex:
             raise BadRequest(ex.description, ex.field)
 
-        user = UserSchema.from_orm(user_obj)
+        user = UserSchema.model_validate(user_obj)
         return user

examples/api_for_tortoise_orm/models/pydantic/user.py

@@ -6,6 +6,7 @@
 from pydantic import (
     BaseModel,
     Field,
+    ConfigDict,
 )
 
 from examples.api_for_tortoise_orm.models.enums import UserStatusEnum
@@ -14,10 +15,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."""
@@ -40,11 +38,7 @@ class UserInSchema(UserBaseSchema):
 class UserSchema(UserInSchema):
     """User item schema."""
 
-    class Config:
-        """Pydantic model config."""
-
-        orm_mode = True
-        model = "users"
+    model_config = ConfigDict(from_attributes=True)
 
     id: int
     created_at: datetime = Field(description="Время создания данных")

examples/api_limited_methods.py

@@ -4,6 +4,7 @@
 
 import uvicorn
 from fastapi import APIRouter, Depends, FastAPI
+from pydantic import ConfigDict
 from sqlalchemy import Column, Integer, Text
 from sqlalchemy.engine import make_url
 from sqlalchemy.ext.asyncio import AsyncSession, create_async_engine
@@ -34,8 +35,7 @@ class User(Base):
 class UserAttributesBaseSchema(BaseModel):
     name: str
 
-    class Config:
-        orm_mode = True
+    model_config = ConfigDict(from_attributes=True)
 
 
 class UserSchema(UserAttributesBaseSchema):
@@ -151,6 +151,6 @@ def create_app() -> FastAPI:
 if __name__ == "__main__":
     uvicorn.run(
         app,
-        host="0.0.0.0",
+        host="127.0.0.1",
         port=8080,
     )