Merge branch 'main' into dependabot/pip/mypy-1.18.1

Author: svlandeg

.github/workflows/deploy-docs.yml

@@ -44,7 +44,7 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           COMMIT_SHA: ${{ github.event.workflow_run.head_sha }}
           RUN_ID: ${{ github.run_id }}
-
+          STATE: "pending"
       - name: Clean site
         run: |
           rm -rf ./site
@@ -68,11 +68,19 @@ jobs:
           apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
           accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
           command: pages deploy ./site --project-name=${{ env.PROJECT_NAME }} --branch=${{ env.BRANCH }}
+      - name: Deploy Docs Status Error
+        if: failure()
+        run: python ./scripts/deploy_docs_status.py
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          COMMIT_SHA: ${{ github.event.workflow_run.head_sha }}
+          RUN_ID: ${{ github.run_id }}
+          STATE: "error"
       - name: Comment Deploy
         run: python ./scripts/deploy_docs_status.py
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           DEPLOY_URL: ${{ steps.deploy.outputs.deployment-url }}
           COMMIT_SHA: ${{ github.event.workflow_run.head_sha }}
           RUN_ID: ${{ github.run_id }}
-          IS_DONE: "true"
+          STATE: "success"

.github/workflows/issue-manager.yml

@@ -27,7 +27,7 @@ jobs:
         env:
           GITHUB_CONTEXT: ${{ toJson(github) }}
         run: echo "$GITHUB_CONTEXT"
-      - uses: tiangolo/issue-manager@0.5.1
+      - uses: tiangolo/issue-manager@0.6.0
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           config: >

.pre-commit-config.yaml

@@ -14,7 +14,7 @@ repos:
     -   id: end-of-file-fixer
     -   id: trailing-whitespace
 -   repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.13.1
+    rev: v0.13.3
     hooks:
     -   id: ruff
         args:

docs/release-notes.md

@@ -2,8 +2,22 @@
 
 ## Latest Changes
 
+### Fixes
+
+* 🐛 Fix attribute handling in `model_dump` for compatibility with the latest Pydantic versions. PR [#1595](https://github.com/fastapi/sqlmodel/pull/1595) by [@spazm](https://github.com/spazm).
+
+### Docs
+
+* 📝 Fix typo in `docs/tutorial/fastapi/simple-hero-api.md`. PR [#1583](https://github.com/fastapi/sqlmodel/pull/1583) by [@kofi-kusi](https://github.com/kofi-kusi).
+
 ### Internal
 
+* ✅ Add test that runs select with 3 or 4 arguments. PR [#1590](https://github.com/fastapi/sqlmodel/pull/1590) by [@svlandeg](https://github.com/svlandeg).
+* ⬆ Bump mkdocs-macros-plugin from 1.3.9 to 1.4.0. PR [#1581](https://github.com/fastapi/sqlmodel/pull/1581) by [@dependabot[bot]](https://github.com/apps/dependabot).
+* ⬆ Bump mkdocs-material from 9.6.20 to 9.6.21. PR [#1588](https://github.com/fastapi/sqlmodel/pull/1588) by [@dependabot[bot]](https://github.com/apps/dependabot).
+* ⬆ [pre-commit.ci] pre-commit autoupdate. PR [#1584](https://github.com/fastapi/sqlmodel/pull/1584) by [@pre-commit-ci[bot]](https://github.com/apps/pre-commit-ci).
+* ⬆ Bump tiangolo/issue-manager from 0.5.1 to 0.6.0. PR [#1589](https://github.com/fastapi/sqlmodel/pull/1589) by [@dependabot[bot]](https://github.com/apps/dependabot).
+* 👷 Update docs previews comment, single comment, add failure status. PR [#1586](https://github.com/fastapi/sqlmodel/pull/1586) by [@tiangolo](https://github.com/tiangolo).
 * ⬆ Bump markdown-include-variants from 0.0.4 to 0.0.5. PR [#1582](https://github.com/fastapi/sqlmodel/pull/1582) by [@dependabot[bot]](https://github.com/apps/dependabot).
 * ⬆ Bump typing-extensions from 4.13.2 to 4.15.0 for Python 3.9+. PR [#1580](https://github.com/fastapi/sqlmodel/pull/1580) by [@svlandeg](https://github.com/svlandeg).
 * ⬆ [pre-commit.ci] pre-commit autoupdate. PR [#1571](https://github.com/fastapi/sqlmodel/pull/1571) by [@pre-commit-ci[bot]](https://github.com/apps/pre-commit-ci).

docs/tutorial/fastapi/simple-hero-api.md

@@ -60,7 +60,7 @@ And then create an `app` object that is an instance of that `FastAPI` class:
 
 ## Create Database and Tables on `startup`
 
-We want to make sure that once the app starts running, the function `create_tables` is called. To create the database and tables.
+We want to make sure that once the app starts running, the function `create_db_and_tables` is called. To create the database and tables.
 
 This should be called only once at startup, not before every request, so we put it in the function to handle the `"startup"` event:
 

requirements-docs.txt

@@ -1,6 +1,6 @@
 -e .
 -r requirements-docs-tests.txt
-mkdocs-material==9.6.20
+mkdocs-material==9.6.21
 mdx-include >=1.4.1,<2.0.0
 mkdocs-redirects>=1.2.1,<1.3.0
 pyyaml >=5.3.1,<7.0.0
@@ -14,5 +14,5 @@ cairosvg==2.8.2
 griffe-typingdoc==0.2.9
 # For griffe, it formats with black
 typer == 0.19.2
-mkdocs-macros-plugin==1.3.9
+mkdocs-macros-plugin==1.4.0
 markdown-include-variants==0.0.5

scripts/deploy_docs_status.py

@@ -1,7 +1,8 @@
 import logging
 import re
+from typing import Literal
 
-from github import Github
+from github import Auth, Github
 from pydantic import BaseModel, SecretStr
 from pydantic_settings import BaseSettings
 
@@ -14,7 +15,7 @@ class Settings(BaseSettings):
     deploy_url: str | None = None
     commit_sha: str
     run_id: int
-    is_done: bool = False
+    state: Literal["pending", "success", "error"] = "pending"
 
 
 class LinkData(BaseModel):
@@ -27,7 +28,7 @@ def main() -> None:
     settings = Settings()
 
     logging.info(f"Using config: {settings.model_dump_json()}")
-    g = Github(settings.github_token.get_secret_value())
+    g = Github(auth=Auth.Token(settings.github_token.get_secret_value()))
     repo = g.get_repo(settings.github_repository)
     use_pr = next(
         (pr for pr in repo.get_pulls() if pr.head.sha == settings.commit_sha), None
@@ -38,24 +39,35 @@ def main() -> None:
     commits = list(use_pr.get_commits())
     current_commit = [c for c in commits if c.sha == settings.commit_sha][0]
     run_url = f"https://github.com/{settings.github_repository}/actions/runs/{settings.run_id}"
-    if settings.is_done and not settings.deploy_url:
+    if settings.state == "pending":
         current_commit.create_status(
-            state="success",
-            description="No Docs Changes",
+            state="pending",
+            description="Deploying Docs",
             context="deploy-docs",
             target_url=run_url,
         )
-        logging.info("No docs changes found")
+        logging.info("No deploy URL available yet")
         return
+    if settings.state == "error":
+        current_commit.create_status(
+            state="error",
+            description="Error Deploying Docs",
+            context="deploy-docs",
+            target_url=run_url,
+        )
+        logging.info("Error deploying docs")
+        return
+    assert settings.state == "success"
     if not settings.deploy_url:
         current_commit.create_status(
-            state="pending",
-            description="Deploying Docs",
+            state="success",
+            description="No Docs Changes",
             context="deploy-docs",
             target_url=run_url,
         )
-        logging.info("No deploy URL available yet")
+        logging.info("No docs changes found")
         return
+    assert settings.deploy_url
     current_commit.create_status(
         state="success",
         description="Docs Deployed",
@@ -84,7 +96,9 @@ def main() -> None:
         links.append(link)
         links.sort(key=lambda x: x.preview_link)
 
-    message = f"📝 Docs preview for commit {settings.commit_sha} at: {deploy_url}"
+    header = "## 📝 Docs preview"
+    message = header
+    message += f"\n\nLast commit {settings.commit_sha} at: {deploy_url}"
 
     if links:
         message += "\n\n### Modified Pages\n\n"
@@ -94,7 +108,17 @@ def main() -> None:
             message += "\n"
 
     print(message)
-    use_pr.as_issue().create_comment(message)
+    issue = use_pr.as_issue()
+    comments = list(issue.get_comments())
+    for comment in comments:
+        if (
+            comment.body.startswith(header)
+            and comment.user.login == "github-actions[bot]"
+        ):
+            comment.edit(message)
+            break
+    else:
+        issue.create_comment(message)
 
     logging.info("Finished")
 

scripts/lint.sh

@@ -4,5 +4,6 @@ set -e
 set -x
 
 mypy sqlmodel
+mypy tests/test_select_typing.py
 ruff check sqlmodel tests docs_src scripts
 ruff format sqlmodel tests docs_src scripts --check

sqlmodel/main.py

@@ -111,7 +111,8 @@ def __dataclass_transform__(
     return lambda a: a
 
 
-class FieldInfo(PydanticFieldInfo):
+class FieldInfo(PydanticFieldInfo):  # type: ignore[misc]
+    # mypy - ignore that PydanticFieldInfo is @final
     def __init__(self, default: Any = Undefined, **kwargs: Any) -> None:
         primary_key = kwargs.pop("primary_key", False)
         nullable = kwargs.pop("nullable", Undefined)
@@ -865,27 +866,27 @@ def model_dump(
         mode: Union[Literal["json", "python"], str] = "python",
         include: Union[IncEx, None] = None,
         exclude: Union[IncEx, None] = None,
-        context: Union[Any, None] = None,
+        context: Union[Any, None] = None,  # v2.7
         by_alias: Union[bool, None] = None,
         exclude_unset: bool = False,
         exclude_defaults: bool = False,
         exclude_none: bool = False,
+        exclude_computed_fields: bool = False,  # v2.12
         round_trip: bool = False,
         warnings: Union[bool, Literal["none", "warn", "error"]] = True,
-        fallback: Union[Callable[[Any], Any], None] = None,
-        serialize_as_any: bool = False,
+        fallback: Union[Callable[[Any], Any], None] = None,  # v2.11
+        serialize_as_any: bool = False,  # v2.7
     ) -> Dict[str, Any]:
         if PYDANTIC_MINOR_VERSION < (2, 11):
             by_alias = by_alias or False
+        extra_kwargs: Dict[str, Any] = {}
         if PYDANTIC_MINOR_VERSION >= (2, 7):
-            extra_kwargs: Dict[str, Any] = {
-                "context": context,
-                "serialize_as_any": serialize_as_any,
-            }
+            extra_kwargs["context"] = context
+            extra_kwargs["serialize_as_any"] = serialize_as_any
         if PYDANTIC_MINOR_VERSION >= (2, 11):
             extra_kwargs["fallback"] = fallback
-        else:
-            extra_kwargs = {}
+        if PYDANTIC_MINOR_VERSION >= (2, 12):
+            extra_kwargs["exclude_computed_fields"] = exclude_computed_fields
         if IS_PYDANTIC_V2:
             return super().model_dump(
                 mode=mode,

tests/test_select_typing.py

@@ -0,0 +1,64 @@
+from typing import Optional
+
+from sqlmodel import Field, Session, SQLModel, create_engine, select
+from sqlmodel.pool import StaticPool
+
+
+def test_fields() -> None:
+    class Hero(SQLModel, table=True):
+        id: Optional[int] = Field(default=None, primary_key=True)
+        name: str
+        secret_name: str
+        age: Optional[int] = None
+        food: Optional[str] = None
+
+    engine = create_engine(
+        "sqlite://", connect_args={"check_same_thread": False}, poolclass=StaticPool
+    )
+
+    SQLModel.metadata.create_all(engine)
+
+    with Session(engine) as session:
+        session.add(Hero(name="Deadpond", secret_name="Dive Wilson"))
+        session.add(
+            Hero(name="Spider-Boy", secret_name="Pedro Parqueador", food="pizza")
+        )
+        session.add(Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48))
+
+        session.commit()
+
+    # check typing of select with 3 fields
+    with Session(engine) as session:
+        statement_3 = select(Hero.id, Hero.name, Hero.secret_name)
+        results_3 = session.exec(statement_3)
+        for hero_3 in results_3:
+            assert len(hero_3) == 3
+            name_3: str = hero_3[1]
+            assert type(name_3) is str
+            assert type(hero_3[0]) is int
+            assert type(hero_3[2]) is str
+
+    # check typing of select with 4 fields
+    with Session(engine) as session:
+        statement_4 = select(Hero.id, Hero.name, Hero.secret_name, Hero.age)
+        results_4 = session.exec(statement_4)
+        for hero_4 in results_4:
+            assert len(hero_4) == 4
+            name_4: str = hero_4[1]
+            assert type(name_4) is str
+            assert type(hero_4[0]) is int
+            assert type(hero_4[2]) is str
+            assert type(hero_4[3]) in [int, type(None)]
+
+    # check typing of select with 5 fields: currently runs but doesn't pass mypy
+    # with Session(engine) as session:
+    #     statement_5 = select(Hero.id, Hero.name, Hero.secret_name, Hero.age, Hero.food)
+    #     results_5 = session.exec(statement_5)
+    #     for hero_5 in results_5:
+    #         assert len(hero_5) == 5
+    #         name_5: str = hero_5[1]
+    #         assert type(name_5) is str
+    #         assert type(hero_5[0]) is int
+    #         assert type(hero_5[2]) is str
+    #         assert type(hero_5[3]) in [int, type(None)]
+    #         assert type(hero_5[4]) in [str, type(None)]