73

我正在尝试使用蓝图在 Flask 中创建一个“模块化应用程序”。

但是，在创建模型时，我遇到了必须引用应用程序才能获得dbFlask-SQLAlchemy 提供的 -object 的问题。我希望能够将一些蓝图与多个应用程序一起使用（类似于 Django 应用程序的使用方式），所以这不是一个好的解决方案。*

  • 可以进行切换，让蓝图创建db实例，然后应用程序将其与蓝图的其余部分一起导入。但是，任何其他希望创建模型的蓝图都需要从该蓝图而不是应用程序导入。

我的问题是：

  • 有没有一种方法可以让蓝图定义模型，而无需了解它们以后使用的应用程序——并且将多个蓝图组合在一起？我的意思是必须从您的蓝图中导入应用程序模块/包。
  • 我一开始就错了吗？蓝图不是独立于应用程序并且是可再分发的（à la Django 应用程序）吗？
    • 如果不是，那么您应该使用什么模式来创建类似的东西？烧瓶扩展？您是否应该干脆不这样做 - 并且可能集中所有模型/模式 à la Ruby on Rails？

编辑：我自己现在一直在考虑这个问题，这可能与 SQLAlchemy 比 Flask 更相关，因为你必须declarative_base()在声明模型时。无论如何，这一定来自某个地方！

也许最好的解决方案是将项目的模式定义在一个地方并将其分散开，就像 Ruby on Rails 那样。声明式 SQLAlchemy 类定义实际上更像 schema.rb，而不是 Django 的 models.py。我想这也会使迁移（来自alembic或sqlalchemy-migrate ）更容易使用。

我被要求提供一个示例，所以让我们做一些简单的事情：假设我有一个描述“平面页面”的蓝图——存储在数据库中的简单、“静态”内容。它使用一个只有短名称（用于 URL）、标题和正文的表格。这是simple_pages/__init__.py：

from flask import Blueprint, render_template
from .models import Page

flat_pages = Blueprint('flat_pages', __name__, template_folder='templates')

@flat_pages.route('/<page>')
def show(page):
    page_object = Page.query.filter_by(name=page).first()
    return render_template('pages/{}.html'.format(page), page=page_object)

然后，最好让这个蓝图定义它自己的模型（this in simple_page/models.py）：

# TODO Somehow get ahold of a `db` instance without referencing the app
# I might get used in!

class Page(db.Model):
    name = db.Column(db.String(255), primary_key=True)
    title = db.Column(db.String(255))
    content = db.Column(db.String(255))

    def __init__(self, name, title, content):
        self.name = name
        self.title = title
        self.content = content

这个问题与：

和其他各种，但所有回复似乎都依赖于导入应用程序的db实例，或者做相反的事情。“ Large app how to” wiki 页面也使用了“import your app in your blueprint”模式。

* 由于官方文档显示了如何在蓝图中创建路线、视图、模板和资产，而不关心它“在”什么应用程序，我假设蓝图通常应该可以跨应用程序重用。然而，如果没有独立的模型，这种模块化似乎并没有那么有用。

既然蓝图可以多次挂接到应用程序中，那么在蓝图中拥有模型可能只是错误的方法？

4

3 回答 3

41

我相信最真实的答案是模块化蓝图不应该直接关注数据访问，而是依赖于提供兼容实现的应用程序。

因此，鉴于您的示例蓝图。

from flask import current_app, Blueprint, render_template

flat_pages = Blueprint('flat_pages', __name__, template_folder='templates')

@flat_pages.record
def record(state):
    db = state.app.config.get("flat_pages.db")

    if db is None:
        raise Exception("This blueprint expects you to provide "
                        "database access through flat_pages.db")

@flat_pages.route('/<page>')
def show(page):
    db = current_app.config["flat_pages.db"]
    page_object = db.find_page_by_name(page)
    return render_template('pages/{}.html'.format(page), page=page_object)

由此，没有什么可以阻止您提供默认实现。

def setup_default_flat_pages_db(db):
    class Page(db.Model):
        name = db.Column(db.String(255), primary_key=True)
        title = db.Column(db.String(255))
        content = db.Column(db.String(255))

        def __init__(self, name, title, content):
            self.name = name
            self.title = title
            self.content = content

    class FlatPagesDBO(object):
        def find_page_by_name(self, name):
            return Page.query.filter_by(name=name).first()

    return FlatPagesDBO()

并在您的配置中。

app.config["flat_pages.db"] = setup_default_flat_pages_db(db)

通过不依赖从 db.Model 的直接继承而只使用来自 sqlalchemy 的 vanilla declarative_base，可以使上述内容变得更简洁，但这应该代表它的要点。

于 2012-11-17T16:22:06.123 回答
7

我有使蓝图完全模块化并且不参考应用程序的类似需求。我想出了一个可能干净的解决方案，但我不确定它有多正确以及它的局限性是什么。

这个想法是在蓝图中创建一个单独的db对象 ( ) 并从创建根应用程序的位置调用和方法。db = SQLAlchemy()init_app()create_all()

下面是一些示例代码来展示项目的结构： 调用应用程序并调用jobs蓝图，status并将其存储在蓝图文件夹中。

blueprints.status.models.py

from flask_sqlalchemy import SQLAlchemy
db = SQLAlchemy()  # <--- The db object belonging to the blueprint

class Status(db.Model):
    __tablename__ = 'status'
    id = db.Column(db.Integer, primary_key=True)
    job_id = db.Column(db.Integer)
    status = db.Column(db.String(120))

models.py

from flask_sqlalchemy import SQLAlchemy
db = SQLAlchemy()  # <--- The db object belonging to the root app

class Job(db.Model):
    __tablename__ = 'job'
    id = db.Column(db.Integer, primary_key=True)
    state = db.Column(db.String(120)

factory.py

from .blueprints.status.models import db as status_db  # blueprint db
from .blueprints.status.routes import status_handler   # blueprint handler
from .models import db as root_db                      # root db
from flask import Flask

def create_app():
    app = Flask(__name__)

    # Create database resources.
    app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:////path/to/app.db'
    root_db.init_app(app)
    status_db.init_app(app)     # <--- Init blueprint db object.
    with app.app_context():
        root_db.create_all()
        status_db.create_all()  # <--- Create blueprint db.

    # Register blueprint routes.
    app.register_blueprint(status_handler, url_prefix="/status")

    return app

我gunicorn用gevent工人对其进行了测试，并且可以正常工作。我在这里问了一个关于解决方案稳健性的单独问题： 为每个蓝图创建一个 SQLAlchemy 实例并多次调用 create_all

于 2017-12-24T23:29:06.683 回答
0

您问“蓝图不应该独立于应用程序并且可以再分发（à la Django 应用程序）吗？”

答案是肯定的。蓝图与 Django App 不同。

如果您想使用不同的应用程序/配置，那么您需要使用“应用程序调度”而不是蓝图。阅读本文 [1]： http: //flask.pocoo.org/docs/patterns/appdispatch/#app-dispatch [1]

此外，这里的链接 [1] http://flask.pocoo.org/docs/blueprints/#the-concept-of-blueprints [1]

它清楚地表明，我引用“Flask 中的蓝图不是可插入的应用程序，因为它实际上不是应用程序——它是一组可以在应用程序上注册的操作，甚至可以多次注册。为什么不拥有多个应用程序对象？你可以这样做（请参阅应用程序调度），但您的应用程序将具有单独的配置，并将在 WSGI 层进行管理。”

于 2012-10-25T20:37:54.470 回答