Repository navigation
Loading an object from the database (vs init) produces different field types - it shouldn't #110
Description
First Check
- I added a very descriptive title to this issue.
- I used the GitHub search to find a similar issue 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
import sqlmodel as sqlm
class BarType(str):
@property
def with_prefix(self):
return f"PREFIX! {self}"
class Foo(SQLModel, table=True):
id: str = sqlm.Field(primary_key=True)
bar: BarType
# Works
foo = Foo(id="some-id", bar="test")
assert isinstance(foo.bar, BarType)
# Though this fails:
foo = load_foo_from_db()
assert isinstance(foo.bar, BarType) # FAILS!Description
The types are currently lying when loading from db. :)
Wanted Solution
They should work.
Wanted Code
Some thing as above, but works.Alternatives
No response
Operating System
Linux
Operating System Details
No response
SQLModel Version
0.0.4
Python Version
3.9
Additional Context
No response
Activity
[-]When loading an object from the database, the fields should be loaded according to their type[/-][+]Loading an object from the database (vs init) produces different field types - it shouldn't[/+]jack-michaud commentedon Oct 7, 2021
What is the type of
foo.barwhen you load it from the database?tasn commentedon Oct 7, 2021
strYou can check out https://github.com/tiangolo/sqlmodel/blob/main/sqlmodel/main.py#L372 to see exactly what's going on.
To workaround this issue, I have a fork (which is what we use) that lets you customize the type in a few ways, this is one of them: https://github.com/tasn/sqlmodel/blob/fixes/sqlmodel/main.py#L378
Essentially what I do is create a custom string loader sqlalchemy type that instantiates the value after loading from the db (have the same for other base types), and I just force its usage here.
jp-u commentedon Mar 10, 2024
This is still an issue on data returned from the database, seemingly for fields that use anything other than builtins.