How can I get a specific column name from SQLModel?

[akaymd]

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

import polars as pl
from sqlmodel import Field, Session, SQLModel, create_engine, select


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


engine = create_engine("sqlite:///:memory:", echo=True)


def create_db_and_tables():
    SQLModel.metadata.create_all(engine)


def create_heroes():
    hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson")
    hero_2 = Hero(name="Spider-Boy", secret_name="Pedro Parqueador")
    hero_3 = Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48)

    with Session(engine) as session:
        session.add(hero_1)
        session.add(hero_2)
        session.add(hero_3)

        session.commit()


def select_heroes():
    with Session(engine) as session:
        statement = select(Hero)
        results = session.exec(statement)
        df = pl.DataFrame(results.all())
        print(df["id"])
        print(df[Hero.id.key])

        print(df["age"])
        print(df[Hero.age.key])


def main():
    create_db_and_tables()
    create_heroes()
    select_heroes()


if __name__ == "__main__":
    main()

Description

In SQLAlchemy, I was able to get the string representation of the column name by using .key. (Documentation)
.key can also be used in SQLModel, but it does not behave correctly in VSCode (and probably other IDEs as well).

Each member of SQLModel behaves as if it were the type stored in that column.
For example, an int column naturally does not have a .key .
Therefore, using .key results in it being displayed as Any.
In SQLAlchemy, .key was displayed as str.

Whether or not to use Field() also affects how it behaves in VSCode.
In this case, a Pylint error stating “Instance of ‘FieldInfo’ has no ‘key’ member” also appears.

The string representation of column names is necessary when using DataFrames, etc.
When referencing the age column of a DataFrame, I want to use like Hero.age.key instead of “age” . This is because IDE support is available when refactoring column names.

How can I get a specific column name from SQLModel?

Operating System

Linux

Operating System Details

No response

SQLModel Version

0.0.24

Python Version

Python 3.13.3

Additional Context

No response