update pydantic package to v2

Author: NatalyaGrigoreva

.github/workflows/testing.yml

@@ -39,7 +39,7 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - name: Install poetry
         run: |
-          python -m pip install --upgrade pip poetry==1.8.2 pre-commit
+          python -m pip install --upgrade pip poetry==1.8.4 pre-commit
           poetry config virtualenvs.create false --local
       - name: Install dependencies
         run: poetry install --all-extras
@@ -87,7 +87,7 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - name: Install poetry
         run: |
-          python -m pip install --upgrade pip poetry==1.8.2 pre-commit
+          python -m pip install --upgrade pip poetry==1.8.4 pre-commit
           poetry config virtualenvs.create false --local
       - name: Install dependencies
         run: poetry install --all-extras

.gitignore

@@ -160,9 +160,6 @@ cython_debug/
 .idea/
 
 /.python-version
-/examples/api_for_tortoise_orm/db.sqlite3
-/examples/api_for_tortoise_orm/db.sqlite3-shm
-/examples/api_for_tortoise_orm/db.sqlite3-wal
 /db.sqlite3
 /db.sqlite3-shm
 /db.sqlite3-wal

README.md

@@ -31,10 +31,11 @@ Create a test.py file and copy the following code into it
 
 ```python
 from pathlib import Path
-from typing import Any, ClassVar, Dict
+from typing import Any, ClassVar
 
 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
@@ -61,12 +62,11 @@ class User(Base):
 
 
 class UserAttributesBaseSchema(BaseModel):
-    name: str
-
-    class Config:
-        """Pydantic schema config."""
+    model_config = ConfigDict(
+        from_attributes=True,
+    )
 
-        orm_mode = True
+    name: str
 
 
 class UserSchema(UserAttributesBaseSchema):
@@ -108,20 +108,21 @@ async def sqlalchemy_init() -> None:
 
 
 class SessionDependency(BaseModel):
-    session: AsyncSession = Depends(Connector.get_session)
+    model_config = ConfigDict(
+        arbitrary_types_allowed=True,
+    )
 
-    class Config:
-        arbitrary_types_allowed = True
+    session: AsyncSession = Depends(Connector.get_session)
 
 
-def session_dependency_handler(view: ViewBase, dto: SessionDependency) -> Dict[str, Any]:
+def session_dependency_handler(view: ViewBase, dto: SessionDependency) -> dict[str, Any]:
     return {
         "session": dto.session,
     }
 
 
 class UserDetailView(DetailViewBaseGeneric):
-    method_dependencies: ClassVar[Dict[HTTPMethod, HTTPMethodConfig]] = {
+    method_dependencies: ClassVar[dict[HTTPMethod, HTTPMethodConfig]] = {
         HTTPMethod.ALL: HTTPMethodConfig(
             dependencies=SessionDependency,
             prepare_data_layer_kwargs=session_dependency_handler,
@@ -130,7 +131,7 @@ class UserDetailView(DetailViewBaseGeneric):
 
 
 class UserListView(ListViewBaseGeneric):
-    method_dependencies: ClassVar[Dict[HTTPMethod, HTTPMethodConfig]] = {
+    method_dependencies: ClassVar[dict[HTTPMethod, HTTPMethodConfig]] = {
         HTTPMethod.ALL: HTTPMethodConfig(
             dependencies=SessionDependency,
             prepare_data_layer_kwargs=session_dependency_handler,
@@ -190,7 +191,7 @@ if __name__ == "__main__":
         host="0.0.0.0",
         port=8080,
         reload=True,
-        app_dir=str(CURRENT_DIR),
+        app_dir=f"{CURRENT_DIR}",
     )
 ```
 

docs/fastapi-jsonapi.rst

@@ -25,22 +25,6 @@ fastapi_jsonapi.data_layers.filtering.sqlalchemy module
     :undoc-members:
     :show-inheritance:
 
-fastapi_jsonapi.data_layers.filtering.tortoise_operation module
----------------------------------------------------------------
-
-.. automodule:: fastapi_jsonapi.data_layers.filtering.tortoise_operation
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-fastapi_jsonapi.data_layers.filtering.tortoise_orm module
----------------------------------------------------------
-
-.. automodule:: fastapi_jsonapi.data_layers.filtering.tortoise_orm
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 fastapi_jsonapi.data_layers.sorting.sqlalchemy module
 -----------------------------------------------------
 
@@ -49,14 +33,6 @@ fastapi_jsonapi.data_layers.sorting.sqlalchemy module
     :undoc-members:
     :show-inheritance:
 
-fastapi_jsonapi.data_layers.sorting.tortoise_orm module
--------------------------------------------------------
-
-.. automodule:: fastapi_jsonapi.data_layers.sorting.tortoise_orm
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 fastapi_jsonapi.data_layers.base module
 ---------------------------------------
 
@@ -97,14 +73,6 @@ fastapi_jsonapi.data_layers.sqla_orm module
     :undoc-members:
     :show-inheritance:
 
-fastapi_jsonapi.data_layers.tortoise_orm module
------------------------------------------------
-
-.. automodule:: fastapi_jsonapi.data_layers.tortoise_orm
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 fastapi_jsonapi.api module
 --------------------------
 

docs/http_snippets/snippets/example_atomic_five__mixed_actions_result

@@ -18,7 +18,6 @@ Content-Type: application/json
         "attributes": {
           "birth_city": "Saint Petersburg",
           "favourite_movies": "\"The Good, the Bad and the Ugly\", \"Once Upon a Time in America\"",
-          "keys_to_ids_list": null,
         },
         "id": "2",
         "type": "user_bio"

docs/http_snippets/update_snippets_with_responses.py

@@ -50,10 +50,10 @@ def __lt__(self, other):
 
 
 def run_request_for_module(module_name: str):
-    log.info("Start processing %r", module_name)
+    log.info("Start processing %s", module_name)
 
     module_full_name = ".".join((SNIPPETS_DIR, module_name))
-    log.debug("import module %s", module_full_name)
+    log.debug("Import module %s", module_full_name)
     module = importlib.import_module(module_full_name)
 
     log.info("Process module %s", module)
@@ -68,15 +68,11 @@ def run_request_for_module(module_name: str):
 
     http_response_text.append(
         # "HTTP/1.1 201 Created"
-        "{} {} {}".format(
-            "HTTP/1.1",
-            response.status_code,
-            response_reason,
-        )
+        f"HTTP/1.1 {response.status_code} {response.status_code}"
     )
 
     if ct := response.headers.get("content-type"):
-        http_response_text.append("{}: {}".format("Content-Type", ct))
+        http_response_text.append(f"Content-Type: {ct}")
     http_response_text.append("")
 
     if response.content:
@@ -96,9 +92,9 @@ def run_request_for_module(module_name: str):
     result_file_name = "/".join((SNIPPETS_DIR, module_name + SNIPPET_RESULT_POSTFIX))
     with open(result_file_name, "w") as f:
         res = f.write(result_text)
-        log.info("Wrote text (%s) to %r", res, result_file_name)
+        log.info("Wrote text (%s) to %s", res, result_file_name)
 
-    log.info("Processed %r", module_name)
+    log.info("Processed %s", module_name)
 
 
 def add_help_lines(lines: list, module_name: str) -> None:
@@ -145,13 +141,13 @@ def main():
     log.warning("Starting")
 
     available_modules = os.listdir(SNIPPETS_DIR)
-    log.debug("all available snippets: %s", available_modules)
+    log.debug("All available snippets: %s", available_modules)
     modules_to_process = list(
         # exclude unknown
         filter(lambda name: name.startswith(args.prefix), available_modules)
     )
     modules_to_process.sort(key=StrOrderCRUD)
-    log.warning("modules to process (with order): %s", modules_to_process)
+    log.warning("Modules to process (with order): %s", modules_to_process)
 
     result_help_text = []
     result_help_text.append("=" * 30)
@@ -162,7 +158,7 @@ def main():
             try:
                 run_request_for_module(module_name)
             except Exception:
-                log.exception("Could not process module %r, skipping", module_file)
+                log.exception("Could not process module %s, skipping", module_file)
             else:
                 if REMOVE_PYTHON_SNIPPET:
                     os.unlink("/".join((SNIPPETS_DIR, module_file)))

docs/logical_data_abstraction.rst

@@ -45,26 +45,28 @@ Now let's create the logical abstraction to illustrate this concept.
 
     from pydantic import (
         BaseModel,
+        ConfigDict,
         Field,
     )
-    from typing import List
     from datetime import datetime
 
 
     class UserSchema(BaseModel):
-        class Config:
-            orm_mode = True
+        model_config = ConfigDict(
+            from_attributes=True,
+        )
 
         id: int
         name: str
         email: str
         birth_date: datetime
-        computers: List['ComputerSchema']
+        computers: list['ComputerSchema']
 
 
     class ComputerSchema(BaseModel):
-        class Config:
-            orm_mode = True
+        model_config = ConfigDict(
+            from_attributes=True,
+        )
 
         id: int
         serial: str

docs/python_snippets/client_generated_id/schematic_example.py

@@ -1,10 +1,11 @@
 import sys
 from pathlib import Path
-from typing import ClassVar
+from typing import ClassVar, Annotated
 
 import uvicorn
 from fastapi import APIRouter, Depends, FastAPI
-from fastapi_jsonapi.schema_base import Field, BaseModel as PydanticBaseModel
+from fastapi_jsonapi.schema_base import BaseModel
+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
@@ -13,30 +14,31 @@
 
 from fastapi_jsonapi import RoutersJSONAPI, init
 from fastapi_jsonapi.misc.sqla.generics.base import DetailViewBaseGeneric, ListViewBaseGeneric
+from fastapi_jsonapi.types_metadata import ClientCanSetId
 from fastapi_jsonapi.views.utils import HTTPMethod, HTTPMethodConfig
 from fastapi_jsonapi.views.view_base import ViewBase
 
 CURRENT_FILE = Path(__file__).resolve()
 CURRENT_DIR = CURRENT_FILE.parent
 PROJECT_DIR = CURRENT_DIR.parent.parent
 DB_URL = f"sqlite+aiosqlite:///{CURRENT_DIR.absolute()}/db.sqlite3"
-sys.path.append(str(PROJECT_DIR))
+sys.path.append(f"{PROJECT_DIR}")
 
 Base = declarative_base()
 
 
 class User(Base):
     __tablename__ = "users"
+
     id = Column(Integer, primary_key=True, autoincrement=False)
     name = Column(Text, nullable=True)
 
 
-class BaseModel(PydanticBaseModel):
-    class Config:
-        orm_mode = True
-
-
 class UserAttributesBaseSchema(BaseModel):
+    model_config = ConfigDict(
+        from_attributes=True,
+    )
+
     name: str
 
 
@@ -51,7 +53,7 @@ class UserPatchSchema(UserAttributesBaseSchema):
 class UserInSchema(UserAttributesBaseSchema):
     """User input schema."""
 
-    id: int = Field(client_can_set_id=True)
+    id: Annotated[int, ClientCanSetId()]
 
 
 async def get_session():
@@ -72,14 +74,17 @@ async def sqlalchemy_init() -> None:
 
 
 class SessionDependency(BaseModel):
-    session: AsyncSession = Depends(get_session)
+    model_config = ConfigDict(
+        arbitrary_types_allowed=True,
+    )
 
-    class Config:
-        arbitrary_types_allowed = True
+    session: AsyncSession = Depends(get_session)
 
 
 def session_dependency_handler(view: ViewBase, dto: SessionDependency) -> dict:
-    return {"session": dto.session}
+    return {
+        "session": dto.session,
+    }
 
 
 class UserDetailView(DetailViewBaseGeneric):
@@ -153,5 +158,5 @@ def create_app() -> FastAPI:
         host="0.0.0.0",
         port=8084,
         reload=True,
-        app_dir=str(CURRENT_DIR),
+        app_dir=f"{CURRENT_DIR}",
     )

docs/python_snippets/data_layer/custom_data_layer.py

@@ -10,8 +10,6 @@
 class MyCustomDataLayer(BaseDataLayer):
     """Overload abstract methods here"""
 
-    ...
-
 
 class MyCustomSqlaDataLayer(SqlalchemyDataLayer):
     """Overload any methods here"""

docs/python_snippets/relationships/models.py

@@ -7,8 +7,9 @@
 
 class User(Base, BaseModelMixin):
     __tablename__ = "users"
+
     id = Column(Integer, primary_key=True, autoincrement=True)
-    name: str = Column(String)
+    name = Column(String)
 
     posts = relationship("Post", back_populates="user", uselist=True)
     bio = relationship("UserBio", back_populates="user", uselist=False)
@@ -20,14 +21,17 @@ class Computer(Base, BaseModelMixin):
 
     id = Column(Integer, primary_key=True, autoincrement=True)
     name = Column(String, nullable=False)
+
     user_id = Column(Integer, ForeignKey("users.id"), nullable=True)
     user = relationship("User", back_populates="computers")
 
 
 class UserBio(Base, BaseModelMixin):
     __tablename__ = "user_bio"
+
     id = Column(Integer, primary_key=True, autoincrement=True)
-    birth_city: str = Column(String, nullable=False, default="", server_default="")
-    favourite_movies: str = Column(String, nullable=False, default="", server_default="")
+    birth_city = Column(String, nullable=False, default="", server_default="")
+    favourite_movies = Column(String, nullable=False, default="", server_default="")
+
     user_id = Column(Integer, ForeignKey("users.id"), nullable=False, unique=True)
     user = relationship("User", back_populates="bio", uselist=False)