Skip to content

add model_dump options to sqlmodel_update #1897

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
A00474880 wants to merge 11 commits into
base: main
Choose a base branch
from
+52 −19
Open

add model_dump options to sqlmodel_update #1897

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
4885b99
add model_dump options to sqlmodel_update
A00474880 May 1, 2026
3d17d08
🎨 Auto format
pre-commit-ci-lite[bot] May 1, 2026
35ddc4c
Merge branch 'main' into improve_sqlmodel_update
A00474880 May 6, 2026
59d71de
type support for model_dump_kwargs
A00474880 May 7, 2026
ac676fb
creates temp UpdateModel to avoid issues with SQLModel's serializatio…
A00474880 May 7, 2026
d9ffaf1
updating test
A00474880 May 7, 2026
f399589
Merge remote-tracking branch 'origin/improve_sqlmodel_update' into im…
A00474880 May 7, 2026
66c8b88
🎨 Auto format
pre-commit-ci-lite[bot] May 7, 2026
8fe99e9
remove defaults from _ModelDumpKwargs TypedDict
A00474880 May 7, 2026
0295137
Merge remote-tracking branch 'origin/improve_sqlmodel_update' into im…
A00474880 May 7, 2026
51ad5c3
🎨 Auto format
pre-commit-ci-lite[bot] May 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
creates temp UpdateModel to avoid issues with SQLModel's serializatio… 
…n settings like `include` and `exclude`
  • Loading branch information
@A00474880
A00474880 committed May 7, 2026
commit ac676fbf62a8442631cffcab08754b06436a81ee
16 changes: 15 additions & 1 deletion sqlmodel/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
overload,
)

from pydantic import BaseModel, EmailStr
from pydantic import BaseModel, EmailStr, create_model
from pydantic.fields import FieldInfo as PydanticFieldInfo
from sqlalchemy import (
Boolean,
Expand Down Expand Up @@ -1007,6 +1007,20 @@ def sqlmodel_update(
f"is not a dict or SQLModel or Pydantic model: {obj}"
)
if isinstance(obj, BaseModel):
# Create a temp UpdateModel schema (removes extra serialization settings)
ObjClass = obj.__class__
fields_def = {
fname: finfo.annotation
for fname, finfo in ObjClass.model_fields.items()
}
UpdateModel = create_model(
f"_{ObjClass.__name__}Update_", **fields_def
)
# rebuild obj instance with model_construct
obj = UpdateModel.model_construct(
_fields_set=obj.model_fields_set, **obj.__dict__
)
# Now `obj.model_dump` works with **model_dump_kwargs
obj = obj.model_dump(**model_dump_kwargs)
Comment on lines +1011 to +1024
Copy link
Copy Markdown
Member

@YuriiMotov YuriiMotov May 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will break use cases with models that have fields with exclude=True:

from sqlmodel import Field, SQLModel


class Item(SQLModel):
    id: str
    param: str = Field(exclude=True)


a = Item.model_validate({"id": "1", "param": "1"})
b = Item.model_validate({"id": "1", "param": "2"})


a.sqlmodel_update(b, exclude={"id"})
# a.sqlmodel_update(b)


assert a.param == "2"

.. and probably some other cases when model has settings that change the default serialization schema.

use_update = (update or {}).copy()
for key, value in {**obj, **use_update}.items():
Expand Down