如何使用 flask_sqlalchemy 正确注释类型？

Question

我有一个使用 SQLAlchemy / flask_sqlalchemy 的工作 Flask 应用程序。为了给你一个印象，我创建了一个超级精简的版本（apps.py 和models.py）。该应用程序有效。问题是mypy 抱怨db.Model 在models.py 中的使用：

error: Name 'db.Model' is not defined

原因很可能是调用db.init_app(app)时创建的。我怎样才能解决这个问题？有没有比忽略它更好的选择？

# type: ignore

app.py

​​>

from flask import Flask
from flask_sqlalchemy import SQLAlchemy

db = SQLAlchemy()

def create_app():
    app = Flask(__name__, template_folder="templates")
    db.init_app(app)
    return app

models.py

​​>

from app import db

class User(db.Model):
    __tablename__ = "users"
    id = db.Column(db.String, primary_key=True, nullable=False)
    username = db.Column(db.String, unique=True)

Answer 1

你需要https://pypi.org/project/sqlalchemy-stubs/

引用https://docs.sqlalchemy.org/en/13/orm/extensions/declarative/basic_use.html

将 MyPy 与 SQLAlchemy 模型一起使用

如果您在 Python 中使用 PEP 484 静态类型检查器， type stubs for SQLAlchemy 包含一个 MyPy 插件。 该插件专为 SQLAlchemy 声明式模型量身定制。

Answer 2

既然你用的是flask_sqlalchemy，这个你试过了吗，

models.py

from flask import Flask
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:////tmp/test.db'
db = SQLAlchemy(app)


class User(db.Model):
    __tablename__ = "users"
    id = db.Column(db.String, primary_key=True, nullable=False)
    username = db.Column(db.String, unique=True)

编辑 这就是我的 app.py 的样子

from .settings import ProdConfig


def create_app(config_object=ProdConfig):
    app = Flask(__name__)
    app.config.from_object(config_object)
    register_blueprints(app)
    return app