Type of "Field" is partially unknown

[Thandden]

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 sqlmodel import Field

Pyright:

error: Type of "Field" is partially unknown
    Type of "Field" is "Overload[(default: Any = Undefined, *, default_factory: (() -> Any)

Description

Hello,

I've encountered an issue with Pyright where it reports the type of Field from SQLModel as partially unknown upon import. I wanted to raise this to see if there might be a known solution or workaround.

Environment Details:

Python Version: 3.12.1
SQLModel Version: 0.0.14
Pyright Version: 1.1.350

Thanks.

Operating System

Linux

Operating System Details

Ubuntu Desktop

SQLModel Version

0.0.14

Python Version

3.12.1

Additional Context

No response

[Gnosnay]

I also met this problem. anyone know how to resolve it? thx!

[aistellar]

related issue: #822

[palfrey]

The problem is the sa_column args. They're defined as sa_column: Union[Column, UndefinedType] = Undefined and that Column wants a type arg. If Column was changed to Column[Any], pyright stops complaining.

[categoric-dev]

Thank you! Your suggestion suppressed the error in IDE,

The question now is whether this should be resolved by Pyright/Pylance or SQLModel.

[palfrey]

Fairly sure this is a SQLmodel problem

[YuriiMotov]

Fixed:

sqlmodel/sqlmodel/main.py

Line 342 in c5085b6

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

[Cikmo]

I still have this annoying issue, and it doesn't seem to just be sa_column. There's 16 fields that pyright identifies as partially unkown. I don't know if this is some regression with an updated pyright or what.

Here's the full pyright report:

Type of "Field" is partially unknown
  Type of "Field" is "Overload[(default: Any = Undefined, *, default_factory: (() -> Any) | None = None, alias: str | None = None, title: str | None = None, description: str | None = None, exclude: AbstractSet[int | str] | Mapping[int | str, Any] | Any = None, include: AbstractSet[int | str] | Mapping[int | str, Any] | Any = None, const: bool | None = None, gt: float | None = None, ge: float | None = None, lt: float | None = None, le: float | None = None, multiple_of: float | None = None, max_digits: int | None = None, decimal_places: int | None = None, min_items: int | None = None, max_items: int | None = None, unique_items: bool | None = None, min_length: int | None = None, max_length: int | None = None, allow_mutation: bool = True, regex: str | None = None, discriminator: str | None = None, repr: bool = True, primary_key: bool | Unknown | PydanticUndefinedType = Undefined, foreign_key: Any = Undefined, unique: bool | Unknown | PydanticUndefinedType = Undefined, nullable: bool | Unknown | PydanticUndefinedType = Undefined, index: bool | Unknown | PydanticUndefinedType = Undefined, sa_type: Type[Any] | Unknown | PydanticUndefinedType = Undefined, sa_column_args: Sequence[Any] | Unknown | PydanticUndefinedType = Undefined, sa_column_kwargs: Mapping[str, Any] | Unknown | PydanticUndefinedType = Undefined, schema_extra: Dict[str, Any] | None = None) -> Any, (default: Any = Undefined, *, default_factory: (() -> Any) | None = None, alias: str | None = None, title: str | None = None, description: str | None = None, exclude: AbstractSet[int | str] | Mapping[int | str, Any] | Any = None, include: AbstractSet[int | str] | Mapping[int | str, Any] | Any = None, const: bool | None = None, gt: float | None = None, ge: float | None = None, lt: float | None = None, le: float | None = None, multiple_of: float | None = None, max_digits: int | None = None, decimal_places: int | None = None, min_items: int | None = None, max_items: int | None = None, unique_items: bool | None = None, min_length: int | None = None, max_length: int | None = None, allow_mutation: bool = True, regex: str | None = None, discriminator: str | None = None, repr: bool = True, primary_key: bool | Unknown | PydanticUndefinedType = Undefined, foreign_key: str, ondelete: Unknown | PydanticUndefinedType | Literal['CASCADE', 'SET NULL', 'RESTRICT'] = Undefined, unique: bool | Unknown | PydanticUndefinedType = Undefined, nullable: bool | Unknown | PydanticUndefinedType = Undefined, index: bool | Unknown | PydanticUndefinedType = Undefined, sa_type: Type[Any] | Unknown | PydanticUndefinedType = Undefined, sa_column_args: Sequence[Any] | Unknown | PydanticUndefinedType = Undefined, sa_column_kwargs: Mapping[str, Any] | Unknown | PydanticUndefinedType = Undefined, schema_extra: Dict[str, Any] | None = None) -> Any, (default: Any = Undefined, *, default_factory: (() -> Any) | None = None, alias: str | None = None, title: str | None = None, description: str | None = None, exclude: AbstractSet[int | str] | Mapping[int | str, Any] | Any = None, include: AbstractSet[int | str] | Mapping[int | str, Any] | Any = None, const: bool | None = None, gt: float | None = None, ge: float | None = None, lt: float | None = None, le: float | None = None, multiple_of: float | None = None, max_digits: int | None = None, decimal_places: int | None = None, min_items: int | None = None, max_items: int | None = None, unique_items: bool | None = None, min_length: int | None = None, max_length: int | None = None, allow_mutation: bool = True, regex: str | None = None, discriminator: str | None = None, repr: bool = True, sa_column: Column[Any] | Unknown | PydanticUndefinedType = Undefined, schema_extra: Dict[str, Any] | None = None) -> Any]"

[YuriiMotov]

This is a new issue, already reported here: #1598