`Unexpected argument(s)` warning in PyCharm when using `select()` with many parameters #92

avi-perl · 2021-09-12T22:25:40Z

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 typing import Optional
from datetime import datetime

from sqlmodel import Field, SQLModel, select, func, create_engine, Session


class Item(SQLModel, table=True):
    id: Optional[int] = Field(default=None, primary_key=True)
    created: datetime
    deleted: bool = False
    category: str
    version: float = 1
    data: str


# Create and save records to show that the query itself is working.
item_1 = Item(created=datetime.now(), category="category_1", data="❤️ I love SQLModel.")
item_2 = Item(created=datetime.now(), category="category_1", data="❤️ I love FastAPI.", deleted=True)
item_3 = Item(created=datetime.now(), category="category_2", data="🥰 I appreciate your work on all of it!")

engine = create_engine("sqlite://")

SQLModel.metadata.create_all(engine)

with Session(engine) as session:
    session.add(item_1)
    session.add(item_2)
    session.add(item_3)
    session.commit()

    # This "statement" is where the issue presents itself in PyCharm
    statement = (
        select(
            Item.category,
            func.count(Item.id),
            func.total(Item.deleted).label("delete_count"),
            func.min(Item.created).label("oldest_timestamp"),
            func.max(Item.created).label("newest_timestamp"),
            func.group_concat(Item.version).label("version_list"),
        )
            .distinct()
            .group_by(Item.category)
    )
    category_metadata = session.exec(statement)
    for result in category_metadata:
        print(dict(result))

Description

Using the select() function to write out a query with > 4 params.
PyCharm displays the following warning.

Unexpected argument(s) Possible callees: select(entity_0: Type[_TModel_0], entity_1: Type[_TModel_1], entity_2: Type[_TModel_2], entity_3: Type[_TModel_3], **kw) select(entity_0: Type[_TModel_0], entity_1: Type[_TModel_1], entity_2: Type[_TModel_2], entity_3: _TScalar_3, **kw) select(entity_0: Type[_TModel_0], entity_1: Type[_TModel_1], entity_2: _TScalar_2, entity_3: Type[_TModel_3], **kw) select(entity_0: Type[_TModel_0], entity_1: Type[_TModel_1], entity_2: _TScalar_2, entity_3: _TScalar_3, **kw) select(entity_0: Type[_TModel_0], entity_1: _TScalar_1, entity_2: Type[_TModel_2], entity_3: Type[_TModel_3], **kw) select(entity_0: Type[_TModel_0], entity_1: _TScalar_1, entity_2: Type[_TModel_2], entity_3: _TScalar_3, **kw) select(entity_0: Type[_TModel_0], entity_1: _TScalar_1, entity_2: _TScalar_2, entity_3: Type[_TModel_3], **kw) select(entity_0: Type[_TModel_0], entity_1: _TScalar_1, entity_2: _TScalar_2, entity_3: _TScalar_3, **kw) select(entity_0: _TScalar_0, entity_1: Type[_TModel_1], entity_2: Type[_TModel_2], entity_3: Type[_TModel_3], **kw) select(entity_0: _TScalar_0, entity_1: Type[_TModel_1], entity_2: Type[_TModel_2], entity_3: _TScalar_3, **kw) select(entity_0: _TScalar_0, entity_1: Type[_TModel_1], entity_2: _TScalar_2, entity_3: Type[_TModel_3], **kw) select(entity_0: _TScalar_0, entity_1: Type[_TModel_1], entity_2: _TScalar_2, entity_3: _TScalar_3, **kw) select(entity_0: _TScalar_0, entity_1: _TScalar_1, entity_2: Type[_TModel_2], entity_3: Type[_TModel_3], **kw) select(entity_0: _TScalar_0, entity_1: _TScalar_1, entity_2: Type[_TModel_2], entity_3: _TScalar_3, **kw) select(entity_0: _TScalar_0, entity_1: _TScalar_1, entity_2: _TScalar_2, entity_3: Type[_TModel_3], **kw) select(entity_0: _TScalar_0, entity_1: _TScalar_1, entity_2: _TScalar_2, entity_3: _TScalar_3, **kw) select(entity_0: Type[_TModel_0], entity_1: Type[_TModel_1], entity_2: Type[_TModel_2], **kw) select(entity_0: Type[_TModel_0], entity_1: Type[_TModel_1], entity_2: _TScalar_2, **kw) select(entity_0: Type[_TModel_0], entity_1: _TScalar_1, entity_2: Type[_TModel_2], **kw) select(entity_0: Type[_TModel_0], entity_1: _TScalar_1, entity_2: _TScalar_2, **kw) select(entity_0: _TScalar_0, entity_1: Type[_TModel_1], entity_2: Type[_TModel_2], **kw) select(entity_0: _TScalar_0, entity_1: Type[_TModel_1], entity_2: _TScalar_2, **kw) select(entity_0: _TScalar_0, entity_1: _TScalar_1, entity_2: Type[_TModel_2], **kw) select(entity_0: _TScalar_0, entity_1: _TScalar_1, entity_2: _TScalar_2, **kw) select(entity_0: Type[_TModel_0], entity_1: Type[_TModel_1], **kw) select(entity_0: Type[_TModel_0], entity_1: _TScalar_1, **kw) select(entity_0: _TScalar_0, entity_1: Type[_TModel_1], **kw) select(entity_0: _TScalar_0, entity_1: _TScalar_1, **kw) select(entity_0: Type[_TModel_0], **kw) select(entity_0: _TScalar_0, **kw)

This does not impact the use of select(), the query works as expected.
This does not show when using <= 4 params.
This warning does not show in VSCode.

Operating System

Windows

Operating System Details

Windows = 10
PyCharm Version = 2021.2 (Community Edition)

SQLModel Version

0.0.4

Python Version

Python 3.9.7

Additional Context

The text was updated successfully, but these errors were encountered:

Cielquan · 2022-05-06T08:27:44Z

I have the same issue.

I have a table with 5 foreign keys. And when I want to do a full join like below I get a mypy error. So I assume the typing is the issue here. And PyCharm uses the types too I think.

from sqlmodel import select
...
stmt = (
    select(
        Ticket, TicketStage, ConspicuityType, User, ATFeedbackType, StatisticalEvaluationType
    )
    .join(TicketStage)
    .join(ConspicuityType)
    .join(User)
    .join(ATFeedbackType)
    .join(StatisticalEvaluationType)
)

And when I use reveal_type from typing_extensions I get this:

from typing_extensions import reveal_type
from sqlmodel import select
...
stmt = (
    select(
        Ticket, TicketStage, ConspicuityType, User, ATFeedbackType, StatisticalEvaluationType
    )
    .join(TicketStage)
    .join(ConspicuityType)
    .join(User)
    .join(ATFeedbackType)
    .join(StatisticalEvaluationType)
)
reveal_type(stmt)  # Type of "stmt" is "Any"

When I reduce the arguments to select I get:

from typing_extensions import reveal_type
from sqlmodel import select
...
stmt = (
    select(
        Ticket, TicketStage, ConspicuityType, User
    )
    .join(TicketStage)
    .join(ConspicuityType)
    .join(User)
    .join(ATFeedbackType)
    .join(StatisticalEvaluationType)
)
reveal_type(stmt)  # Type of "stmt" is "Select[Tuple[Ticket, TicketStage, ConspicuityType, User]]"

When I use select from sqlalchemy instead it works with all arguments and I get:

from typing_extensions import reveal_type
from sqlalchemy import select
...
stmt = (
    select(
        Ticket, TicketStage, ConspicuityType, User, ATFeedbackType, StatisticalEvaluationType
    )
    .join(TicketStage)
    .join(ConspicuityType)
    .join(User)
    .join(ATFeedbackType)
    .join(StatisticalEvaluationType)
)
reveal_type(stmt)  # Type of "stmt" is "Select"

Cielquan · 2022-05-06T08:35:57Z

Basically the issues lies here: https://github.com/tiangolo/sqlmodel/blob/main/sqlmodel/sql/expression.py#L140-L442

The overloads are hardcoded and end with 4 parameters. So I guess there are 3 Solutions:

Use sqlalchemy's select when using more then 4 parameters for select
Add more hardcoded overloads for more parameters, which I guess will grow the amount of overloads exponentially because of the different combinations of _TScalar_X and Type[_TModel_X] for each parameter.
Find a dynamic solution if there is any

kiddten · 2022-06-22T21:58:48Z

Same issue here

avi-perl added the question Further information is requested label Sep 12, 2021

avi-perl changed the title ~~"Unexpected argument(s)" warning in PyCharm when using select() with many parameters~~ Unexpected argument(s) warning in PyCharm when using select() with many parameters Sep 12, 2021

maxispeicher linked a pull request Mar 12, 2024 that will close this issue

Add Typing for select of arbitrary length #839

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`Unexpected argument(s)` warning in PyCharm when using `select()` with many parameters #92

`Unexpected argument(s)` warning in PyCharm when using `select()` with many parameters #92

avi-perl commented Sep 12, 2021 •

edited

Cielquan commented May 6, 2022

Cielquan commented May 6, 2022

kiddten commented Jun 22, 2022

Unexpected argument(s) warning in PyCharm when using select() with many parameters #92

Unexpected argument(s) warning in PyCharm when using select() with many parameters #92

Comments

avi-perl commented Sep 12, 2021 • edited

First Check

Commit to Help

Example Code

Description

Operating System

Operating System Details

SQLModel Version

Python Version

Additional Context

Cielquan commented May 6, 2022

Cielquan commented May 6, 2022

kiddten commented Jun 22, 2022

`Unexpected argument(s)` warning in PyCharm when using `select()` with many parameters #92

`Unexpected argument(s)` warning in PyCharm when using `select()` with many parameters #92

avi-perl commented Sep 12, 2021 •

edited