Wagtail：向包含子Struct Block的Struct Block传递参数以动态加载Choice Block选项失败问题排查

你的问题根源在于没有正确遵循Wagtail Block的初始化机制——直接在__init__方法中重新赋值block实例属性（比如self.template或者self.default_theme）并不会生效，因为Wagtail是通过fields字典来管理Block的子字段的。下面是具体的错误分析和修复代码：

错误点分析 #

1. 子StructBlock的初始化错误：在DefaultThemeTemplate这类子StructBlock中，你直接创建了一个新的ChoiceBlock并赋值给self.template，但Wagtail会优先使用类定义时声明的fields字典中的字段，而不是你在__init__中替换的实例属性。
2. 父StructBlock的初始化错误：Templates类中同样直接替换了self.default_theme等属性，这同样不会更新Wagtail内部管理的字段集合，导致传递的folder参数根本没有生效到子Block中。

修复后的代码 #

第一步：修正子StructBlock的逻辑 #

对于每个主题模板StructBlock，我们需要在__init__中获取已有的template字段，并更新它的choices属性，而不是重新创建一个新的ChoiceBlock：

class DefaultThemeTemplate(blocks.StructBlock):
    template = blocks.ChoiceBlock(choices=[], label=_('Select a template'), required=False)
    
    def __init__(self, folder=None, **kwargs):
        super().__init__(**kwargs)
        # 从fields字典中获取已声明的template字段，更新它的choices
        if folder:
            self.fields['template'].choices = get_designs(folder)
    
    class Meta:
        label = _('Default Theme')

class ThemeOneTemplate(blocks.StructBlock):
    template = blocks.ChoiceBlock(choices=[], label=_('Select a template'), required=False)
    
    def __init__(self, folder=None, **kwargs):
        super().__init__(**kwargs)
        if folder:
            self.fields['template'].choices = get_designs(folder)
    
    class Meta:
        label = _('Theme One')

class ThemeTwoTemplate(blocks.StructBlock):
    template = blocks.ChoiceBlock(choices=[], label=_('Select a template'), required=False)
    
    def __init__(self, folder=None, **kwargs):
        super().__init__(**kwargs)
        if folder:
            self.fields['template'].choices = get_designs(folder)
    
    class Meta:
        label = _('Theme Two')

第二步：修正父StructBlock的逻辑 #

在Templates类中，我们需要在初始化时，为每个子StructBlock传递folder参数，但要通过fields字典来更新子Block的初始化参数，而不是直接替换实例：

class Templates(blocks.StructBlock):
    default_theme = DefaultThemeTemplate(required=False)
    theme_one = ThemeOneTemplate(required=False)
    theme_two = ThemeTwoTemplate(required=False)
    
    def __init__(self, folder=None, **kwargs):
        super().__init__(**kwargs)
        # 遍历所有子字段，传递folder参数
        for field_name in ['default_theme', 'theme_one', 'theme_two']:
            sub_block = self.fields[field_name]
            # 重新初始化子block，传入folder参数
            self.fields[field_name] = sub_block.__class__(folder=folder, required=sub_block.required)
    
    class Meta:
        label = _('Template')

第三步：保持StaticPage的定义不变 #

你的StaticPage类定义是正确的，不需要修改：

class StaticPage(Page):
    template = StreamField([
        ('template', Templates(required=False, folder='pages'))
    ], null=True, blank=True, verbose_name=_('Template'))

关键说明 #

• 必须先调用super().__init__(**kwargs)，确保Wagtail完成Block的基础初始化工作，再去修改fields字典中的字段属性。
• 对于嵌套的StructBlock，要通过self.fields[field_name]获取对应的子Block实例，然后重新初始化并传递参数，这样才能让子Block接收到folder参数并更新ChoiceBlock的选项。

这样修改后，你的ChoiceBlock就能正确加载get_designs(folder)返回的选项了。

内容的提问来源于stack exchange，提问作者Mahmud Abdur Rahman