Style and sphinx checks

Author: pamelafox

src/flask_sqlalchemy/extension.py

@@ -48,7 +48,9 @@ class _FSAModel(Model):
     metadata: sa.MetaData
 
 
-def _get_2x_declarative_bases(model_class: t.Type[_FSA_MC]) -> list[t.Type]:
+def _get_2x_declarative_bases(
+    model_class: t.Type[_FSA_MC],
+) -> list[t.Type[t.Union[sa_orm.DeclarativeBase, sa_orm.DeclarativeBaseNoMeta]]]:
     return [
         b
         for b in model_class.__bases__
@@ -81,10 +83,6 @@ class SQLAlchemy:
     :param app: Call :meth:`init_app` on this Flask application now.
     :param metadata: Use this as the default :class:`sqlalchemy.schema.MetaData`. Useful
         for setting a naming convention.
-        .. deprecated:: 3.1.0
-            This parameter can still be used in conjunction with SQLAlchemy 1.x classes,
-            but is ignored when using SQLAlchemy 2.x style of declarative classes.
-            Instead, specify metadata on your Base class.
     :param session_options: Arguments used by :attr:`session` to create each session
         instance. A ``scopefunc`` key will be passed to the scoped session, not the
         session instance. See :class:`sqlalchemy.orm.sessionmaker` for a list of
@@ -101,8 +99,16 @@ class SQLAlchemy:
         ``flask shell``.
 
     .. versionchanged:: 3.1.0
-        Added the ``disable_autonaming`` parameter and changed ``model_class`` parameter
-        to accept a SQLAlchemy 2.0-style declarative base subclass.
+        The ``metadata`` parameter can still be used with SQLAlchemy 1.x classes,
+        but is ignored when using SQLAlchemy 2.x style of declarative classes.
+        Instead, specify metadata on your Base class.
+
+    .. versionchanged:: 3.1.0
+        Added the ``disable_autonaming`` parameter.
+
+    .. versionchanged:: 3.1.0
+        Changed ``model_class`` parameter to accepta SQLAlchemy 2.x
+        declarative base subclass.
 
     .. versionchanged:: 3.0
         An active Flask application context is always required to access ``session`` and
@@ -534,7 +540,10 @@ def _make_declarative_base(
                 " Got: {}".format(model_class.__bases__)
             )
         elif len(declarative_bases) == 1:
-            body = {"__fsa__": self, "metadata": model_class.metadata}
+            body = {
+                "__fsa__": self,
+                "metadata": model_class.metadata,  # type: ignore[attr-defined]
+            }
             mixin_classes = [BindMixin, NameMixin, Model]
             if disable_autonaming:
                 mixin_classes.remove(NameMixin)

tests/test_extension_object.py

@@ -29,12 +29,12 @@ def test_get_or_404_kwargs(app: Flask, model_class: t.Any) -> None:
 
     if issubclass(db.Model, (sa_orm.MappedAsDataclass)):
 
-        class User(db.Model):  # type: ignore[no-redef]
+        class User(db.Model):
             id: sa_orm.Mapped[int] = sa_orm.mapped_column(
                 sa.Integer, primary_key=True, init=False
             )
 
-        class Todo(db.Model):  # type: ignore[no-redef]
+        class Todo(db.Model):
             id: sa_orm.Mapped[int] = sa_orm.mapped_column(
                 sa.Integer, primary_key=True, init=False
             )

tests/test_session.py

@@ -108,13 +108,13 @@ class Admin(User):
 
     elif issubclass(db.Model, (sa_orm.DeclarativeBase, sa_orm.DeclarativeBaseNoMeta)):
 
-        class User(db.Model):
+        class User(db.Model):  # type: ignore[no-redef]
             __bind_key__ = "a"
             id: sa_orm.Mapped[int] = sa_orm.mapped_column(sa.Integer, primary_key=True)
             type: sa_orm.Mapped[str] = sa_orm.mapped_column(sa.String, nullable=False)
             __mapper_args__ = {"polymorphic_on": type, "polymorphic_identity": "user"}
 
-        class Admin(User):
+        class Admin(User):  # type: ignore[no-redef]
             id: sa_orm.Mapped[int] = sa_orm.mapped_column(
                 sa.ForeignKey(User.id), primary_key=True
             )
@@ -130,7 +130,7 @@ class User(db.Model):  # type: ignore[no-redef]
             __mapper_args__ = {"polymorphic_on": type, "polymorphic_identity": "user"}
 
         class Admin(User):  # type: ignore[no-redef]
-            id = sa.Column(sa.ForeignKey(User.id), primary_key=True)
+            id = sa.Column(sa.ForeignKey(User.id), primary_key=True)  # type: ignore[assignment]
             org = sa.Column(sa.String, nullable=False)
             __mapper_args__ = {"polymorphic_identity": "admin"}
 

tests/test_track_modifications.py

@@ -71,7 +71,7 @@ def after_commit(sender: Flask, changes: list[tuple[t.Any, str]]) -> None:
 
         db.session.remove()
         item = db.session.get(Todo, 1)  # type: ignore[assignment]
-        item.title = "test"  # type: ignore[assignment]
+        item.title = "test"
         db.session.commit()
         assert len(before) == 1
         assert before[0] == (item, "update")