web-dev-qa-db-ja.com

Django：Class Based ListViewの検索フォーム

テーブルセットの選択を表示する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))
djangoformslistviewdjango-class-based-viewsclass-based-views
25
neurix

あなたの目標は、フォームの送信に基づいてクエリセットをフィルタリングしようとしていると思います。

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

    def get_queryset(self):
        try:
            name = self.kwargs['name']
        except:
            name = ''
        if (name != ''):
            object_list = self.model.objects.filter(name__icontains = name)
        else:
            object_list = self.model.objects.all()
        return object_list
_

次に、テンプレートとコンテキストをレンダリングするgetメソッドを記述するだけです。

多分最善のアプローチではありません。上記のコードを使用すると、Djangoフォームを定義する必要はありません。

これがどのように機能するかです。クラスベースのビューは、テンプレートのレンダリング、フォームの処理などの方法を分離します。同様に、getはGET応答を処理し、postはPOST応答を処理し、_get_queryset_と_get_object_は自明です。使用可能なメソッドを知る簡単な方法は、シェルを起動して次のように入力します。

_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_を使用することにより、動的なフィルタリングを実行でき、データ/値/情報を使用して、nameから送信されたGETパラメータとその使用可能なパラメータも使用できることを意味しますkwargs、またはこの場合は_self.kwargs["some_key"]_で、ここで_some_key_は指定したパラメーターです

40
Otskimanot Sqilal

検証をフォームに任せるのはいい考えだと思います。これは非常に単純な形式であるため、この特定のケースでは価値がないかもしれません-しかし、より複雑な形式では（そしておそらくあなたの形式も成長するでしょう）、私は次のようにします。

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()
14
jasisz

これは@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>
7
supertramp

これは、一般的なビューのトピック 動的フィルタリング でうまく説明されています。

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()
3
Rohan

フォームに名前フィールドが必要ないために、エラーが発生していると思います。したがって、フォームは有効ですが、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を受信した場合）、問題は前に言ったとおりです。名前フィールドは不要です。

これが機能しない場合はお知らせください！

1
marianobianchi

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
0
Sherd

モデルのすべてのフィールドを検索

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
0
Алексей Степаненко