更改 Django autocomplete_fields 标签

Question

我正在尝试为autocomplete_fields 中某个类型的所有项目设置自定义标签。

到目前为止，对于下拉列表，人们会使用

...
class CustomDisplay(forms.ModelChoiceField):
    def label_from_instance(self, obj):
        return "Some custom text: {}".format(obj.name)
...
somethings = CustomDisplay(queryset=Something.object.all())
...

但将其与 autocomplete_fields = (somethings,) 一起使用将导致自动完成取消并向我显示带有自定义文本的下拉菜单。

Answer 1

该字段显示普通select 小部件的原因是，当您定义自定义字段时，您没有将小部件设置为AutocompleteSelect。

在您指定autocomplete_fields 的ModelAdmin 类中，导入您的CustomDisplay 和AutocompleteSelect 并添加以下方法：

from django.contrib.admin.widgets import AutocompleteSelect


class YourModelAdmin(admin.ModelAdmin):
    autocomplete_fields = ['something']

    ...

    def formfield_for_foreignkey(self, db_field, request, **kwargs):
        db = kwargs.get('using')

        if db_field.name == 'something':
            return CustomDisplay(queryset=Something.object.all(), widget=AutocompleteSelect(db_field.remote_field, self.admin_site, using=db))
        return super().formfield_for_foreignkey(db_field, request, **kwargs)

只有在您查看现有实例时才会显示自定义文本。当您查看自动完成下拉菜单并选择一个条目时，标签不是从label_from_instance() 生成的，而是从AutocompleteJsonView 内部的一个简单的str() 调用生成的。

因此，假设您只想更改自动完成小部件中的标签（要全面更改标签，您显然只需更改模型__str()__ 方法），您还需要在admin.py 中创建一个自定义类修改AutocompleteJsonView中的get()方法：

from django.contrib.admin.options import AutocompleteJsonView
from django.http import Http404, JsonResponse

class CustomAutocompleteJsonView(AutocompleteJsonView):
    def get(self, request, *args, **kwargs):
        if not self.model_admin.get_search_fields(request):
            raise Http404(
                '%s must have search_fields for the autocomplete_view.' %
                type(self.model_admin).__name__
            )
        if not self.has_perm(request):
            return JsonResponse({'error': '403 Forbidden'}, status=403)

        self.term = request.GET.get('term', '')
        self.paginator_class = self.model_admin.paginator
        self.object_list = self.get_queryset()
        context = self.get_context_data()

        # Replace this with the code below.
        #
        # return JsonResponse({
        #     'results': [
        #         {'id': str(obj.pk), 'text': str(obj)}
        #         for obj in context['object_list']
        #     ],
        #     'pagination': {'more': context['page_obj'].has_next()},
        # })

        return JsonResponse({
            'results': [
                {'id': str(obj.pk), 'text': 'Some custom text: {}'.format(obj.name)}
                for obj in context['object_list']
            ],
            'pagination': {'more': context['page_obj'].has_next()},
    })

现在在自动完成显示结果的 ModelAdmin 类上设置 autocomplete_view（而不是您指定 autocomplete_fields 的 ModelAdmin 类）：

def autocomplete_view(self, request):
    return CustomAutocompleteJsonView.as_view(model_admin=self)(request)

因此，如果您有一个名为 YourModelAdmin 和 autocomplete_fields = ['something'] 的 ModelAdmin 类，您将为您的 Something 模型设置相应的 ModelAdmin 类的 autocomplete_view。