flask - 如何处理 Flask-Admin 表单中的有序多对多关系(关联代理)？

Question

我在声明式模型之间存在多对多关系 页面和 调查 ，这是由关联代理介导的，因为页面在调查中出现的顺序很重要，因此交叉链接表有一个额外的字段。

from flask.ext.sqlalchemy import SQLAlchemy
from sqlalchemy.ext.associationproxy import association_proxy
db = SQLAlchemy()

class Page (db.Model):
    id = db.Column(db.Integer, primary_key = True)
    surveys = association_proxy('page_surveys', 'survey')

class Survey (db.Model):
    id = db.Column(db.Integer, primary_key = True)
    pages = association_proxy('survey_pages', 'page')

class SurveyPage (db.Model):
    survey_id = db.Column(db.Integer, db.ForeignKey('survey.id'), primary_key = True)
    page_id = db.Column(db.Integer, db.ForeignKey('page.id'), primary_key = True)
    ordering = db.Column(db.Integer)  # 1 means "first page"
    survey = db.relationship('Survey', backref = 'survey_pages')
    page = db.relationship('Page', backref = 'page_surveys')

现在我想通过 Flask-Admin 提供一个表单，让用户将页面添加到调查中。理想情况下，用户在表单中填写页面的顺序决定了 SurveyPage.ordering 的值。 .这不起作用(无法呈现表单，请参阅帖子底部的最后一点回溯):

from flask.ext.admin.contrib.sqla import ModelView
from flask.ext.admin import Admin

admin = Admin(name='Project')

class SurveyView (ModelView):
    form_columns = ('pages',)
    def __init__ (self, session, **kwargs):
        super(SurveyView, self).__init__(Survey, session, name='Surveys', **kwargs)

admin.add_view(SurveyView(db.session))

这有效，但它没有做我想要的(它让我将 SurveyPage 对象与调查相关联，但我必须在单独的表单中编辑 ordering 字段):

class SurveyView (ModelView):
    form_columns = ('survey_pages',)
    # ...

我知道我可能不得不通过覆盖 sqla.ModelView.form_rules 来进行一些黑客攻击。以及在继承自 admin/model/create.html 的模板中插入一些 HTML 和 Javascript等。不幸的是，我对 Flask-Admin 的经验很少，所以弄清楚如何自己解决这个问题会花费太多时间。更糟糕的是，文档和示例代码似乎没有涵盖基础知识之外的内容。帮助将不胜感激!

来自失败表单的最后一点回溯:

File ".../python2.7/site-packages/flask_admin/contrib/sqla/form.py", line 416, in find
raise ValueError('Invalid model property name %s.%s' % (model, name))

ValueError: Invalid model property name <class 'project.models.Survey'>.pages

Answer 1

最终答案准备就绪

下面的第一部分是原始答案，完成答案的补充附在最后。

原始答案:存储输入

到目前为止，我对自己的问题有了部分解决方案。表单字段以我想要的方式工作，并且输入正确保存到数据库中。只缺少一个方面:当我打开预先存在的调查的编辑表单时，先前添加到调查的页面不会显示在表单字段中(换句话说，该字段未预填充) .

如果我自己找到最终解决方案，我会编辑这篇文章。奖金将颁发给首先填补最后空白的任何人。如果您有黄金提示，请提交新答案!

令我惊讶的是，我还不需要对模板做任何事情。诀窍主要在于避免 Survey.pages 和 Survey.survey_pages 作为表单列，而是使用不同的名称作为具有自定义表单字段类型的“额外”字段。这是 SurveyView 类的新版本:

class SurveyView (ModelView):
    form_columns = ('page_list',)
    form_extra_fields = {
        # 'page_list' name chosen to avoid name conflict with actual properties of Survey
        'page_list': Select2MultipleField(
            'Pages',
             # choices has to be an iterable of (value, label) pairs
             choices = db.session.query(Page.id, Page.name).all(),
             coerce = int ),
    }

    # handle the data submitted in the form field manually
    def on_model_change (self, form, model, is_created = False):
        if not is_created:
            self.session.query(SurveyPage).filter_by(survey=model).delete()
        for index, id in enumerate(form.page_list.data):
            SurveyPage(survey = model, page_id = id, ordering = index)

    def __init__ (self, session, **kwargs):
        super(SurveyView, self).__init__(Survey, session, name='Surveys', **kwargs)

Select2MultipleField 是 flask.ext.admin.form.fields.Select2Field 的变体，我通过简单地复制粘贴和修改代码对其进行了调整。我很感激地使用 flask.ext.admin.form.widgets.Select2Widget，如果您传递正确的构造函数参数，它已经允许进行多项选择。我在这篇文章的底部包含了源代码，以免打乱文本的流向(编辑:这篇文章底部的源代码现在已更新以反射(reflect)最终答案，该答案不使用 Select2Widget不再)。
SurveyView 类的主体包含一个数据库查询，这意味着它需要具有实际数据库连接的应用程序上下文。就我而言，这是一个问题，因为我的 Flask 应用程序是作为具有多个模块和子包的包实现的，并且我避免了循环依赖。我通过在我的 SurveyView 函数中导入包含 create_admin 类的模块解决了这个问题:

from ..models import db

def create_admin (app):
    admin = Admin(name='Project', app=app)
    with app.app_context():
        from .views import SurveyView
    admin.add_view(SurveyView(db.session))
    return admin

为了在编辑表单中预先填充该字段，我怀疑我需要使用 SurveyView.form_widget_args 字段设置 'page_list'。到目前为止，我仍然完全不清楚该领域需要什么。任何帮助仍然非常感谢!

添加:预填充 select2 字段

Flask-Admin 知道如何处理的表单字段的自动预填充在 flask.ext.admin.model.base.BaseModelView.edit_view 中完成。不幸的是，开箱即用它没有提供任何钩子(Hook) à la on_model_change 来添加自定义预填充操作。作为一种解决方法，我创建了一个覆盖 edit_view 的子类以包含这样一个钩子(Hook)。插入只是一行，在上下文中显示:

    @expose('/edit/', methods=('GET', 'POST'))
    def edit_view(self):
        # ...

        if validate_form_on_submit(form):
            if self.update_model(form, model):
                if '_continue_editing' in request.form:
                    flash(gettext('Model was successfully saved.'))
                    return redirect(request.url)
                else:
                    return redirect(return_url)

        self.on_form_prefill(form, id)  # <-- this is the insertion

        form_opts = FormOpts(widget_args=self.form_widget_args,
                             form_rules=self._form_edit_rules)

        # ...

为了不给不使用钩子(Hook)的模型 View 造成问题，派生类显然也必须提供一个无操作作为默认值:

    def on_form_prefill (self, form, id):
        pass

我为这些添加创建了一个补丁，并向 Flask-Admin 项目提交了一个 pull request。

然后我可以覆盖 on_form_prefill 类中的 SurveyView 方法，如下所示:

    def on_form_prefill (self, form, id):
        form.page_list.process_data(
            self.session.query(SurveyPage.page_id)
            .filter(SurveyPage.survey_id == id)
            .order_by(SurveyPage.ordering)
            .all()
        )

这就是这部分问题的解决方案。 (在解决方法中，我实际上在 edit_view 的子类中定义了 flask.ext.admin.contrib.sqla.ModelView 的覆盖，因为我需要该类的附加功能，但 edit_view 通常仅在 flask.ext.admin.model.base.BaseModelView 中定义。)

然而，此时我发现了一个新问题:当输入完全存储到数据库中时，页面添加到调查中的顺序没有保留。结果是 an issue more people walk into with Select2 multiple fields 。

附加:修复排序

事实证明，如果基础表单字段是 <select> ，则 Select2 无法保留顺序。 Select2 文档建议将 <input type="hidden"> 用于可排序的多选，因此我定义了一个基于 wtforms.widgets.HiddenInput 的新小部件类型并使用它:

from wtforms import widgets

class Select2MultipleWidget(widgets.HiddenInput):
    """
    (...)

    By default, the `_value()` method will be called upon the associated field
    to provide the ``value=`` HTML attribute.
    """

    input_type = 'select2multiple'

    def __call__(self, field, **kwargs):
        kwargs.setdefault('data-choices', self.json_choices(field))
        kwargs.setdefault('type', 'hidden')
        return super(Select2MultipleWidget, self).__call__(field, **kwargs)

    @staticmethod
    def json_choices (field):
        objects = ('{{"id": {}, "text": "{}"}}'.format(*c) for c in field.iter_choices())
        return '[' + ','.join(objects) + ']'

data-* 属性是一种 HTML5 构造，用于在元素属性中传递任意数据。一旦被 JQuery 解析，这些属性就会变成 $(element).data().* 。我在这里使用它来将所有可用页面的列表传输到客户端。

为了确保隐藏的输入字段在页面加载时变得可见并表现得像 Select2 字段，我需要扩展 admin/model/edit.html 模板:

{% extends 'admin/model/edit.html' %}

{% block tail %}
    {{ super() }}

    <script src="//code.jquery.com/ui/1.11.0/jquery-ui.min.js"></script>
    <script>
        $('input[data-choices]').each(function ( ) {
            var self = $(this);
            self.select2({
                data:self.data().choices,
                multiple:true,
                sortable:true,
                width:'220px'
            });
            self.on("change", function() {
                $("#" + self.id + "_val").html(self.val());
            });
            self.select2("container").find("ul.select2-choices").sortable({
                containment: 'parent',
                start: function() { self.select2("onSortStart"); },
                update: function() { self.select2("onSortEnd"); }
            });
        });
    </script>
{% endblock %}

作为一个额外的好处，这使用户能够通过拖放来订购代表所选页面的小部件。

至此，我的问题终于得到了完整的解答。
Select2MultipleField 的代码。我建议您使用 flask.ext.admin.form.fields 运行差异以找到差异。

from wtforms import fields
from flask.ext.admin._compat import text_type, as_unicode

class Select2MultipleField(fields.SelectMultipleField):
    """
        `Select2 <https://github.com/ivaynberg/select2>`_ styled select widget.

        You must include select2.js, form.js and select2 stylesheet for it to
        work.

        This is a slightly altered derivation of the original Select2Field.
    """
    widget = Select2MultipleWidget()

    def __init__(self, label=None, validators=None, coerce=text_type,
                 choices=None, allow_blank=False, blank_text=None, **kwargs):
        super(Select2MultipleField, self).__init__(
            label, validators, coerce, choices, **kwargs
        )
        self.allow_blank = allow_blank
        self.blank_text = blank_text or ' '

    def iter_choices(self):
        if self.allow_blank:
            yield (u'__None', self.blank_text, self.data is [])

        for value, label in self.choices:
            yield (value, label, self.coerce(value) in self.data)

    def process_data(self, value):
        if not value:
            self.data = []
        else:
            try:
                self.data = []
                for v in value:
                    self.data.append(self.coerce(v[0]))
            except (ValueError, TypeError):
                self.data = []

    def process_formdata(self, valuelist):
        if valuelist:
            if valuelist[0] == '__None':
                self.data = []
            else:
                try:
                    self.data = []
                    for value in valuelist[0].split(','):
                        self.data.append(self.coerce(value))
                except ValueError:
                    raise ValueError(self.gettext(u'Invalid Choice: could not coerce {}'.format(value)))

    def pre_validate(self, form):
        if self.allow_blank and self.data is []:
            return

        super(Select2MultipleField, self).pre_validate(form)

    def _value (self):
        return ','.join(map(str, self.data))