Django中使用Select2的ModelSelect2Widget如何自定义查询集

有两种常用实现方式，可根据你的过滤逻辑是否需要动态上下文选择：

方案1：重写Widget的get_queryset方法（固定过滤规则） #

这是最简单的实现方式，适合不需要请求参数、用户信息等动态上下文的场景，直接在你定义的Widget类中追加get_queryset方法即可：

from .models import Consumidor

class ConsumidorWidget(s2forms.ModelSelect2Widget):
    search_fields = [
        "nome__icontains",
        "email__icontains",
    ]

    def get_queryset(self):
        # 此处自定义你的查询逻辑，示例为仅返回已激活状态的消费者
        return super().get_queryset().filter(is_active=True)

super().get_queryset()默认返回关联模型的全量查询集，你可以在此基础上追加任意ORM过滤、排序等操作。

方案2：结合Form初始化动态传参（需要动态上下文的场景） #

如果你的过滤逻辑需要依赖当前登录用户、请求参数等动态内容，需要额外把上下文传递到Widget中：

1. 首先修改Form的初始化方法，接收并传递上下文参数：

class ConsumoForm(forms.ModelForm):
    mesconsumo = forms.ChoiceField()

    class Meta:
        model = Consumo
        fields = ('id', 'consumidor', 'mesconsumo', 'anoconsumo', 'valorapagar', 'valorhidrometro',
                  'dataleitura', 'datamissao', 'datavencimento', 'foipago',)
        exclude = ('bairro',)
        widgets = {
            "consumidor": ConsumidorWidget,
        }

    def __init__(self, *args, **kwargs):
        # 接收视图传入的request参数
        self.request = kwargs.pop('request', None)
        super().__init__(*args, **kwargs)
        # 将request传递给Select2组件
        self.fields['consumidor'].widget.request = self.request

2. 调整Widget的查询逻辑，使用传入的上下文做过滤：

class ConsumidorWidget(s2forms.ModelSelect2Widget):
    search_fields = [
        "nome__icontains",
        "email__icontains",
    ]

    def get_queryset(self):
        queryset = super().get_queryset()
        # 示例：仅返回当前登录用户所属区域的消费者
        if hasattr(self, 'request'):
            queryset = queryset.filter(region=self.request.user.region)
        return queryset

3. 最后在视图中实例化Form时传入对应的上下文即可：

# 视图示例代码
def create_consumo(request):
    if request.method == 'POST':
        form = ConsumoForm(request.POST, request=request)
        # 后续表单处理逻辑
    else:
        form = ConsumoForm(request=request)
    return render(request, 'consumo_form.html', {'form': form})

注意事项 #

• 重写get_queryset返回的结果模型必须和Widget关联的模型（此处为Consumidor）保持一致
• 你配置的search_fields检索规则会和自定义查询集叠加生效，不会产生冲突

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