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


117

Flaskアプリを次のように構成したい:

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

apps.members フラスコの青写真です。

ここで、モデルクラスを作成するには、次のようなアプリを保持する必要があります。

# 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

回答:


294

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パターンを使用したり、特定のフォルダーにブループリントを自動登録するなど)。


2
複数回できますか?たとえば、models.pyファイルが複数ある場合はどうなりますか?
Brad Wright、

@BradWright-所有しているdb各データベースのインスタンスのみを作成すると、より簡単になります。モデルのパッケージがある場合は、それをに入れることができます__init__.py。ただし、それを行うことを選択したdb場合は、その場所から他のモデルファイルに変数をインポートして、通常どおりに使用するだけです。それらがロードされると、すべてが正しく解決されます。
Sean Vieira 2012年

1
このように設定されたプロジェクトへのリンクがありますか?
Mbrevda 2013年

4
@Mbrevda-このパターンの例は、こちらのgithub.com/svieira/Budget-Manager
Sean Vieira

1
.ext.名前空間は推奨されません-それは本当の名前空間からインポートする方が良いでしょう(flask_sqlalchemy)。
Sean Vieira 2015

25

app.pyhttps://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/


2
db.app = appinit_appがアプリを設定しないため、ランタイムエラーが発生していました。+1
Amit Tripathi

3
db.app = app(後に続くdb.init_app(app))は、私にとって欠けている部分でした。その行を追加すると完全に機能します(Sean Vieiraの回答と組み合わせて)
Dotl

最初のリンクは古くなっています。
Rahul KP 2018
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.