Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🐛 Fix type annotation in Field constructor #1304

Merged
merged 3 commits into from
Feb 28, 2025
Merged

Conversation

AlanBogarin
Copy link
Contributor

Type checker throw partially unknown error when used in strict mode (Pylance)
When I locally edited that line, everything was correct

the Column type needs a type argument, assign it Any to accept all instances of the object

origin: sqlmodel.main.Field
info: Column expected an argument

339 |    sa_column: Union[Column, UndefinedType] = Undefined,  # type: ignore

proposed change

339 |    sa_column: Union[Column[Any], UndefinedType] = Undefined,

If you want to see it yourself (be sure to set the type checker to strict)

import sqlmodel

class TestModel(sqlmodel.SQLModel, table=True):
    value: list[int] = sqlmodel.Field(sa_column=sqlmodel.Column(sqlmodel.JSON))

There is a better change, but it is not possible because Column was defined in sqlalchemy

# sqlalchemy.sql.schema
113 |    _T = TypeVar("_T", bound="Any", default="Any")  # python >= 3.13

The `Column` annotation of `sa column` was missing an type argument
@svlandeg svlandeg added the bug Something isn't working label Feb 24, 2025
@svlandeg svlandeg changed the title Fix sqlmodel.Field partially unknown 🐛 Fix type annotation in Field constructor Feb 24, 2025
Copy link
Member

@svlandeg svlandeg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the contribution @AlanBogarin!

This looks good to me, but I'll leave the final review & decision up to Tiangolo.

Copy link
Member

@tiangolo tiangolo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense, thank you! ☕

@tiangolo tiangolo merged commit 7a51870 into fastapi:main Feb 28, 2025
26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants