Field alias broken since SQLModel 0.0.14

[DurandA]

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 typing import Optional

from pydantic import Field as PydanticField, BaseModel
from sqlmodel import Field, SQLModel


class PydanticHero(BaseModel):
    name: str
    secret_name: str = PydanticField(alias="secretName")


class SQLModelHero(SQLModel):
    name: str
    secret_name: str = Field(alias="secretName")


pydantic_hero = PydanticHero(name="Pydantic Company", secretName="Samuel Colvin")
sqlmodel_hero = SQLModelHero(name="Tiangolo", secretName="Sebastian Ramirez")

Description

• Create a Model with a Field that contain an alias
• Using the alias to create the model throws a ValidationError
• This is inconsistent with Pydantic behavior and previous version of SQLModel (< 0.0.14)

Operating System

Linux

Operating System Details

No response

SQLModel Version

0.0.14

Python Version

Python 3.12.0

Additional Context

This issue appeared on SQLModel 0.0.14.

[feliche93]

@DurandA I was facing the same issue thanks for creating this!

[cycledriver]

Looks like the pydantic SchemaValidator.validate_python (https://docs.pydantic.dev/latest/api/pydantic_core/#pydantic_core._pydantic_core.SchemaValidator.validate_python) doesn't handle aliases. That is what is used to set the fields of an object here:

https://github.com/tiangolo/sqlmodel/blob/0c7def88b5d9652bf9288738e2e9276d9dd24b5f/sqlmodel/_compat.py#L302

[DurandA]

related: #774

[Oliversinn]

I can't make .model_dump(by_alias=True) work. It always uses the attribute name.

[samshipengs]

@Oliversinn did you end up making it work?

[Oliversinn]

Not really. I ended up doing a mapping function 💔

[marutron]

Reproduced on SQLModel 0.0.16.
The solution proposed in #774 does not work.

upd: works by using #290

[perminovs]

Did anyone find a workaround? The one mentioned in #290 seems to be working only for table-models.

[benjamingorman]

Also facing this issue

[JonasHablitzel]

for me this workaround works for pydanticv 2.6 sqlmodel 0.0.14 its similar to what #774 does

from sqlmodel import SQLModel, Field

class Test:
    def __init__(self, test):
        self.Test = test


class Item(SQLModel):
    test: str = Field(schema_extra={"validation_alias": "Test"})


t1= Test("1")


Item.model_validate(t1)
Item.model_validate({"Test": "1"})

[KunxiSun]

It works! Thanks

sqlmodel v0.0.18

[daffodilistic]

This also worked for me to rename a field to a custom name during serialization:

class AcmeCorpAsset(SQLModel):
    AssetId: str
    # Rename the field to AssignedUser as the asset can be transferred to a sister company
    AssignedUser: Optional['ExpensiveErpUser'] = Field(default=None, schema_extra={"validation_alias": "AcmeCorpUser"})

[DataOps7]

I'm facing this issue as well and the above solution doesn't help with dumping

[YuriiMotov]

Thanks for reporting!

Created issue to track this: #1536