Alias and Type Hint Challenges in SQLModel and Pydantic Integration

[AlirezaHaghi]

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 SQLModel
from pydantic import Field

class Model(SQLModel):
    id_: int = Field(alias='id')
    
model = Model(id = 23) # pylance: No parameter named "id"

print(model)

Description

it works correctly but there is some issue with typing in sqlmodel.
I googled on how to use PYDANTIC ALIAS NOT SQLALCHEMY ALIAS in sqlmodel and found nothing helpful.

Operating System

Windows

Operating System Details

No response

SQLModel Version

0.0.18

Python Version

3.12.3

Additional Context

No response

[import-antigravity]

you would want to use sqlmodel.Field, not pydantic.Field, right?

[YuriiMotov]

Using sqlmodel.Field fixes type hints, but gives ValidationError in run time

[ixycoexzckwpmlcu]

Maybe related: https://docs.pydantic.dev/latest/concepts/fields/#field-aliases (under "VSCode and Pyright users") and pydantic/pydantic#5893

[YuriiMotov]

There is already open issue to track this: #203

The workaround is to add schema_extra={"validation_alias": "id"}:

from sqlmodel import SQLModel, Field

class Model(SQLModel):
    id_: int = Field(alias='id', schema_extra={"validation_alias": "id"})

model = Model(id = 23)

print(model)