准备好最终答案
下面的第一部分是原始答案,完成答案的附加部分附加在末尾。
原答案:存储输入
现在我对自己的问题有了部分解决方案。表单字段以我想要的方式工作,并且输入正确保存到数据库中。仅缺少一个方面:当我打开预先存在的调查的编辑表单时,之前添加到调查的页面不会显示在表单字段中(换句话说,该字段未预先填充) .
如果我自己找到最终解决方案,我将编辑这篇文章。赏金将颁发给首先填补最后空白的任何人。如果您有黄金提示,请提交新答案!
令我惊讶的是,我还不需要对模板做任何事情。诀窍主要在于避免将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,如果您传递正确的构造函数参数,它已经允许多项选择。我已经在这篇文章的底部包含了源代码,以免破坏文本的流动(编辑:这篇文章底部的源代码现在已更新以反映最终答案,这并没有不再使用Select2Widget)。
SurveyView 类的主体包含一个数据库查询,这意味着它需要具有实际数据库连接的应用程序上下文。就我而言,这是一个问题,因为我的 Flask 应用程序是作为具有多个模块和子包的包实现的,并且我避免了循环依赖。我已经通过在我的create_admin 函数中导入包含SurveyView 类的模块来解决它:
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
为了在编辑表单中预填充该字段,我怀疑我需要使用'page_list' 字段设置SurveyView.form_widget_args。到目前为止,我仍然完全不清楚该领域需要做什么。任何帮助仍然非常感谢!
补充:预填充 select2 字段
在flask.ext.admin.model.base.BaseModelView.edit_view 中自动预填充 Flask-Admin 知道如何处理的表单字段。不幸的是,开箱即用它不提供任何挂钩 à la on_model_change 来添加自定义预填充操作。作为一种解决方法,我创建了一个覆盖edit_view 的子类以包含这样的钩子。插入只是一行,这里显示在上下文中:
@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)
# ...
为了不对不使用钩子的模型视图造成问题,派生类显然还必须提供一个无操作作为默认值:
def on_form_prefill (self, form, id):
pass
我已经为这些添加创建了一个补丁,并向 Flask-Admin 项目提交了一个pull request。
然后我可以在我的SurveyView 类中重写on_form_prefill 方法,如下所示:
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()
)
这就是这个问题的这一部分的解决方案。 (在解决方法中,我实际上在 flask.ext.admin.contrib.sqla.ModelView 的子类中定义了 edit_view 的覆盖,因为我需要该类的附加功能,但 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))