DRFを使用したDjango-filter - 同じルックアップで複数の値を適用するときに 'と'を実行する方法？

Question

これは私が使用しているフィルタセットのやや簡略化した例です。これはDjango Rest FrameworkのDjangoFilterBackendで使用しています。 /api/bookmarks/?title__contains=word1&title__contains=word2にリクエストを送信し、両方の単語を含む結果が返されますが、現在は最初のパラメータは無視され、word2のフィルタのみが無視されます。

ご協力いただければ幸いです。

class BookmarkFilter(django_filters.FilterSet): 

    class Meta: 
     model = Bookmark 
     fields = { 
      'title': ['startswith', 'endswith', 'contains', 'exact', 'istartswith', 'iendswith', 'icontains', 'iexact'], 
     } 

class BookmarkViewSet(viewsets.ModelViewSet): 
    serializer_class = BookmarkSerializer 
    permission_classes = (IsAuthenticated,) 
    filter_backends = (DjangoFilterBackend,) 
    filter_class = BookmarkFilter 
    ordering_fields = ('title', 'date', 'modified') 
    ordering = '-modified' 
    page_size = 10 

Answer 1

主な問題は、複数の値を操作する方法を理解するフィルタが必要なことです。基本的に2つのオプションがあります。

• 使用MultipleChoiceFilter（この場合にはお勧めしません）
• が、これはあなたを保持しながらMultipleChoiceFilter

  class BookmarkFilter(django_filters.FilterSet): 
      title__contains = django_filters.MultipleChoiceFilter(
       name='title', 
       lookup_expr='contains', 
       conjoined=True, # uses AND instead of OR 
       choices=[???], 
      ) 
  
      class Meta: 
       ... 
  

  を使用して

カスタムフィルタクラスを書きますあなたが選択肢のリストを構築しなければならないという問題があります。可能な選択肢を単純化/縮小できるかどうかはわかりませんが、データベースからすべてのタイトルを取り出し、タイトルを別の単語に分割し、重複を削除するセットを作成する必要があるようです。これは、あなたが持っているレコードの数によっては高価な/遅いようです。

カスタムFilter

また、カスタムフィルタクラスを作成することができます - 以下のようなもの：

class MultiValueCharFilter(filters.BaseCSVFilter, filters.CharFilter): 
    def filter(self, qs, value): 
     # value is either a list or an 'empty' value 
     values = value or [] 

     for value in values: 
      qs = super(MultiValueCharFilter, self).filter(qs, value) 

     return qs 


class BookmarkFilter(django_filters.FilterSet): 
    title__contains = MultiValueCharFilter(name='title', lookup_expr='contains') 

    class Meta: 
     ... 

使用（値はカンマで区切られていることに注意してください）：

GET /api/bookmarks/?title__contains=word1,word2 

を

結果：

qs.filter(title__contains='word1').filter(title__contains='word2') 

シンタックスは少し変更されましたが、CSVベースのフィルタでは不要な選択肢を構成する必要はありません。

?title__contains=word1&title__contains=word2構文をサポートすることは、ウィジェットが適切なHTML入力をレンダリングできないため、実際にはサポートされていないことに注意してください。同じname属性を持つ追加のテキスト入力を追加/削除するには、SelectMultiple（選択肢が必要です）を使用するか、クライアント上でjavascriptを使用する必要があります。

---

フィルタとフィルタセットはあまり詳しく説明しませんが、Djangoのフォームの拡張です。 Filter

• は、順番にWidgetを有するフォームFieldを有しています。
• FilterSetは、Filterで構成されています。
• FilterSetは、フィルタのフィールドに基づいて内部フォームを生成します。各フィルタ成分の

責任：

• ウィジェットはdataQueryDictからの生の値を取得します。
• フィールドは、生の値を検証します。
• フィルタは、有効な値を使用して、クエリセットへの呼び出しを構成します（filter()）。

同じフィルタに複数の値を適用するには、複数の値を操作する方法を理解するフィルタ、フィールド、ウィジェットが必要です。

---

カスタムフィルタは、順番に合成フィールドとウィジェットクラスに「コンマ分離=>リスト」機能で混合れ、BaseCSVFilterに混合することによってこれを達成します。

私はCSVのミックスインのソースコードを見てお勧めしますが、要するにたい：

• widgetは、値のリストに入ってくる値を分割します。
• fieldは、「メイン」フィールドクラス（たとえば、CharFieldまたはIntegerFieldなど）の個々の値を検証することによって、値のリスト全体を検証します。このフィールドは、混合されたウィジェットを派生させます。
• filterは、混在したフィールドクラスを派生します。

CSVフィルタは、値リストを受け入れるinおよびrangeルックアップで使用することを目的としていました。この場合、containsには1つの値が必要です。 filter()メソッドは、値の反復処理と個々のフィルタ呼び出しの連鎖によってこれを修正します。

Answer 2

あなたは、このようなカスタムリストフィールドの何かを作成することができます

from django.forms.widgets import SelectMultiple 
from django import forms 

class ListField(forms.Field): 
    widget = SelectMultiple 

    def __init__(self, field, *args, **kwargs): 
     super(ListField, self).__init__(*args, **kwargs) 
     self.field = field 

    def validate(self, value): 
     super(ListField, self).validate(value) 
     for val in value: 
      self.field.validate(val) 

    def run_validators(self, value): 
     for val in value: 
      self.field.run_validators(val) 

    def to_python(self, value): 
     if not value: 
      return [] 
     elif not isinstance(value, (list, tuple)): 
      raise ValidationError(self.error_messages['invalid_list'], code='invalid_list') 
     return [self.field.to_python(val) for val in value] 

とMultipleChoiceFilterを使用してカスタムフィルタを作成します。その後

class ContainsListFilter(django_filters.MultipleChoiceFilter): 
    field_class = ListField 

    def get_filter_predicate(self, v): 
     name = '%s__contains' % self.name 
     try: 
      return {name: getattr(v, self.field.to_field_name)} 
     except (AttributeError, TypeError): 
      return {name: v} 

カスタムフィルタとフィルタセットを作成することができます。

from django.forms import CharField 

class StorageLocationFilter(django_filters.FilterSet): 
    title_contains = ContainsListFilter(field=CharField()) 

を

私のために働く。それがあなたに役立つことを願っています。