Проблема импорта / контекста Flask-SQLAlchemy

117

Я хочу структурировать свое приложение Flask примерно так:

./site.py
./apps/members/__init__.py
./apps/members/models.py

apps.members это чертеж Flask.

Теперь, чтобы создать классы модели, мне нужно удерживать приложение, например:

# apps.members.models
from flask import current_app
from flaskext.sqlalchemy import SQLAlchemy

db = SQLAlchemy(current_app)

class Member(db.Model):
    # fields here
    pass

Но если я попытаюсь импортировать эту модель в свое приложение Blueprint, я получу ужас RuntimeError: working outside of request context. Как мне здесь правильно получить свое приложение? Относительный импорт может работать, но он довольно уродлив и имеет свои проблемы с контекстом, например:

from ...site import app

# ValueError: Attempted relative import beyond toplevel package
Брэд Райт
источник

Ответы:

295

flask_sqlalchemyМодуль не должен быть инициализирован с приложением сразу - вы можете сделать это вместо того, чтобы :

# apps.members.models
from flask_sqlalchemy import SQLAlchemy

db = SQLAlchemy()

class Member(db.Model):
    # fields here
    pass

А затем в настройках вашего приложения вы можете позвонить init_app:

# apps.application.py
from flask import Flask
from apps.members.models import db

app = Flask(__name__)
# later on
db.init_app(app)

Таким образом можно избежать циклического импорта.

Этот шаблон не требует размещения всех ваших моделей в одном файле. Просто импортируйте dbпеременную в каждый из модулей вашей модели.

пример

# apps.shared.models
from flask_sqlalchemy import SQLAlchemy

db = SQLAlchemy()

# apps.members.models
from apps.shared.models import db

class Member(db.Model):
    # TODO: Implement this.
    pass

# apps.reporting.members
from flask import render_template
from apps.members.models import Member

def report_on_members():
    # TODO: Actually use arguments
    members = Member.filter(1==1).all()
    return render_template("report.html", members=members)

# apps.reporting.routes
from flask import Blueprint
from apps.reporting.members import report_on_members

reporting = Blueprint("reporting", __name__)

reporting.route("/member-report", methods=["GET","POST"])(report_on_members)

# apps.application
from flask import Flask
from apps.shared import db
from apps.reporting.routes import reporting

app = Flask(__name__)
db.init_app(app)
app.register_blueprint(reporting)

Примечание: это набросок некоторых возможностей, которые это дает вам - очевидно, что вы можете сделать гораздо больше, чтобы упростить разработку (использование create_appшаблона, автоматическая регистрация чертежей в определенных папках и т. Д.)

Шон Виейра
источник
2
Можете ли вы сделать это несколько раз? Например, если у меня более одного файла models.py?
Брэд Райт,
@BradWright - это упрощает, если вы создаете только dbэкземпляр для каждой базы данных, которая у вас есть. Если у вас есть пачка моделей, вы можете положить ее __init__.py. Как бы вы ни решили это сделать, вы просто импортируете dbпеременную из этого места в другие файлы модели и используете ее как обычно. Когда они загружаются, все разрешается правильно.
Шон Виейра,
1
У вас есть ссылка на проект, который настроен таким образом?
Mbrevda
4
@Mbrevda - вы можете увидеть пример этого шаблона здесь github.com/svieira/Budget-Manager
Шон Виейра
1
Пространство .ext.имен устарело - лучше импортировать из реального пространства имен ( flask_sqlalchemy).
Шон Виейра
25

оригинальный app.py : https://flask-sqlalchemy.palletsprojects.com/en/2.x/quickstart/

...

app = flask.Flask(__name__)
app.config['DEBUG'] = True
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:////tmp/test.db'
db = flask.ext.sqlalchemy.SQLAlchemy(app)

class Person(db.Model):
    id = db.Column(db.Integer, primary_key=True)
...

class Computer(db.Model):
    id = db.Column(db.Integer, primary_key=True)
...

# Create the database tables.
db.create_all()

...

# start the flask loop
app.run()

Я просто разделил один app.py на app.py и model.py без использования Blueprint. В этом случае приведенный выше ответ не сработает. Для работы нужен линейный код.

до :

db.init_app(app)

после :

db.app = app
db.init_app(app)

И следующая ссылка очень полезна.

http://piotr.banaszkiewicz.org/blog/2012/06/29/flask-sqlalchemy-init_app/

Cybaek
источник
2
db.app = appполучал runtimeerror, потому что init_app не устанавливает app. +1
Амит Трипати
3
db.app = app(сопровождаемый db.init_app(app)) был для меня недостающей частью. Прекрасно работает после добавления этой строки (в сочетании с ответом Шона Виейры)
Dotl
Первая ссылка устарела.
Rahul KP