Problema de importação / contexto Flask-SQLAlchemy

117

Quero estruturar meu aplicativo Flask da seguinte forma:

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

apps.members é um Flask Blueprint.

Agora, a fim de criar as classes de modelo, preciso controlar o aplicativo, algo como:

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

db = SQLAlchemy(current_app)

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

Mas se eu tento importar esse modelo para meu aplicativo Blueprint, fico com medo RuntimeError: working outside of request context. Como posso controlar meu aplicativo corretamente aqui? As importações relativas podem funcionar, mas são muito feias e têm seus próprios problemas de contexto, por exemplo:

from ...site import app

# ValueError: Attempted relative import beyond toplevel package
Brad Wright
fonte

Respostas:

295

O flask_sqlalchemymódulo não precisa ser inicializado com o aplicativo imediatamente - você pode fazer isso:

# apps.members.models
from flask_sqlalchemy import SQLAlchemy

db = SQLAlchemy()

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

E então, na configuração do aplicativo, você pode chamar init_app:

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

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

Desta forma, você pode evitar importações cíclicas.

Este padrão não exige que você coloque todos os seus modelos em um arquivo. Simplesmente importe a dbvariável para cada um dos módulos do seu modelo.

Exemplo

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

Observação: este é um esboço de parte do poder que isso oferece - obviamente, há muito mais que você pode fazer para tornar o desenvolvimento ainda mais fácil (usando um create_apppadrão, autorregistro de blueprints em certas pastas, etc.)

Sean Vieira
fonte
2
Você pode fazer isso várias vezes? Por exemplo, se eu tiver mais de um arquivo models.py?
Brad Wright,
@BradWright - fica mais fácil se você criar apenas uma dbinstância para cada banco de dados que você possui. Se você tem um pacote de modelos, pode colocá-lo __init__.py. Seja como for, você simplesmente importa a dbvariável daquele local para os outros arquivos de modelo e usa-a normalmente. Quando eles são carregados, tudo é resolvido corretamente.
Sean Vieira
1
Você teria um link para um projeto configurado dessa forma?
Mbrevda
4
@Mbrevda - você pode ver um exemplo desse padrão aqui github.com/svieira/Budget-Manager
Sean Vieira
1
O .ext.namespace está obsoleto - é melhor importar do namespace real ( flask_sqlalchemy).
Sean Vieira
25

um app.py original : 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()

Acabei de dividir um app.py em app.py e model.py sem usar o Blueprint. Nesse caso, a resposta acima não funciona. É necessário um código de linha para funcionar.

antes :

db.init_app(app)

depois :

db.app = app
db.init_app(app)

E o link a seguir é muito útil.

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

cybaek
fonte
2
db.app = appestava obtendo runtimeerror porque init_app não define o app. +1
Amit Tripathi
3
db.app = app(seguido por db.init_app(app)) era a peça que faltava para mim. Funciona perfeitamente após adicionar essa linha (combinada com a resposta de Sean Vieira)
Dotl
O primeiro link está desatualizado.
Rahul KP de