dropbox / sqlalchemy-stubs

Mypy plugin and stubs for SQLAlchemy
Apache License 2.0
573 stars 101 forks source link

incompatible type "Column[int]"; expected "str" [list-item] #156

Open zedrdave opened 4 years ago

zedrdave commented 4 years ago

Hi,

First off, thanks a lot for your work on this plugin!

I am encountering a (somewhat logical) incompatible type error, and was wondering if this is something we should expect the plugin to address:

class MyTable(Model):
    id = db.Column(db.Integer, db.ForeignKey(User.id), nullable=False)
    b_id = Column(db.Integer, nullable=False)
    b_version = Column(db.Integer, nullable=False)

    __table_args__: tp.Union[tp.Dict, tp.Tuple] = (
        db.ForeignKeyConstraint([b_id, b_version], [B.id, B.version]), 
# List item 0 has incompatible type "Column[int]"; expected "str" [list-item]
# List item 1 has incompatible type "Column[int]"; expected "str" [list-item]
        {}
    )

Column implicitly converts to a string representing the column name, and I believe the above is the recommended way to use it. But, unsurprisingly, mypy does not like that. Could we either add Column to the signature of these functions in the stubs, or define a [str, Column] type alias?