extra param not support in SQLModel.model_validate(), but is supported in Pydantic

[cscanlin]

First Check

• I added a very descriptive title here.
• I used the GitHub search to find a similar question and didn't find it.
• I searched the SQLModel documentation, with the integrated search.
• I already searched in Google "How to X in SQLModel" and didn't find any information.
• I already read and followed all the tutorial in the docs and didn't find an answer.
• I already checked if it is not related to SQLModel but to Pydantic.
• I already checked if it is not related to SQLModel but to SQLAlchemy.

Commit to Help

• I commit to help with one of those options 👆

Example Code

from sqlmodel import Field, Session, SQLModel


class Hero(SQLModel, table=True):
    id: int | None = Field(default=None, primary_key=True)
    name: str
    secret_name: str
    age: int | None = None

data = {name: "Deadpond", secret_name: "Dive Wilson"}
hero = Hero.model_validate(data)  # OK

data = {name: "Deadpond", secret_name: "Dive Wilson", another_field: 'abc'}
hero = Hero.model_validate(data, extra='forbid')

# Gives: TypeError: SQLModel.model_validate() got an unexpected keyword argument 'extra'

Description

The parameter extra is supported in the pydantic model_validate():
https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel.model_validate

But that parameter is not supported in sqlmodel due to that method being overridden:
https://github.com/fastapi/sqlmodel/blob/main/sqlmodel/main.py#L873
https://github.com/fastapi/sqlmodel/blob/main/sqlmodel/_compat.py#L276

The validate_python() method already takes extra, so this should be a simple fix.

I can take a look at a PR if that would be helpful.

Operating System

macOS

Operating System Details

No response

SQLModel Version

0.0.37

Python Version

Python 3.11.14

Additional Context

No response

[RandhawaP2005]

I investigated this issue and implemented a solution locally. I added support for the extra parameter in the model_validate and the sqlmodel_validate function since the underlying ExtraBehaviour is already implemented in Core Schema. Also created a test to run a verification covering the issue.

Before opening a PR, just wanted to check whether this is the intended approach in this matter.

[Seongwonp]

Hey, just looked into this — the issue is straightforward.

SQLModel's model_validate in main.py and sqlmodel_validate in _compat.py both accept strict, from_attributes, context, and update, but extra got left out even though
Pydantic exposes it and pydantic-core's validate_python() already handles it under the hood. So yeah, this is just a missing passthrough.

@RandhawaP2005 your approach sounds right to me! You'd need to touch two spots:

sqlmodel/main.py — add extra to the signature and pass it down:
@classmethod
def model_validate(
cls: type[_TSQLModel],
obj: Any,
*,
strict: bool | None = None,
from_attributes: bool | None = None,
context: builtins.dict[str, Any] | None = None,
update: builtins.dict[str, Any] | None = None,
extra: Literal["allow", "ignore", "forbid"] | None = None,
) -> _TSQLModel:
return sqlmodel_validate(
cls=cls, obj=obj, strict=strict, from_attributes=from_attributes,
context=context, update=update, extra=extra,
)

And the same in _compat.py — add extra to sqlmodel_validate and pass it into the validate_python() call. Literal is already imported so no new deps needed.

Would love to see a PR on this, seems like a clean fix!