Django：基于类的 ListView 中的搜索表单

Question

我正在尝试实现一个Class Based ListView，它显示一个表集的选择。如果第一次请求该站点，则应显示数据集。我更喜欢 POST 提交，但 GET 也可以。

这是一个问题，使用 function based views 很容易处理，但是对于基于类的视图，我很难理解。

我的问题是我得到了各种各样的错误，这是由于我对基于分类的视图的理解有限造成的。我已阅读各种文档，并且了解直接查询请求的视图，但是一旦我想向查询语句添加表单，就会遇到不同的错误。对于下面的代码，我收到了ValueError: Cannot use None as a query value。

根据表单条目（否则选择整个数据库），基于类的 ListView 的最佳实践工作流程是什么？

这是我的示例代码：

models.py

class Profile(models.Model):
    name = models.CharField(_('Name'), max_length=255)

    def __unicode__(self):
        return '%name' % {'name': self.name}

    @staticmethod
    def get_queryset(params):

        date_created = params.get('date_created')
        keyword = params.get('keyword')
        qset = Q(pk__gt = 0)
        if keyword:
            qset &= Q(title__icontains = keyword)
        if date_created:
            qset &= Q(date_created__gte = date_created)
        return qset

forms.py

class ProfileSearchForm(forms.Form):
    name = forms.CharField(required=False)

views.py

class ProfileList(ListView):
    model = Profile
    form_class = ProfileSearchForm
    context_object_name = 'profiles'
    template_name = 'pages/profile/list_profiles.html'
    profiles = []


    def post(self, request, *args, **kwargs):
        self.show_results = False
        self.object_list = self.get_queryset()
        form = form_class(self.request.POST or None)
        if form.is_valid():
            self.show_results = True
            self.profiles = Profile.objects.filter(name__icontains=form.cleaned_data['name'])
        else:
            self.profiles = Profile.objects.all()
        return self.render_to_response(self.get_context_data(object_list=self.object_list, form=form))

    def get_context_data(self, **kwargs):
        context = super(ProfileList, self).get_context_data(**kwargs)
        if not self.profiles:
            self.profiles = Profile.objects.all()
        context.update({
            'profiles': self.profiles
        })
        return context

下面我添加了完成这项工作的 FBV。 如何将此功能转换为 CBV？ 在基于函数的视图中似乎很简单，但在基于类的视图中却不是这样。

def list_profiles(request):
    form_class = ProfileSearchForm
    model = Profile
    template_name = 'pages/profile/list_profiles.html'
    paginate_by = 10

    form = form_class(request.POST or None)
    if form.is_valid():
        profile_list = model.objects.filter(name__icontains=form.cleaned_data['name'])
    else:
        profile_list = model.objects.all()

    paginator = Paginator(profile_list, 10) # Show 10 contacts per page
    page = request.GET.get('page')
    try:
        profiles = paginator.page(page)
    except PageNotAnInteger:
        profiles = paginator.page(1)
    except EmptyPage:
        profiles = paginator.page(paginator.num_pages)

    return render_to_response(template_name, 
            {'form': form, 'profiles': suppliers,}, 
            context_instance=RequestContext(request))

Answer 1

我认为您的目标是尝试根据表单提交过滤查询集，如果是这样，请使用 GET ：

class ProfileSearchView(ListView)
    template_name = '/your/template.html'
    model = Person

    def get_queryset(self):
        name = self.kwargs.get('name', '')
        object_list = self.model.objects.all()
        if name:
            object_list = object_list.filter(name__icontains=name)
        return object_list

那么你需要做的就是写一个get方法来渲染模板和上下文。

也许不是最好的方法。通过使用上面的代码，您无需定义 Django 表单。

它是这样工作的：基于类的视图将渲染模板、处理表单等的方式分开。比如，get 处理 GET 响应，post 处理 POST 响应，get_queryset 和 get_object 是不言自明的，等等。了解可用方法的简单方法，启动 shell 并输入：

from django.views.generic import ListView如果你想了解ListView

然后输入dir(ListView)。在那里您可以看到所有定义的方法并访问源代码以了解它。 get_queryset 方法用于获取查询集。为什么不直接这样定义，它也可以：

class FooView(ListView):
    template_name = 'foo.html'
    queryset = Photo.objects.all()  # or anything

我们可以像上面那样做，但是我们不能用那种方法做动态过滤。通过使用get_queryset，我们可以进行动态过滤，使用我们拥有的任何数据/值/信息，这意味着我们也可以使用GET发送的name参数，它在kwargs上可用，或者在这个在self.kwargs["some_key"] 上，some_key 是您指定的任何参数

Answer 2

嗯，我认为将验证留给表单是个好主意。在这种特殊情况下可能不值得，因为它是非常简单的形式 - 但肯定会有更复杂的形式（也许你的也会增长），所以我会做类似的事情：

class ProfileList(ListView):
    model = Profile
    form_class = ProfileSearchForm
    context_object_name = 'profiles'
    template_name = 'pages/profile/list_profiles.html'
    profiles = []


    def get_queryset(self):
        form = self.form_class(self.request.GET)
        if form.is_valid():
            return Profile.objects.filter(name__icontains=form.cleaned_data['name'])
        return Profile.objects.all()

Answer 3

这类似于@jasisz 的方法，但更简单。

class ProfileList(ListView):
    template_name = 'your_template.html'
    model = Profile

    def get_queryset(self):
        query = self.request.GET.get('q')
        if query:
            object_list = self.model.objects.filter(name__icontains=query)
        else:
            object_list = self.model.objects.none()
        return object_list

那么你在html模板上要做的就是：

<form method='GET'>
  <input type='text' name='q' value='{{ request.GET.q }}'>
  <input class="button" type='submit' value="Search Profile">
</form>

Answer 4

这已在 Dynamic filtering 的通用视图主题中得到很好的解释。

您可以通过GET 进行过滤，我认为您不能为此使用POST 方法，因为ListView 不是从编辑混合继承的。

你可以做的是：

urls.py

urlpatterns = patterns('', 
                (r'^search/(\w+)/$', ProfileSearchListView.as_view()),
              )

views.py

class ProfileSearchListView(ListView):
    model = Profile
    context_object_name = 'profiles'
    template_name = 'pages/profile/list_profiles.html'
    profiles = []

    def get_queryset(self):
         if len(self.args) > 0:
               return Profile.objects.filter(name__icontains=self.args[0])
         else:
               return Profile.objects.filter()

Answer 5

我认为您遇到的错误是因为您的表单不需要名称字段。因此，尽管表单有效，但您的 name 字段的cleaned_data 为空。

这些可能是有问题的行：

if form.is_valid():
    self.show_results = True
    self.profiles = Profile.objects.filter(name__icontains=form.cleaned_data['name'])

如果我是你，我会尝试换行：

self.profiles = Profile.objects.filter(name__icontains=form.cleaned_data['name'])

到这里：

self.profiles = Profile.objects.none()

如果您停止接收错误（并且您的模板收到一个空的object_list），那么您遇到的问题就是我之前所说的：不需要名称字段。

如果这不起作用，请告诉我们！

Answer 6

搜索模型中的所有字段

class SearchListView(ItemsListView):

# Display a Model List page filtered by the search query.

def get_queryset(self):
    fields = [m.name for m in super(SearchListView, self).model._meta.fields]
    result = super(SearchListView, self).get_queryset()
    query = self.request.GET.get('q')
    if query:
        result = result.filter(
            reduce(lambda x, y: x | Q(**{"{}__icontains".format(y): query}), fields, Q())
        )
    return result

Answer 7

我认为您最好通过 get_context_data 执行此操作。手动创建 HTML 表单并使用 GET 检索此数据。下面是我写的一个例子。当您提交表单时，您可以使用获取数据通过上下文数据传回。此示例不是根据您的要求量身定制的，但它应该可以帮助其他用户。

def get_context_data(self, **kwargs):
    context = super(Search, self).get_context_data(**kwargs)
    filter_set = Gauges.objects.all()
    if self.request.GET.get('gauge_id'):
        gauge_id = self.request.GET.get('gauge_id')
        filter_set = filter_set.filter(gauge_id=gauge_id)

    if self.request.GET.get('type'):
        type = self.request.GET.get('type')
        filter_set = filter_set.filter(type=type)

    if self.request.GET.get('location'):
        location = self.request.GET.get('location')
        filter_set = filter_set.filter(location=location)

    if self.request.GET.get('calibrator'):
        calibrator = self.request.GET.get('calibrator')
        filter_set = filter_set.filter(calibrator=calibrator)

    if self.request.GET.get('next_cal_date'):
        next_cal_date = self.request.GET.get('next_cal_date')
        filter_set = filter_set.filter(next_cal_date__lte=next_cal_date)

    context['gauges'] = filter_set
    context['title'] = "Gauges "
    context['types'] = Gauge_Types.objects.all()
    context['locations'] = Locations.objects.all()
    context['calibrators'] = Calibrator.objects.all()
    # And so on for more models
    return context