str typed attribute doesn't get value of Enum field #105

Activity

1. Stamper

   added

   questionFurther information is requestedFurther information is requested

   on Sep 20, 2021
2. fletcheaston commented on Sep 24, 2021

   

   fletcheaston

   on Sep 24, 2021

   More actions

   If you use this (below), does it work?

   class FileState(str, enum.Enum):
       new = "New"
       validated = "Validated"
   
   
   class File(SQLModel, table=True):
       name: str = Field(index=True)
       state: FileState = Field(
           sa_column=Column(
               Enum(FileState),
               default=None,
               nullable=True,
               index=True
           )
       )
   

   FileState inherits from the string class, so you do comparisons like assert result.state == "New" without throwing an exception (although that doesn't help with enum validation in your IDE). Validation in your IDE, mypy, etc. comes from setting the state type hint to FileState.
3. tiangolo commented on Aug 30, 2022

   

   tiangolo

   on Aug 30, 2022

   Member

   More actions

   Hey there! This might have been solved in #165, available since SQLModel 0.0.7.

   I tried running your example code but it seems it's missing imports and variables so I can't run it. If you're still having issues, please create a self-contained example that I can run to see your exact problem. 🤓
4. tiangolo

   added

   answered

   on Aug 30, 2022
5. github-actions commented on Sep 10, 2022

   

   github-actionsbot

   on Sep 10, 2022

   Contributor

   More actions

   Assuming the original need was handled, this will be automatically closed now. But feel free to add more comments or create new issues or PRs.
6. github-actions

   closed this as completedon Sep 10, 2022
7. gitpushdashf commented on Apr 28, 2023

   

   gitpushdashf

   on Apr 28, 2023

   More actions

   I'm running into this as well. I made an example for this.

   from enum import StrEnum, auto
   from typing import Annotated
   
   from sqlmodel import Session, SQLModel, Field, create_engine
   
   
   # str, Enum is also affected.
   # Enum seems to work fine, however there's many reasons to use str, Enum or StrEnum.
   class AnEnum(StrEnum):
       FIRST = auto()
       SECOND = auto()
   
   
   class Thing(SQLModel, table=True):
       id: Annotated[int, Field(primary_key=True)]
       an_enum: AnEnum
   
   
   def test() -> None:
       a_thing = Thing(id=1, an_enum=AnEnum.FIRST)
       assert a_thing.an_enum == AnEnum.FIRST
       assert isinstance(a_thing.an_enum, AnEnum)
   
       # Postgres also appears to be affected.
       engine = create_engine("sqlite://")
       SQLModel.metadata.create_all(engine)
       with Session(engine) as session:
           assert a_thing.an_enum == AnEnum.FIRST
           assert isinstance(a_thing.an_enum, AnEnum)
           session.add(a_thing)
           session.commit()
           assert a_thing.an_enum == AnEnum.FIRST
   
           # Right after commit, the type changes from AnEnum to str
           assert isinstance(a_thing.an_enum, AnEnum)
   
           same_thing_from_db = session.get(Thing, 1)
           assert same_thing_from_db is not None
           assert same_thing_from_db.an_enum == AnEnum.FIRST
           assert isinstance(same_thing_from_db.an_enum, AnEnum)
   
       print("Success!")
   
   
   if __name__ == "__main__":
       test()