Skip to content

Pyright cannot recognize the type of SQLModel.__tablename__ #98

Closed
Closed
Pyright cannot recognize the type of SQLModel.__tablename__#98
Labels
questionFurther information is requested

Description

@Ma233
Ma233
opened on Sep 14, 2021

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

from sqlmodel import SQLModel

reveal_type(SQLModel.__tablename__)

# mypy(0.910) output: Revealed type is "Union[builtins.str, def (*Any, **Any) -> builtins.str]"
# pyright(1.1.166) output: Type of "SQLModel.__tablename__" is "declared_attr"


class User(SQLModel, table=True):  # pyright error: Instance variable "__name__" overrides class variable of same name in class "SQLModel"
    __tablename__ = "users"  # pyright error: Expression of type "Literal['users']" cannot be assigned to declared type "declared_attr"
    name: str

Description

This will cause a type error when you declare __tablename__ with pyright as type checker. Like:

Expression of type "Literal['users']" cannot be assigned to declared type "declared_attr"

Operating System

Linux, macOS

Operating System Details

No response

SQLModel Version

0.0.4

Python Version

3.8.6

Additional Context

No response

Activity

  1. Ma233
    added
    questionFurther information is requested
    on Sep 14, 2021

  2. Chedi commented on Sep 30, 2021

    @Chedi
    Chedi
    on Sep 30, 2021

    this is my workaround to silence that type of errors (not my proudest hack but it work)

    from sqlmodel import SQLModel
from sqlalchemy.orm import declared_attr

class User(SQLModel, table=True): 
    name: str

    @declared_attr
    def __tablename__(cls):  # noqa: N805
        return 'users'

    inspired by the declared_attr documentation, tested with pyright 1.1.172 (Linux), python 3.9.7, sqlmodel 0.0.4

  3. Ma233 commented on Oct 7, 2021

    @Ma233
    Ma233
    on Oct 7, 2021
    Author

    @Chedi Hi, of my own workaround is adding a # type: ignore after __tablename__ = "users".

  4. mudassirkhan19 commented on Oct 28, 2021

    @mudassirkhan19
    mudassirkhan19
    on Oct 28, 2021

    With @Chedi 's workaround, I still get an error on Mypy: error: Signature of "__tablename__" incompatible with supertype "SQLModel".
    Only # type: ignore works.

  5. indivisible commented on Dec 17, 2021

    @indivisible
    indivisible
    on Dec 17, 2021

    another really easy workaround is just specifying the type: __tablename__: str = 'poop'

  6. cassieopea commented on Jun 4, 2022

    @cassieopea
    cassieopea
    on Jun 4, 2022

    another really easy workaround is just specifying the type: __tablename__: str = 'poop'

    Note that Pyright complains at this:

    "__tablename__" incorrectly overrides property of same name in class "SQLModel" Pylance(reportIncompatibleMethodOverride)

    To satisfy the type checker you need to use the declared_attr approach, eg:

    class Lineitem(SQLModel, table=True):
    @declared_attr
    def __tablename__(cls):
        return "invoice_lineitems"

    This could be mentioned in the docs, and maybe in a future version a more intuitive approach could be used, such as putting it in a Meta as ormar does:

    class Lineitem(SQLModel, table=True):
    class Meta:
        tablename: str = "invoice_lineitems"

    I thought about making a request for this but I'm guessing there's already a lot on the roadmap.

  7. cassieopea commented on Jun 21, 2022

    @cassieopea
    cassieopea
    on Jun 21, 2022

    Since I posted #98 (comment), I've started simply doing

        __tablename__: str = "invoices_legacy"  #  type: ignore

    I think this is by far the best solution for people still getting the "incorrect override" error for the line without type: ignore. As I said when I mentioned this in #159,

    I choose this last method because the others are far too verbose for something as simple as declaring the table name. This may seem hacky, but although I have to tell Pyright to ignore a number of things in sqlmodel, it's not half the file like I have to type: ignore with sqlalchemy.

  8. anton-fomin commented on Feb 8, 2025

    @anton-fomin
    anton-fomin
    on Feb 8, 2025

    It seems

        __tablename__: ClassVar[str] = "users"

    Solves this for both pyright and mypy

    Updated
    Works only with basic type checking mode. Does not work in standard

  9. chriscarrollsmith commented on May 3, 2025

    @chriscarrollsmith
    chriscarrollsmith
    on May 3, 2025

    I tried all the fixes in this thread, and I'm sorry to report that you'll need # type: ignore to fix this with Pylance in "standard" type checking mode, because none of the other suggestions work.

  10. madduck commented on Jun 30, 2025

    @madduck
    madduck
    on Jun 30, 2025

    I use

    __tablename__ = typing.cast(declared_attr, "Users")

    and be done with it.

  11. youhogeon-meritz commented on Sep 3, 2025

    @youhogeon-meritz
    youhogeon-meritz
    on Sep 3, 2025

    It works on pyright strict mode . But not graceful.

    __tablename__: ClassVar[Any] = "my_table"

  12. madduck commented on Sep 3, 2025

    @madduck
    madduck
    on Sep 3, 2025
    __tablename__: ClassVar[Any] = "my_table"

    I can confirm this works for pyright and mypy.

  13. drzero42
    added a commit that references this issue on Dec 3, 2025

    Fix Pyrefly __tablename__ override errors in SQLModel classes

    aaac1a1

  14. marcoshevaristo commented on Dec 28, 2025

    @marcoshevaristo
    marcoshevaristo
    on Dec 28, 2025

    Since I posted #98 (comment), I've started simply doing

    __tablename__: str = "invoices_legacy"  #  type: ignore

    I think this is by far the best solution for people still getting the "incorrect override" error for the line without type: ignore. As I said when I mentioned this in #159,

    I choose this last method because the others are far too verbose for something as simple as declaring the table name. This may seem hacky, but although I have to tell Pyright to ignore a number of things in sqlmodel, it's not half the file like I have to type: ignore with sqlalchemy.

    I can confirm this works.

  15. aviadr1
    added 2 commits that reference this issue on Jan 11, 2026

    Replace type ignores with casts and proper typing

    91d2086

    Ship PlugPack MVP with immediate value (#9)

    3f162c8
  16. estarfoo
    added 4 commits that reference this issue on Mar 18, 2026

    🐛 Move `__tablename__` default from `@declared_attr` to metaclass

    f738f67

    🐛 Move `__tablename__` default from `@declared_attr` to metaclass

    6b0eadd

    🐛 Move `__tablename__` default from `@declared_attr` to metaclass

    98c37a4

    🐛 Move `__tablename__` default from `@declared_attr` to metaclass

    24d66f7
  17. fastapi
    locked and limited conversation to collaborators on May 18, 2026
  18. tiangolo
    converted this issue into a discussion #1932 on May 18, 2026
  19. estarfoo
    added a commit that references this issue on Jun 10, 2026

    🐛 Declare `__tablename__` on `SQLModelMetaclass`

    415c8fc
  20. estarfoo
    added a commit that references this issue on Sep 21, 2026

    🐛 Declare `__tablename__` on `SQLModelMetaclass`

    ac37dba
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    questionFurther information is requested

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions