Problem z importem / kontekstem Flask-SQLAlchemy

117

Chcę utworzyć strukturę mojej aplikacji Flask na przykład:

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

apps.members to schemat kolby.

Teraz, aby stworzyć klasy modelowe, potrzebuję posiadać aplikację w stylu:

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

db = SQLAlchemy(current_app)

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

Ale jeśli spróbuję zaimportować ten model do mojej aplikacji Blueprint, jestem przerażony RuntimeError: working outside of request context. Jak mogę tutaj poprawnie uzyskać dostęp do mojej aplikacji? Importy względne mogą działać, ale są dość brzydkie i mają własne problemy z kontekstem, np .:

from ...site import app

# ValueError: Attempted relative import beyond toplevel package
Brad Wright
źródło

Odpowiedzi:

295

flask_sqlalchemyModuł nie musi być inicjowana z aplikacji od razu - można to zrobić w zamian:

# apps.members.models
from flask_sqlalchemy import SQLAlchemy

db = SQLAlchemy()

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

A następnie w konfiguracji aplikacji możesz zadzwonić init_app:

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

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

W ten sposób unikniesz cyklicznego importu.

Ten wzór nie wymaga umieszczania wszystkich modeli w jednym pliku. Po prostu zaimportuj dbzmienną do każdego z modułów modelu.

Przykład

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

Uwaga: to jest szkic niektórych mocy, które ci to daje - jest oczywiście znacznie więcej, co możesz zrobić, aby jeszcze bardziej ułatwić programowanie (użycie create_appwzoru, automatyczna rejestracja planów w niektórych folderach itp.)

Sean Vieira
źródło
2
Czy możesz to zrobić wiele razy? Na przykład, jeśli mam więcej niż jeden plik models.py?
Brad Wright,
@BradWright - będzie to łatwiejsze, jeśli utworzysz tylko dbinstancję dla każdej posiadanej bazy danych. Jeśli masz pakiet modeli, możesz go włożyć __init__.py. Jakkolwiek zdecydujesz się to zrobić, po prostu importujesz dbzmienną z tego miejsca do innych plików modelu i używasz jej jak zwykle. Po załadowaniu wszystko przebiega poprawnie.
Sean Vieira
1
Czy miałbyś link do projektu, który jest skonfigurowany w ten sposób?
Mbrevda
4
@Mbrevda - przykład tego wzorca można zobaczyć tutaj github.com/svieira/Budget-Manager
Sean Vieira
1
Przestrzeń .ext.nazw jest przestarzała - lepiej importować ją z prawdziwej przestrzeni nazw ( flask_sqlalchemy).
Sean Vieira
25

oryginalny 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()

Właśnie podzieliłem jeden plik app.py na app.py i model.py bez korzystania z Blueprint. W takim przypadku powyższa odpowiedź nie działa. Do działania potrzebny jest kod linii.

przed :

db.init_app(app)

po :

db.app = app
db.init_app(app)

Poniższy link jest bardzo przydatny.

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

cybaek
źródło
2
db.app = apppojawiał się błąd w czasie wykonywania, ponieważ init_app nie ustawił aplikacji. +1
Amit Tripathi
3
db.app = app(a następnie db.init_app(app)) był dla mnie brakującym elementem. Działa idealnie po dodaniu tej linii (w połączeniu z odpowiedzią Seana Vieiry)
Dotl
Pierwszy link jest nieaktualny.
Rahul KP,