fix type hints: allow ModelView(Model, flask_sqlalchemy.SQLAlchemy.session) (#2908)

Author: ElLorans

flask_admin/_types.py

@@ -24,22 +24,22 @@
     from flask_sqlalchemy import Model as T_SQLALCHEMY_LEGACY_MODEL
     from sqlalchemy.orm import DeclarativeBase as T_DECLARATIVE_BASE
 
-    from flask_admin.base import BaseView as T_VIEW
+    from flask_admin.base import BaseView as T_VIEW  # noqa: F401
     from flask_admin.contrib.sqla.validators import InputRequired as T_INPUT_REQUIRED
     from flask_admin.contrib.sqla.validators import (
         TimeZoneValidator as T_TIMEZONE_VALIDATOR,
     )
     from flask_admin.contrib.sqla.validators import Unique as T_UNIQUE
-    from flask_admin.form import FormOpts as T_FORM_OPTS
+    from flask_admin.form import FormOpts as T_FORM_OPTS  # noqa: F401
     from flask_admin.form.rules import BaseRule as T_BASE_RULE
     from flask_admin.form.rules import Field as T_FLASK_ADMIN_FIELD
     from flask_admin.form.rules import FieldSet as T_FIELD_SET
     from flask_admin.form.rules import Header as T_HEADER
     from flask_admin.form.rules import Macro as T_MACRO
     from flask_admin.model import BaseModelView as T_MODEL_VIEW
-    from flask_admin.model.ajax import AjaxModelLoader as T_AJAX_MODEL_LOADER
-    from flask_admin.model.fields import AjaxSelectField as T_AJAX_SELECT_FIELD
-    from flask_admin.model.form import InlineBaseFormAdmin as T_INLINE_BASE_FORM_ADMIN
+    from flask_admin.model.ajax import AjaxModelLoader as T_AJAX_MODEL_LOADER  # noqa: F401
+    from flask_admin.model.fields import AjaxSelectField as T_AJAX_SELECT_FIELD  # noqa: F401
+    from flask_admin.model.form import InlineBaseFormAdmin as T_INLINE_BASE_FORM_ADMIN  # noqa: F401
     from flask_admin.model.form import InlineFormAdmin as T_INLINE_FORM_ADMIN
     from flask_admin.model.widgets import (
         AjaxSelect2Widget as T_INLINE_AJAX_SELECT2_WIDGET,
@@ -77,8 +77,8 @@
         T_SQLALCHEMY_COLUMN = Column  # type: ignore[misc]
 
     T_MONGO_CLIENT = MongoClient[t.Any]
-    from PIL.Image import Image as T_PIL_IMAGE
-    from redis import Redis as T_REDIS
+    from PIL.Image import Image as T_PIL_IMAGE  # noqa: F401
+    from redis import Redis as T_REDIS  # noqa: F401
 
     from flask_admin.contrib.peewee.ajax import (
         QueryAjaxModelLoader as T_PEEWEE_QUERY_AJAX_MODEL_LOADER,

flask_admin/contrib/sqla/_types.py

@@ -1,27 +1,27 @@
 import typing as t
 
 from sqlalchemy.orm import scoped_session
-from sqlalchemy.orm import Session
 from sqlalchemy.orm.query import Query
 
-if t.TYPE_CHECKING:  # sqlalchemy 2.x types are subscriptable
-    T_SQLALCHEMY_QUERY = Query[t.Any]
-    T_SCOPED_SESSION = scoped_session[Session]
-
-else:  # sqlalchemy 1.x types are not subscriptable
-    T_SQLALCHEMY_QUERY = Query
-    T_SCOPED_SESSION = scoped_session
-
 try:
     from flask_sqlalchemy_lite import SQLAlchemy as T_SQLALCHEMY_LITE
 except ImportError:
     T_SQLALCHEMY_LITE: t.Any | None = None  # type: ignore[no-redef]
 
 try:
     from flask_sqlalchemy import SQLAlchemy as T_SQLALCHEMY
+    from flask_sqlalchemy.session import Session as T_SESSION
 except ImportError:
     T_SQLALCHEMY: t.Any | None = None  # type: ignore[no-redef]
 
 
-T_SESSION = Session
-T_SESSION_OR_DB = T_SCOPED_SESSION | T_SESSION | T_SQLALCHEMY | T_SQLALCHEMY_LITE
+if t.TYPE_CHECKING:  # sqlalchemy 2.x types are subscriptable
+    T_SQLALCHEMY_QUERY = Query[t.Any]
+    T_SCOPED_SESSION = scoped_session[T_SESSION]
+
+else:  # sqlalchemy 1.x types are not subscriptable
+    T_SQLALCHEMY_QUERY = Query
+    T_SCOPED_SESSION = scoped_session
+
+
+T_SESSION_OR_DB = T_SCOPED_SESSION | T_SQLALCHEMY | T_SQLALCHEMY_LITE

flask_admin/tests/conftest.py

@@ -4,7 +4,6 @@
 import flask_sqlalchemy
 import pytest
 from flask import Flask
-from flask_sqlalchemy import SQLAlchemy
 from jinja2 import StrictUndefined
 from sqlalchemy import event
 from sqlalchemy.engine import Engine
@@ -14,6 +13,7 @@
 from flask_admin import Admin
 from flask_admin.contrib.sqla._types import T_SCOPED_SESSION
 from flask_admin.contrib.sqla._types import T_SESSION_OR_DB
+from flask_admin.contrib.sqla._types import T_SQLALCHEMY
 from flask_admin.contrib.sqla._types import T_SQLALCHEMY_LITE
 
 # flask-sqlalchemy-lite is compatible only with SQLAlchemy 2.x
@@ -172,7 +172,7 @@ def skip_or_return_session_or_db(
 def skip_or_return_session_or_db(
     extension: "SQLAProvider",
     string: t.Literal["db"],
-) -> SQLAlchemy: ...
+) -> T_SQLALCHEMY: ...
 
 
 @t.overload
@@ -194,7 +194,7 @@ def skip_or_return_session_or_db(
 ) -> (
     T_SCOPED_SESSION
     | Session
-    | SQLAlchemy
+    | T_SQLALCHEMY
     | T_SQLALCHEMY_LITE
     | T_SCOPED_SESSION_FLASK_SQLA
 ):

flask_admin/tests/mongoengine/conftest.py

@@ -7,7 +7,6 @@
 from mongoengine import disconnect
 
 from flask_admin import Admin
-from flask_admin.contrib.sqla._types import T_SESSION_OR_DB
 
 
 @pytest.fixture
@@ -23,7 +22,7 @@ def db() -> t.Generator[None, t.Any, None]:
 
 @pytest.fixture
 def admin(
-    app: Flask, babel: object | None, db: T_SESSION_OR_DB
+    app: Flask, babel: object | None, db: t.Any
 ) -> t.Generator[Admin, t.Any, None]:
     admin = Admin(app)
     yield admin