向应用程序工厂注册Flask管理员视图的正确方法

时间:2019-02-11 19:51:39

标签: python flask flask-admin flask-migrate

我正在使用应用程序工厂向烧瓶应用程序添加视图,如下所示:

(这不是我的实际应用程序工厂,为简洁起见已将其缩短)

def create_app(config_name='default'):
    app = Flask(__name__, template_folder="templates", static_folder='static')
    admin_instance = Admin(app, name='Admin')
    admin_instance.add_view(EntityAdmin(Entity, db.session))

我的EntityAdmin类看起来像这样:

class EntityAdmin(ModelView):
    column_filters = [
        MyCustomFilter(column=None, name='Custom')
    ]

我的自定义过滤器如下:

class MyCustomFilter(BaseSQLAFilter):
    def get_options(self, view):
        entities = Entity.query.filter(Entity.active == True).all()
        return [(entity.id, entity.name) for entity in entities]

问题在于,似乎在实例化应用程序时调用了get_options函数,每次调用create_app函数时都会运行一个选择查询。

因此,如果我更新数据库架构并运行flask db migrate命令,则会收到一条错误消息,因为在运行选择查询时,我添加的新列不存在。该查询引发错误,因为我的数据库架构与实际数据库不同步。

我只能在发出实际的HTTP请求时注册我的视图吗?如何区分请求和命令?

1 个答案:

答案 0 :(得分:0)

此过滤器还有一个问题:它的选项是在应用程序实例化时创建的,因此,如果您的实体列表在应用程序运行期间发生了更改,它将仍然返回相同的选项列表。

要解决这两个问题,您无需推迟视图注册。您需要过滤器才能在每次使用时获取选项列表。

This SO answer对“在Python中重置生成器对象”问题的描述了一种重用生成器的方法(在您的情况下为数据库查询):

from flask import has_app_context

def get_entities():
    # has_app_context is used to prevent database access
    # when application is not ready yet
    if has_app_context():
        for entity in Entity.query.filter(Entity.active.is_(True)):
            yield entity.id, entity.name

class ReloadingIterator:
    def __init__(self, iterator_factory):
        self.iterator_factory = iterator_factory

    def __iter__(self):
        return self.iterator_factory()

class MyCustomFilter(BaseSQLAFilter):
    def get_options(self, view):
        # This will return a generator which is
        # reloaded every time it is used
        return ReloadingIterator(get_entities)

问题在于,在请求期间可以多次调用Entity表的查询。因此,我通常使用Flask globals缓存单个请求的结果:

def get_entities():
    if has_app_context():
        if not hasattr(g, 'entities'):
            query = Entity.query.filter(Entity.active.is_(True))
            g.entities = [(entity.id, entity.name) for entity in query]
        for entity_id, entity_name in g.entities:
            yield entity_id, entity_name