Проблема імпорту / контексту 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

Відповіді:


295

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)

Таким чином можна уникнути циклічного імпорту.

Цей зразок не вимагає розміщення всіх ваших моделей в одному файлі. Просто імпортуйте 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?
Бред Райт

@BradWright - це простіше, якщо ви створите лише dbпримірник для кожної наявної бази даних. Якщо у вас є пакет моделей, ви можете помістити його __init__.py. Однак ви вирішите це зробити, ви просто імпортуєте dbзмінну з цього місця у ваші інші файли моделі та використовуєте її як звичайну. Коли вони завантажені, все вирішується правильно.
Шон Віейра

1
Чи трапляється вам посилання на проект, який створений таким чином?
Мбревда

4
@Mbrevda - ви можете побачити приклад цієї картини тут github.com/svieira/Budget-Manager
Шон Віейра

1
.ext.Імена засуджуються - це краще імпорт з реального простору імен ( flask_sqlalchemy).
Шон Віейра

25

оригінальний 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()

Я просто розділив один app.py на app.py та model.py, не використовуючи програму Blueprint. У цьому випадку вищевказана відповідь не працює. Для роботи потрібен код рядка.

перед :

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 = appотримував runtimeerror, оскільки init_app не встановлює додаток. +1
Аміт Тріпаті

3
db.app = app(слідом за ним db.init_app(app)) був для мене відсутнім шматочком. Чудово працює після додавання цього рядка (у поєднанні з відповіддю Шона
Віейри

Перша посилання застаріла.
Рахул КП
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.