Pydantic V2 full support + massive refactoring

.coveragerc

@@ -3,7 +3,6 @@
 concurrency = greenlet
 branch = True
 omit =
-    tests/*
     examples/*
     docs/*
     # omit anything in a .local directory anywhere

.github/workflows/testing.yml

@@ -31,19 +31,18 @@ jobs:
           - "3.9"
           - "3.10"
           - "3.11"
+          - "3.12"
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Install poetry
-        run: |
-          python -m pip install --upgrade pip poetry==1.8.2 pre-commit
-          poetry config virtualenvs.create false --local
+      - name: Install build dependencies
+        run: python -m pip install --upgrade pip pre-commit hatch
       - name: Install dependencies
-        run: poetry install --all-extras
+        run: hatch env create
       - name: Lint code
         run: pre-commit run --all-files
 
@@ -56,6 +55,7 @@ jobs:
           - "3.9"
           - "3.10"
           - "3.11"
+          - "3.12"
         db-url:
           - "sqlite+aiosqlite:///./db.sqlite3"
           - "postgresql+asyncpg://user:passwd@localhost:5432/app"
@@ -81,29 +81,25 @@ jobs:
           # Maps tcp port 5432 on service container to the host
           - 5432:5432
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Install poetry
-        run: |
-          python -m pip install --upgrade pip poetry==1.8.2 pre-commit
-          poetry config virtualenvs.create false --local
-      - name: Install dependencies
-        run: poetry install --all-extras
-      - name: Test with pytest
-        run: |
-          flags="-s -vv --cov=fastapi_jsonapi --cov-config .coveragerc --cov-report=xml"
-          pytest $flags tests/
+      - name: ♿ Install dependencies
+        run: python -m pip install --upgrade pip build "hatch==1.12.0"
+      - name: 🔨 Build package
+        run: python -m build
+      - name: Test with pytest and coverage through hatch
+        run: hatch run test.py${{ matrix.python-version }}:cov-xml -v
         env:
           TESTING_DB_URL: ${{ matrix.db-url }}
 
       - name: Upload coverage data to Codecov
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v4
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
-          files: coverage.xml
+          files: coverage/${{ matrix.python-version }}/coverage.xml
           flags: unittests
           name: py-${{ matrix.python-version }}-db-${{ startsWith(matrix.db-url, 'sqlite') && 'sqlite' || startsWith(matrix.db-url, 'postgres') && 'postgres' || 'unknown' }}
           fail_ci_if_error: true

.pre-commit-config.yaml

@@ -1,21 +1,27 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: "v3.2.0"
+    rev: "v4.6.0"
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
       - id: check-yaml
+      - id: check-toml
+      - id: check-json
       - id: check-added-large-files
       - id: mixed-line-ending
-      - id: requirements-txt-fixer
+      - id: check-case-conflict
 
-  - repo: https://github.com/psf/black
-    rev: "23.3.0"
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.4.8
     hooks:
-      - id: black
+      # Run the linter.
+      - id: ruff
+        args:
+          - "--fix"
+      # Run the formatter.
+      - id: ruff-format
 
-  - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: "v0.1.8"
+  - repo: https://github.com/psf/black
+    rev: "24.4.2"
     hooks:
-      - id: ruff
-        args: [--fix, --exit-non-zero-on-fix, --unsafe-fixes]
+      - id: black

codecov.yaml

@@ -21,4 +21,5 @@ comment:
   require_changes: no
   branches:
     - main
-  after_n_builds: 6  # 3 python versions by 2 dbs
+    - dev-3.x
+  after_n_builds: 8  # 4 python versions by 2 dbs

docs/http_snippets/update_snippets_with_responses.py

@@ -4,7 +4,7 @@
 from http import HTTPStatus
 
 import requests
-import simplejson
+import json
 import argparse
 
 parser = argparse.ArgumentParser()
@@ -83,7 +83,7 @@ def run_request_for_module(module_name: str):
     if response.content:
         # TODO: handle non-json response?
         http_response_text.append(
-            simplejson.dumps(
+            json.dumps(
                 response.json(),
                 sort_keys=SORT_KEYS_ON_DUMP,
                 indent=2,

docs/python_snippets/client_generated_id/schematic_example.py

@@ -1,9 +1,14 @@
 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.types_metadata import ClientCanSetId
 from pydantic import ConfigDict
 from fastapi_jsonapi.schema_base import Field, BaseModel as PydanticBaseModel
 from sqlalchemy import Column, Integer, Text
@@ -52,7 +57,7 @@ class UserPatchSchema(UserAttributesBaseSchema):
 class UserInSchema(UserAttributesBaseSchema):
     """User input schema."""
 
-    id: int = Field(json_schema_extra={"client_can_set_id": True})
+    id: Annotated[int, ClientCanSetId()]
 
 
 async def get_session():

docs/python_snippets/relationships/models.py

@@ -2,10 +2,12 @@
 from sqlalchemy.orm import relationship
 
 from examples.api_for_sqlalchemy.extensions.sqlalchemy import Base
-from examples.api_for_sqlalchemy.utils.sqlalchemy.base_model_mixin import BaseModelMixin
+from examples.api_for_sqlalchemy.utils.sqlalchemy.timestamps_mixin import TimestampsMixin
 
+# TODO: sqla 2.0
 
-class User(Base, BaseModelMixin):
+
+class User(Base, TimestampsMixin):
     __tablename__ = "users"
     id = Column(Integer, primary_key=True, autoincrement=True)
     name: str = Column(String)
@@ -15,7 +17,7 @@ class User(Base, BaseModelMixin):
     computers = relationship("Computer", back_populates="user", uselist=True)
 
 
-class Computer(Base, BaseModelMixin):
+class Computer(Base, TimestampsMixin):
     __tablename__ = "computers"
 
     id = Column(Integer, primary_key=True, autoincrement=True)
@@ -24,7 +26,7 @@ class Computer(Base, BaseModelMixin):
     user = relationship("User", back_populates="computers")
 
 
-class UserBio(Base, BaseModelMixin):
+class UserBio(Base, TimestampsMixin):
     __tablename__ = "user_bio"
     id = Column(Integer, primary_key=True, autoincrement=True)
     birth_city: str = Column(String, nullable=False, default="", server_default="")

docs/python_snippets/relationships/relationships_info_example.py

@@ -1,8 +1,10 @@
-from typing import Optional
+from __future__ import annotations
+
+from typing import Annotated
 
 from pydantic import BaseModel as PydanticBaseModel, ConfigDict
 
-from fastapi_jsonapi.schema_base import Field, RelationshipInfo
+from fastapi_jsonapi.types_metadata import RelationshipInfo
 
 
 class BaseModel(PydanticBaseModel):
@@ -12,49 +14,45 @@ class BaseModel(PydanticBaseModel):
 class UserBaseSchema(BaseModel):
     id: int
     name: str
-    bio: Optional["UserBioSchema"] = Field(
-        json_schema_extra={
-            "relationship": RelationshipInfo(
-                resource_type="user_bio",
-            ),
-        },
-    )
-    computers: Optional["ComputerSchema"] = Field(
-        json_schema_extra={
-            "relationship": RelationshipInfo(
-                resource_type="computer",
-                many=True,
-            ),
-        },
-    )
+    bio: Annotated[
+        UserBioSchema | None,
+        RelationshipInfo(
+            resource_type="user_bio",
+        ),
+    ]
+    computers: Annotated[
+        ComputerSchema | None,
+        RelationshipInfo(
+            resource_type="computer",
+            many=True,
+        ),
+    ]
 
 
 class UserSchema(BaseModel):
     id: int
     name: str
 
 
-class UserBioBaseSchema(BaseModel):
+class UserBioSchema(BaseModel):
     birth_city: str
     favourite_movies: str
     # keys_to_ids_list: Optional[dict[str, list[int]]] = None
 
-    user: "UserSchema" = Field(
-        json_schema_extra={
-            "relationship": RelationshipInfo(
-                resource_type="user",
-            ),
-        },
-    )
+    user: Annotated[
+        UserSchema | None,
+        RelationshipInfo(
+            resource_type="user",
+        ),
+    ]
 
 
-class ComputerBaseSchema(BaseModel):
+class ComputerSchema(BaseModel):
     id: int
     name: str
-    user: Optional["UserSchema"] = Field(
-        json_schema_extra={
-            "relationship": RelationshipInfo(
-                resource_type="user",
-            ),
-        },
-    )
+    user: Annotated[
+        UserSchema | None,
+        RelationshipInfo(
+            resource_type="user",
+        ),
+    ]

docs/requirements.txt

@@ -1,7 +1,7 @@
-fastapi<0.100.0
-pydantic<2
-simplejson>=3.17.6
+fastapi>=0.100.0
+pydantic>=2
+orjson>=3.10.7
 sphinx
 sphinx_rtd_theme
-sqlalchemy<2
+sqlalchemy>=2
 tortoise-orm>=0.19.3

examples/api_for_sqlalchemy/api/views_base.py

@@ -1,4 +1,4 @@
-from typing import ClassVar, Dict
+from typing import ClassVar
 
 from fastapi import Depends
 from pydantic import BaseModel, ConfigDict
@@ -17,7 +17,7 @@ class SessionDependency(BaseModel):
     model_config = ConfigDict(arbitrary_types_allowed=True)
 
 
-def handler(view: ViewBase, dto: SessionDependency) -> Dict:
+def handler(view: ViewBase, dto: SessionDependency) -> dict:
     return {"session": dto.session}
 
 

examples/api_for_sqlalchemy/asgi.py

@@ -2,4 +2,6 @@
 
 from examples.api_for_sqlalchemy.main import create_app
 
-app = create_app()
+app = create_app(
+    create_custom_static_urls=True,
+)

examples/api_for_sqlalchemy/extensions/sqlalchemy.py

@@ -1,18 +1,22 @@
 from sqlalchemy.engine import make_url
 from sqlalchemy.ext.asyncio import AsyncSession, create_async_engine
-from sqlalchemy.orm import DeclarativeBase, sessionmaker
+from sqlalchemy.orm import (
+    DeclarativeBase,
+    Mapped,
+    mapped_column,
+    sessionmaker,
+)
 
 from examples.api_for_sqlalchemy import config
 
 
 class Base(DeclarativeBase):
-    pass
+    id: Mapped[int] = mapped_column(primary_key=True)
 
 
 def async_session() -> sessionmaker:
     engine = create_async_engine(url=make_url(config.SQLA_URI), echo=config.SQLA_ECHO)
-    _async_session = sessionmaker(bind=engine, class_=AsyncSession, expire_on_commit=False)
-    return _async_session
+    return sessionmaker(bind=engine, class_=AsyncSession, expire_on_commit=False)
 
 
 class Connector: