Wagtail升级至4.0.4后，Callable ChoiceBlock无法保存表单及获取formFields求助

你遇到的核心问题是：ChoiceBlock仅保存选中项的字符串值（即表单ID），不会自动将其转换为Form模型实例，也无法在API中自动序列化出表单的相关数据，而你原来的ChooserBlock是自定义了to_python、value_from_form等方法来处理实例的转换与存储。

最优解决方案：使用ModelChoiceBlock替代ChoiceBlock #

Wagtail 4.x 提供了ModelChoiceBlock，这是专门用于选择模型实例的内置Block，完全可以替代你原来的自定义ChooserBlock，无需手动处理实例转换与存储逻辑。

代码修改步骤：

1. 导入ModelChoiceBlock：

from wagtail.blocks import ModelChoiceBlock

2. 修改WagtailFormBlock中的form字段：

class WagtailFormBlock(blocks.StructBlock):
    # 替换原来的ChoiceBlock为ModelChoiceBlock
    form = ModelChoiceBlock(
        model=Form,  # 指定关联的表单模型
        required=False,
        label="选择表单",
        # 自定义下拉列表显示的文本（可选，默认用模型的__str__方法）
        label_func=lambda form_obj: form_obj.title
    )
    form_action = blocks.CharBlock(
        required=False,
        help_text=_('表单提交地址，留空或填"."表示当前页面，也可填外部URL')
    )
    form_reference = InfoBlock(
        required=False,
        help_text=_("表单保存后会自动生成唯一标识")
    )

    # 保持StructBlock的元类配置不变
    class Meta:
        icon = "form"

为什么原来的ChoiceBlock方案无效？ #

• ChoiceBlock的本质是存储字符串值（你返回的(form.id, form.title)中的第一个元素），不会自动将ID转换为Form实例。当你从StreamField中读取值时，得到的只是字符串ID，而非Form对象，这就导致API序列化时只能输出ID，无法关联到表单的具体数据。
• 而ModelChoiceBlock内置了以下逻辑：
  • 后台渲染时自动从Form模型拉取所有实例作为下拉选项
  • 保存时自动将选中的Form实例转换为ID存储到数据库
  • 加载时自动通过ID查询数据库返回Form实例
  • API序列化时，默认会输出实例的ID，若需要更多字段，可通过自定义get_api_representation方法扩展

若坚持使用ChoiceBlock的兼容方案 #

如果你因特殊需求必须使用ChoiceBlock，需要自定义Block来处理值的转换与API序列化：

from wagtail.blocks import ChoiceBlock
from .models import Form  # 导入你的Form模型

def getFormblockChoices():
    return [(str(form.id), form.title) for form in Form.objects.all()]

class FormChoiceBlock(ChoiceBlock):
    def get_prep_value(self, value):
        # 将Form实例转换为ID字符串用于存储
        if isinstance(value, Form):
            return str(value.id)
        return value

    def to_python(self, value):
        # 将存储的ID字符串转换为Form实例
        if not value:
            return None
        try:
            return Form.objects.get(pk=value)
        except Form.DoesNotExist:
            return None

    def get_api_representation(self, value, context=None):
        # 自定义API返回的字段
        if not value:
            return None
        return {
            "id": value.id,
            "title": value.title,
            # 添加你需要暴露的其他字段
        }

# 然后在WagtailFormBlock中使用：
class WagtailFormBlock(blocks.StructBlock):
    form = FormChoiceBlock(choices=getFormblockChoices, required=False)
    # 其他字段保持不变

注意事项 #

• 确保Form模型已正确注册到Wagtail后台，且当前用户有权限访问这些表单实例
• 若使用ModelChoiceBlock，下拉选项会在后台页面刷新时重新查询数据库，新增表单后刷新页面即可看到新选项

内容的提问来源于stack exchange，提问作者rucha