Flask-SQLAlchemy インポート/コンテキストの問題

Question

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

しかし、そのモデルをブループリント アプリにインポートしようとすると、恐ろしいことが起こります。 RuntimeError: working outside of request context. 。ここでアプリを正しく取得するにはどうすればよいですか?相対インポートは機能するかもしれませんが、かなり見苦しく、独自のコンテキストの問題があります。例:

from ...site import app

# ValueError: Attempted relative import beyond toplevel package

Answer 1

の 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)

こうすることで、周期的なインポートを回避できます。

このパターンでは、 ない すべてのモデルを 1 つのファイルに配置する必要があります。単にインポートするだけです 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 パターン、特定のフォルダーへのブループリントの自動登録など）}

Answer 2

オリジナル 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()

ブループリントを使用せずに、1 つの app.py を app.py と model.py に分割しました。その場合、上記の答えは機能しません。動作するには回線コードが必要です。

前に:

db.init_app(app)

後:

db.app = app
db.init_app(app)

そして、次のリンクは非常に便利です。

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