How to resolve mypy error with sqlalchemy enum?

Question

mypy reports an error in the following code:

import enum
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy import Column, Enum

Base = declarative_base()

class MyEnum(enum.Enum):
    A = 1
    B = 2

class MyTable(Base):
    __tablename__ = 'my_table'

    col = Column(Enum(MyEnum), nullable=False)

c = MyTable(col=MyEnum.A)

Following is the error:

a.py:16: error: Incompatible type for "col" of "MyTable" (got "MyEnum", expected "str")

How do I make this error go away without adding a "type: ignore" ? I could also replace MyEnum.A with MyEnum.A.name to make the error go away. But this doesn't look clean and is also not suggested in sqlalchemy documentation.

I can't reproduce your error on my setup. When using your example in a fresh virtualenv, I get this error: error: Variable "Base" is not valid as a type. Did you bypass this error somehow? Could you explicit the versions of Python, mypy, sqlalchemy and sqlalchemy-stubs you're using? — sduthil
– sduthil, Commented Aug 8, 2021 at 23:57

Konstantin · Accepted Answer · 2021-08-14 14:50:56Z

6

I don't know what exactly makes this error go away but on my setup after some refactoring and mypy configuring this error disappeared.

I installed sqlalchemy-stubs

pip install sqlalchemy-stubs

and created setup.cfg file:

[mypy]
files = **/*.py
plugins =
  sqlalchemy.ext.mypy.plugin

import enum

from sqlalchemy import Column, Enum
from sqlalchemy.ext.declarative import declarative_base

Base = declarative_base()


class MyEnum(enum.Enum):
    """My enum."""

    ONE = 1
    TWO = 2


class MyTable(Base):
    """My table."""

    __tablename__ = 'my_table'

    col = Column(Enum(MyEnum), nullable=False)


table = MyTable(col=MyEnum.ONE)

answered Aug 14, 2021 at 14:50

Konstantin

5783 silver badges18 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Maxim Ivanov Over a year ago

Thank you! One minor thing though, is that currently the setup is a bit different (plugin name is now sqlmypy). See github.com/dropbox/sqlalchemy-stubs

Talha Junaid Over a year ago

It worked for me without specifying the plugin

toonarmycaptain · Accepted Answer · 2023-04-18 21:33:01Z

4

You have to introduce them yourself in your script. The dynamically created Base class is of type DeclarativeMeta. If you type annotate the variable Base, mypy does not show the error any more.

from sqlalchemy.orm.decl_api import DeclarativeMeta
Base: DeclarativeMeta = declarative_base()

Now the Base variable is properly type annotated. I think that the DeclarativeMeta class is not to be exposed in the API, so I'm not sure how sustainable this solution will be.

edited Apr 18, 2023 at 21:33

toonarmycaptain

2,3312 gold badges21 silver badges30 bronze badges

answered Aug 9, 2021 at 20:28

marscher

8501 gold badge7 silver badges24 bronze badges

1 Comment

shuttle87 Over a year ago

sqlalchemy has first-party mypy support as an optional install via pip install sqlalchemy[mypy] since version 1.4

toonarmycaptain · Accepted Answer · 2023-04-18 13:20:09Z

3

You have to import the base class:

SQLAlchemy <v2:

from sqlalchemy.orm.decl_api import DeclarativeMeta
Base: DeclarativeMeta = declarative_base()

see https://docs.sqlalchemy.org/en/13/orm/extensions/declarative/basic_use.html

Or SQLAlchemy v2+:

from sqlalchemy.orm import DeclarativeBase

class Base(DeclarativeBase):
    pass

See: https://docs.sqlalchemy.org/en/20/orm/mapping_styles.html#mapped-class-essential-components

NB the first method also works for v2, but the latter is probably preferable, and certainly easier to understand as it follows Python's normal inheritance system..

answered Apr 18, 2023 at 13:20

toonarmycaptain

2,3312 gold badges21 silver badges30 bronze badges

Collectives™ on Stack Overflow

How to resolve mypy error with sqlalchemy enum?

3 Answers 3

2 Comments

1 Comment

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

2 Comments

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Related