sqlmodel-mypy-plugin 0.19.0__tar.gz → 0.19.1__tar.gz

{sqlmodel_mypy_plugin-0.19.0 → sqlmodel_mypy_plugin-0.19.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sqlmodel-mypy-plugin
-Version: 0.19.0
+Version: 0.19.1
 Summary: Mypy plugin for SQLModel (better constructor/Field typing).
 Project-URL: Homepage, https://github.com/sertione/sqlmodel-mypy-plugin
 Project-URL: Repository, https://github.com/sertione/sqlmodel-mypy-plugin
@@ -52,8 +52,6 @@ Mypy plugin that improves type checking for [`SQLModel`](https://github.com/fast
 
 Early/experimental. Implemented scope (supported today):
 
-Planned work is tracked in [`ROADMAP.md`](ROADMAP.md).
-
 - Generate correct `__init__` / `model_construct` signatures for SQLModel models:
   - treat `sqlmodel.Field(...)` required/optional correctly
   - accept `sqlmodel.Relationship(...)` kwargs for `table=True` models

{sqlmodel_mypy_plugin-0.19.0 → sqlmodel_mypy_plugin-0.19.1}/README.md

@@ -6,8 +6,6 @@ Mypy plugin that improves type checking for [`SQLModel`](https://github.com/fast
 
 Early/experimental. Implemented scope (supported today):
 
-Planned work is tracked in [`ROADMAP.md`](ROADMAP.md).
-
 - Generate correct `__init__` / `model_construct` signatures for SQLModel models:
   - treat `sqlmodel.Field(...)` required/optional correctly
   - accept `sqlmodel.Relationship(...)` kwargs for `table=True` models

{sqlmodel_mypy_plugin-0.19.0 → sqlmodel_mypy_plugin-0.19.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "sqlmodel-mypy-plugin"
-version = "0.19.0"
+version = "0.19.1"
 description = "Mypy plugin for SQLModel (better constructor/Field typing)."
 readme = "README.md"
 requires-python = ">=3.10"

{sqlmodel_mypy_plugin-0.19.0 → sqlmodel_mypy_plugin-0.19.1}/src/sqlmodel_mypy/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.19.0"
+__version__ = "0.19.1"
 
 from .persisted import HasId, HasOptionalId, has_id, require_id
 

{sqlmodel_mypy_plugin-0.19.0 → sqlmodel_mypy_plugin-0.19.1}/src/sqlmodel_mypy/plugin.py

@@ -171,7 +171,7 @@ SQLALCHEMY_INSPECT_FULLNAMES = {
 }
 
 # Increment when plugin changes should invalidate mypy cache.
-__version__ = 25
+__version__ = 26
 
 
 class _CollectedField(NamedTuple):
@@ -1275,34 +1275,6 @@ class SQLModelMypyPlugin(Plugin):
                 return any(_contains_instance_fullname(item, fullname) for item in proper.items)
             return False
 
-        # Accept SQLAlchemy `Select[...]` in `Session.exec(...)`.
-        #
-        # SQLModel defines its own `Select[...]` wrapper class and types `Session.exec` to accept it,
-        # but users often import and use SQLAlchemy's `select()` directly. Runtime supports it, and
-        # with this adjustment we preserve a correctly-shaped `TupleResult[...]` return type.
-        sqlmodel_select_info = _lookup_typeinfo(self, SQLMODEL_SELECT_CLS_FULLNAME)
-        sqlalchemy_select_info = _lookup_typeinfo(self, SQLALCHEMY_SELECT_FULLNAME)
-        if sqlmodel_select_info is not None and sqlalchemy_select_info is not None:
-            if _contains_instance_fullname(default.arg_types[0], sqlmodel_select_info.fullname):
-                # Idempotency: if upstream stubs already accept SQLAlchemy Select, keep unchanged.
-                if not _contains_instance_fullname(
-                    default.arg_types[0], sqlalchemy_select_info.fullname
-                ):
-                    proper_arg0 = get_proper_type(default.arg_types[0])
-                    if isinstance(proper_arg0, Instance) and proper_arg0.args:
-                        row_type = proper_arg0.args[0]
-                    else:
-                        row_type = _plugin_any()
-                    sqlalchemy_select = Instance(
-                        sqlalchemy_select_info,
-                        [row_type] * len(sqlalchemy_select_info.defn.type_vars),
-                    )
-                    new_arg_types = list(default.arg_types)
-                    new_arg_types[0] = UnionType.make_union(
-                        [default.arg_types[0], sqlalchemy_select]
-                    )
-                    return default.copy_modified(arg_types=new_arg_types)
-
         # Only adjust the broad overload; keep Select/SelectOfScalar overloads precise.
         broad = False
         if sqlmodel_executable_info is not None and _contains_instance_fullname(

{sqlmodel_mypy_plugin-0.19.0 → sqlmodel_mypy_plugin-0.19.1}/src/sqlmodel_mypy/transform.py

@@ -1198,11 +1198,25 @@ def add_method(
     """
     info = cls.info
 
-    # Remove previously generated methods.
+    def _remove_stmt(stmt: Statement) -> None:
+        # `list.remove(...)` raises ValueError if not present; ignore.
+        try:
+            cls.defs.body.remove(stmt)
+        except ValueError:
+            return
+
+    # Remove previously generated methods (handle both FuncDef and Decorator nodes).
     if name in info.names:
         sym = info.names[name]
-        if sym.plugin_generated and isinstance(sym.node, FuncDef):
-            cls.defs.body.remove(sym.node)
+        if sym.plugin_generated:
+            node = sym.node
+            if isinstance(node, Decorator):
+                # NOTE: older buggy versions appended the underlying FuncDef instead of the
+                # Decorator; remove both to be safe.
+                _remove_stmt(node)
+                _remove_stmt(node.func)
+            elif isinstance(node, FuncDef):
+                _remove_stmt(node)
 
     # Keep existing definition for semantic analysis by renaming it.
     if name in info.names:
@@ -1248,9 +1262,13 @@ def add_method(
         dec = Decorator(func, [NameExpr("classmethod")], v)
         dec.line = info.line
         sym = SymbolTableNode(MDEF, dec)
+        # NOTE: keep the class body node as a plain FuncDef (this matches the
+        # previous plugin behavior and avoids override-check churn).
+        body_node: Statement = func
     else:
         sym = SymbolTableNode(MDEF, func)
+        body_node = func
 
     sym.plugin_generated = True
     info.names[name] = sym
-    info.defn.defs.body.append(func)
+    info.defn.defs.body.append(body_node)

{sqlmodel_mypy_plugin-0.19.0/tests/mypy/outputs/mypy-plugin_ini → sqlmodel_mypy_plugin-0.19.1/tests/mypy/outputs/mypy-plugin-strict_ini}/aliased_joins.py

@@ -28,5 +28,6 @@ with Session(engine) as session:
         ok_team: Team | None = team
 
         bad_team: Team = team
+# MYPY: error: Incompatible types in assignment (expression has type "Team | None", variable has type "Team")  [assignment]
         if team is not None:
             ok_team_name: str = team.name

{sqlmodel_mypy_plugin-0.19.0 → sqlmodel_mypy_plugin-0.19.1}/tests/mypy/outputs/mypy-plugin-strict_ini/docs_parity_read_connected_data.py

@@ -37,7 +37,6 @@ with Session(engine) as session:
     stmt_heroes_only = select(Hero).join(Team).where(Team.name == "Preventers")
     for hero3 in session.exec(stmt_heroes_only):
         ok_hero3: Hero = hero3
-# MYPY: error: Incompatible types in assignment (expression has type "tuple[Hero]", variable has type "Hero")  [assignment]
 
     # Docs pattern: LEFT OUTER join via isouter=True.
     stmt_outer = select(Hero, Team).join(Team, isouter=True)
@@ -47,3 +46,4 @@ with Session(engine) as session:
 
         # Outer join may yield `None` for the right-hand entity.
         bad_team4: Team = team4
+# MYPY: error: Incompatible types in assignment (expression has type "Team | None", variable has type "Team")  [assignment]

{sqlmodel_mypy_plugin-0.19.0/tests/mypy/outputs/mypy-plugin_ini → sqlmodel_mypy_plugin-0.19.1/tests/mypy/outputs/mypy-plugin-strict_ini}/execution_options.py

@@ -30,3 +30,4 @@ with Session(engine) as session:
 
         # Outer join may yield `None` for the right-hand entity.
         bad_team: Team = team
+# MYPY: error: Incompatible types in assignment (expression has type "Team | None", variable has type "Team")  [assignment]

{sqlmodel_mypy_plugin-0.19.0 → sqlmodel_mypy_plugin-0.19.1}/tests/mypy/outputs/mypy-plugin-strict_ini/joins.py

@@ -32,6 +32,7 @@ with Session(engine) as session:
 
         # Outer join may yield `None` for the right-hand entity.
         bad_team: Team = team2
+# MYPY: error: Incompatible types in assignment (expression has type "Team | None", variable has type "Team")  [assignment]
         if team2 is not None:
             ok_team_name2: str = team2.name
 
@@ -41,6 +42,7 @@ with Session(engine) as session:
         ok_hero3: Hero = hero3
         ok_team3: Team | None = team3
         bad_team3: Team = team3
+# MYPY: error: Incompatible types in assignment (expression has type "Team | None", variable has type "Team")  [assignment]
 
     # One-to-many join via relationship attribute target should also propagate `None`.
     stmt_outer_rel_many = select(Team, Hero).join(Team.heroes, isouter=True)
@@ -48,5 +50,6 @@ with Session(engine) as session:
         ok_team4: Team = team4
         ok_hero4: Hero | None = hero4
         bad_hero4: Hero = hero4
+# MYPY: error: Incompatible types in assignment (expression has type "Hero | None", variable has type "Hero")  [assignment]
         if hero4 is not None:
             ok_hero4_name: str = hero4.name

sqlmodel_mypy_plugin-0.19.1/tests/mypy/outputs/mypy-plugin-strict_ini/session_exec.py

@@ -0,0 +1,43 @@
+from __future__ import annotations
+
+from typing import Any
+
+from sqlalchemy import select, text
+from sqlalchemy.engine.cursor import CursorResult
+from sqlalchemy.engine.result import Result, TupleResult
+from sqlmodel import Field, Session, SQLModel, create_engine, delete
+from sqlmodel.ext.asyncio.session import AsyncSession
+
+
+class Hero(SQLModel, table=True):
+    id: int | None = Field(default=None, primary_key=True)
+    name: str = Field()
+
+
+engine = create_engine("sqlite://")
+
+with Session(engine) as session:
+    # accept SQLAlchemy (non-SQLModel) Executable statements, e.g. text(...)
+    result = session.exec(text("SELECT 1"))
+    ok_result: Result[Any] = result
+
+    # accept SQLAlchemy `select(...)` statements (commonly used with SQLModel)
+    select_result = session.exec(select(Hero))
+    _ok_select_result: TupleResult[tuple[Hero]] = select_result
+# MYPY: error: Incompatible types in assignment (expression has type "CursorResult[Any]", variable has type "TupleResult[tuple[Hero]]")  [assignment]
+
+    # Keep update/delete statements working (select correct overload).
+    delete_result = session.exec(delete(Hero))
+    ok_delete_result: CursorResult[Any] = delete_result
+
+
+async def async_exec(session: AsyncSession) -> None:
+    result2 = await session.exec(text("SELECT 1"))
+    _ok_result2: Result[Any] = result2
+
+    select_result2 = await session.exec(select(Hero))
+    _ok_select_result2: TupleResult[tuple[Hero]] = select_result2
+# MYPY: error: Incompatible types in assignment (expression has type "CursorResult[Any]", variable has type "TupleResult[tuple[Hero]]")  [assignment]
+
+    delete_result2 = await session.exec(delete(Hero))
+    _ok_delete_result2: CursorResult[Any] = delete_result2

{sqlmodel_mypy_plugin-0.19.0/tests/mypy/outputs/mypy-plugin-strict_ini → sqlmodel_mypy_plugin-0.19.1/tests/mypy/outputs/mypy-plugin_ini}/aliased_joins.py

@@ -28,5 +28,6 @@ with Session(engine) as session:
         ok_team: Team | None = team
 
         bad_team: Team = team
+# MYPY: error: Incompatible types in assignment (expression has type "Team | None", variable has type "Team")  [assignment]
         if team is not None:
             ok_team_name: str = team.name

{sqlmodel_mypy_plugin-0.19.0/tests/mypy/outputs/mypy-plugin-strict_ini → sqlmodel_mypy_plugin-0.19.1/tests/mypy/outputs/mypy-plugin_ini}/execution_options.py

@@ -30,3 +30,4 @@ with Session(engine) as session:
 
         # Outer join may yield `None` for the right-hand entity.
         bad_team: Team = team
+# MYPY: error: Incompatible types in assignment (expression has type "Team | None", variable has type "Team")  [assignment]

{sqlmodel_mypy_plugin-0.19.0 → sqlmodel_mypy_plugin-0.19.1}/tests/mypy/outputs/mypy-plugin_ini/joins.py

@@ -32,6 +32,7 @@ with Session(engine) as session:
 
         # Outer join may yield `None` for the right-hand entity.
         bad_team: Team = team2
+# MYPY: error: Incompatible types in assignment (expression has type "Team | None", variable has type "Team")  [assignment]
         if team2 is not None:
             ok_team_name2: str = team2.name
 
@@ -41,6 +42,7 @@ with Session(engine) as session:
         ok_hero3: Hero = hero3
         ok_team3: Team | None = team3
         bad_team3: Team = team3
+# MYPY: error: Incompatible types in assignment (expression has type "Team | None", variable has type "Team")  [assignment]
 
     # One-to-many join via relationship attribute target should also propagate `None`.
     stmt_outer_rel_many = select(Team, Hero).join(Team.heroes, isouter=True)
@@ -48,5 +50,6 @@ with Session(engine) as session:
         ok_team4: Team = team4
         ok_hero4: Hero | None = hero4
         bad_hero4: Hero = hero4
+# MYPY: error: Incompatible types in assignment (expression has type "Hero | None", variable has type "Hero")  [assignment]
         if hero4 is not None:
             ok_hero4_name: str = hero4.name

sqlmodel_mypy_plugin-0.19.1/tests/mypy/outputs/mypy-plugin_ini/session_exec.py

@@ -0,0 +1,43 @@
+from __future__ import annotations
+
+from typing import Any
+
+from sqlalchemy import select, text
+from sqlalchemy.engine.cursor import CursorResult
+from sqlalchemy.engine.result import Result, TupleResult
+from sqlmodel import Field, Session, SQLModel, create_engine, delete
+from sqlmodel.ext.asyncio.session import AsyncSession
+
+
+class Hero(SQLModel, table=True):
+    id: int | None = Field(default=None, primary_key=True)
+    name: str = Field()
+
+
+engine = create_engine("sqlite://")
+
+with Session(engine) as session:
+    # accept SQLAlchemy (non-SQLModel) Executable statements, e.g. text(...)
+    result = session.exec(text("SELECT 1"))
+    ok_result: Result[Any] = result
+
+    # accept SQLAlchemy `select(...)` statements (commonly used with SQLModel)
+    select_result = session.exec(select(Hero))
+    _ok_select_result: TupleResult[tuple[Hero]] = select_result
+# MYPY: error: Incompatible types in assignment (expression has type "CursorResult[Any]", variable has type "TupleResult[tuple[Hero]]")  [assignment]
+
+    # Keep update/delete statements working (select correct overload).
+    delete_result = session.exec(delete(Hero))
+    ok_delete_result: CursorResult[Any] = delete_result
+
+
+async def async_exec(session: AsyncSession) -> None:
+    result2 = await session.exec(text("SELECT 1"))
+    _ok_result2: Result[Any] = result2
+
+    select_result2 = await session.exec(select(Hero))
+    _ok_select_result2: TupleResult[tuple[Hero]] = select_result2
+# MYPY: error: Incompatible types in assignment (expression has type "CursorResult[Any]", variable has type "TupleResult[tuple[Hero]]")  [assignment]
+
+    delete_result2 = await session.exec(delete(Hero))
+    _ok_delete_result2: CursorResult[Any] = delete_result2

{sqlmodel_mypy_plugin-0.19.0 → sqlmodel_mypy_plugin-0.19.1}/tests/test_transform_unit.py

@@ -657,7 +657,58 @@ def test_add_method_generates_and_replaces_methods() -> None:
         api, cls, "cm", args=[arg], return_type=AnyType(TypeOfAny.explicit), is_classmethod=True
     )
     assert "cm" in cls.info.names
-    assert isinstance(cls.info.names["cm"].node, Decorator)
+    cm_node = cls.info.names["cm"].node
+    assert isinstance(cm_node, Decorator)
+    assert cm_node.func.is_class is True
+    assert cm_node not in cls.defs.body
+    assert cm_node.func in cls.defs.body
+
+
+def test_add_method_classmethod_reentry_is_idempotent_and_handles_legacy_body() -> None:
+    api = DummyAPI()
+    cls = make_sqlmodel_class()
+
+    any_t = AnyType(TypeOfAny.explicit)
+    arg = Argument(Var("x", any_t), any_t, None, ARG_NAMED)
+
+    # First generation
+    add_method(
+        api, cls, "cm", args=[arg], return_type=AnyType(TypeOfAny.explicit), is_classmethod=True
+    )
+    node1 = cls.info.names["cm"].node
+    assert isinstance(node1, Decorator)
+    assert node1 not in cls.defs.body
+    assert node1.func in cls.defs.body
+    assert node1.func.is_class is True
+
+    # Re-entry: previously generated Decorator should be removed, no duplicates.
+    add_method(
+        api, cls, "cm", args=[arg], return_type=AnyType(TypeOfAny.explicit), is_classmethod=True
+    )
+    node2 = cls.info.names["cm"].node
+    assert isinstance(node2, Decorator)
+    assert node2 not in cls.defs.body
+    assert node2.func in cls.defs.body
+    assert node1.func not in cls.defs.body
+    assert node2.func.is_class is True
+    assert sum(1 for s in cls.defs.body if isinstance(s, FuncDef) and s.name == "cm") == 1
+
+    # Simulate legacy buggy state: body contains both Decorator and FuncDef.
+    cls.defs.body.append(node2)
+    assert node2 in cls.defs.body
+    assert node2.func in cls.defs.body
+
+    add_method(
+        api, cls, "cm", args=[arg], return_type=AnyType(TypeOfAny.explicit), is_classmethod=True
+    )
+    node3 = cls.info.names["cm"].node
+    assert isinstance(node3, Decorator)
+    assert node3 not in cls.defs.body
+    assert node3.func in cls.defs.body
+    assert node2 not in cls.defs.body
+    assert node2.func not in cls.defs.body
+    assert node3.func.is_class is True
+    assert sum(1 for s in cls.defs.body if isinstance(s, FuncDef) and s.name == "cm") == 1
 
 
 def test_transform_defer_paths() -> None: