Mypy conflicts with sqlmodel

[hootpy]

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

@router.get("/", response_model=list[User])
async def get_users(skip: int = 0, limit: int = 100, db: AsyncSession = Depends(get_session)) -> list[User]: # <== error here
    return await UserCrud.get_users(db, skip, limit)


# Fixed for mypy but show error in pycharm
@router.get("/", response_model=list[User])
async def get_users(skip: int = 0, limit: int = 100, db: AsyncSession = Depends(get_session)) -> User:
    return await UserCrud.get_users(db, skip, limit)

# get_users function
@classmethod
    async def get_users(cls, db: AsyncSession, skip: int = 0, limit: int = 100) -> list[User]:
        query = await db.execute(select(User).offset(skip).limit(limit))
        return query.scalars().all()

Description

• Using with Fastapi, create a crud module
• When using in router, mypy says error: Return Any from function declared to return List[Any]
• Fixed by change return type to User but the Pycharm says error type as it not should be like this

Operating System

macOS

Operating System Details

No response

SQLModel Version

0.0.8

Python Version

3.11.3

Additional Context

No response

[hootpy]

original code:

reference code:

mypy message:

fixed for mypy:

[h-wei]

You can try this:

@classmethod
async def get_users(cls, db: AsyncSession, skip: int = 0, limit: int = 100) -> list[User]:
    query = await db.execute(select(User).offset(skip).limit(limit))
    # add the return variable with type hint
    result: list[User] = query.scalars().all()
    return result