Problema di importazione / contesto Flask-SQLAlchemy


117

Voglio strutturare la mia app Flask in modo simile:

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

apps.members è un Flask Blueprint.

Ora, per creare le classi del modello, devo avere una sospensione dell'app, qualcosa del tipo:

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

db = SQLAlchemy(current_app)

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

Ma se provo a importare quel modello nella mia app Blueprint, ottengo il temuto RuntimeError: working outside of request context. Come posso ottenere correttamente una sospensione della mia app qui? Le importazioni relative potrebbero funzionare ma sono piuttosto brutte e hanno i loro problemi di contesto, ad esempio:

from ...site import app

# ValueError: Attempted relative import beyond toplevel package

Risposte:


295

Il flask_sqlalchemymodulo non deve essere inizializzato immediatamente con l'app: puoi farlo invece:

# apps.members.models
from flask_sqlalchemy import SQLAlchemy

db = SQLAlchemy()

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

E poi nella configurazione dell'applicazione puoi chiamare init_app:

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

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

In questo modo puoi evitare importazioni cicliche.

Questo modello non richiede di inserire tutti i modelli in un unico file. Basta importare la dbvariabile in ciascuno dei moduli del modello.

Esempio

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

Nota: questo è uno schizzo di alcune delle potenzialità che questo ti dà - ovviamente c'è molto di più che puoi fare per rendere lo sviluppo ancora più semplice (usando un create_apppattern, i progetti di registrazione automatica in alcune cartelle, ecc.)


2
Puoi farlo più volte? Ad esempio, se ho più di un file models.py?
Brad Wright

@BradWright: rende più facile creare solo dbistanze per ogni database che hai. Se hai un pacchetto di modelli puoi inserirlo __init__.py. Comunque tu scelga di farlo, devi semplicemente importare la dbvariabile da quella posizione negli altri file di modello e usarla normalmente. Quando vengono caricati tutto si risolve correttamente.
Sean Vieira

1
Ti capiterà di avere un collegamento a un progetto impostato in questo modo?
Mbrevda

4
@Mbrevda - puoi vedere un esempio di questo modello qui github.com/svieira/Budget-Manager
Sean Vieira,

1
Lo .ext.spazio dei nomi è deprecato: è meglio importare dallo spazio dei nomi reale ( flask_sqlalchemy).
Sean Vieira

25

un'app.py originale : 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()

Ho appena diviso un'app.py in app.py e model.py senza usare Blueprint. In tal caso, la risposta di cui sopra non funziona. È necessario un codice di linea per funzionare.

prima :

db.init_app(app)

dopo :

db.app = app
db.init_app(app)

E il seguente collegamento è molto utile.

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


2
db.app = appstava ottenendo un errore di runtime perché init_app non imposta l'app. +1
Amit Tripathi

3
db.app = app(seguito da db.init_app(app)) era il pezzo mancante per me. Funziona perfettamente dopo aver aggiunto quella
frase

Il primo collegamento è obsoleto.
Rahul KP
Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.