wagtail - 无法使模型 @property def-as-field 与 wagtail 2.0 一起使用

Question

我正在使用 Wagtail 2.0 和具有以下代码的自定义 block :

class LinkButtonBlock(blocks.StructBlock):
    label = blocks.CharBlock()
    URL = blocks.CharBlock()
    styling = blocks.ChoiceBlock(
        choices=[
            ('btn-primary', 'Primary button'),
            ('btn-secondary', 'Secondary button'),
            ('btn-success', 'Success button'),
            ('btn-info', 'Info button'),
            ('btn-warning', 'Warning button'),
            ('btn-error', 'Error button'),
        ],
        default='btn-info',
    )
    outline = blocks.BooleanBlock(
        default=False
    )

    @property
    def css(self):
        btn_class = self.styling
        if self.outline is True:
            btn_class = btn_class.replace('btn-', 'btn-outline-')
            return btn_class

    class Meta:
        icon = 'link'
         template = 'testapp/blocks/link_button_block.html'

如果我随后尝试在模板中访问此 css“属性”，似乎什么也没有发生。将 print(self) 作为 css def 内的第一行也会在控制台上显示任何内容，表明该函数甚至从未被调用。

使用以下模板:

{% load wagtailcore_tags %}

<a class="btn {{ block.value.css }}" href="{{ block.value.URL }}">{{ block.value.label }}</a>

简单的 yield :

<a class="btn " href="actual.url.from.instance">actual.label.from.instance</a>

此外，block.value.styling 和 block.value.outline 本身工作得很好，所以......我在这里做错了什么？

Answer 1

让您困惑的是，迭代 StreamField 时获得的值对象不是 StructBlock 的实例。 StructBlock 和 CharBlock 等 block 对象充当不同数据表示之间的转换器；他们本身并不保留数据。在这方面，它们的工作方式很像 Django 的表单字段对象；例如，Django 的 forms.CharField 和 Wagtail 的 CharBlock 都定义了如何将字符串呈现为表单字段，以及如何从表单提交中检索字符串。

请注意，CharBlock 适用于字符串对象，而不是 CharBlock 的实例。同样，从 StructBlock 返回的值不是 StructBlock 的实例 - 它们是 StructValue 类型的类似字典的对象，并且 this 是您需要子类化来实现 css 属性的内容。 the docs中有一个这样做的例子。应用于您的代码，这将变成:

class LinkButtonValue(blocks.StructValue):
    @property
    def css(self):
        # Note that StructValue is a dict-like object, so `styling` and `outline`
        # need to be accessed as dictionary keys
        btn_class = self['styling']
        if self['outline'] is True:
            btn_class = btn_class.replace('btn-', 'btn-outline-')
        return btn_class

class LinkButtonBlock(blocks.StructBlock):
    label = blocks.CharBlock()
    URL = blocks.CharBlock()
    styling = blocks.ChoiceBlock(choices=[...])
    outline = blocks.BooleanBlock(default=False)

    class Meta:
        icon = 'link'
        template = 'testapp/blocks/link_button_block.html'
        value_class = LinkButtonValue