django-filter


<p>Django REST Frameworkの<a href="https://django-filter.readthedocs.io/en/stable/">django-filter</a>を使って「記事タイトルのキーワード検索するためのフィルタ機能」を作ろうとしていました。</p>



<p>ところが上手くdjango-filterが動かず少しハマってしまいました。</p>



<p>最終的に今回の場合は、<strong>一箇所の記述を変えるだけで動作した</strong>のですがその時のメモです。</p>



<div id="toc_container" class="no_bullets"><p class="toc_title">目次</p><ul class="toc_list"><li><a href="#django-filter">django-filterが動作しない原因・解決法</a><ul><li><a href="#i">動作しなかったコード</a></li><li><a href="#i-2">修正後コード</a></li></ul></li><li><a href="#i-3">まとめ</a></li></ul></div>
<h2><span id="django-filter">django-filterが動作しない原因・解決法</span></h2>



<p>views内で使用フィルタを指定する<strong><code>filter_class</code>を<code>filterset_class</code>に変更する</strong>ことで動作しました。</p>



<p>つまり原因はこの<strong>views内のフィルタ指定の書き方が間違っていた</strong>みたいです。</p>



<p>ただ、以前作成したサービスでは<code>filter_class</code>でも動作しているので、もしかするとバージョンによる違いなのかもしれません。</p>



<h3><span id="i">動作しなかったコード</span></h3>



<div class="hcb_wrap"><pre class="prism line-numbers lang-python" data-file="models.py" data-lang="Python"><code>class Blog(models.Model):
    title = models.CharField(blank=True, null=True, max_length=255, verbose_name=&#39;タイトル&#39;)
    created_at = models.DateTimeField(auto_now_add=True, blank=True, null=True, verbose_name=&#39;作成日時&#39;)
    updated_at = models.DateTimeField(auto_now=True, blank=True, null=True, verbose_name=&#39;更新日時&#39;)</code></pre></div>



<div class="hcb_wrap"><pre class="prism line-numbers lang-python" data-file="views.pyviews.py" data-lang="Python"><code># 【Blog】リスト取得View
class BlogListView(generics.ListAPIView):
    queryset = Blog.objects.all()       # 1: クエリセット
    permission_classes = (AllowAny,)    # 2: アクセス許可範囲を指定
    serializer_class = BlogSerializer   # 3: 利用するSerializer指定
    filter_class = BlogFilter           # 4: 利用するFilter指定


# 【Blog】シリアライザー
class BlogSerializer(serializers.ModelSerializer):

    class Meta:
        model = Blog
        fields = &#39;__all__&#39;


# 【Blog】フィルタ
class BlogFilter(serializers.ModelSerializer):
    title = filters.CharFilter(name=&quot;title&quot;, lookup_expr=&#39;contains&#39;)

    class Meta:
        model = Blog
        fields = &#39;__all__&#39;</code></pre></div>



<h3><span id="i-2">修正後コード</span></h3>



<div class="hcb_wrap"><pre class="prism line-numbers lang-python" data-file="views.py" data-lang="Python"><code># 【Blog】リスト取得View
class BlogListView(generics.ListAPIView):
    queryset = Blog.objects.all()       # 1: クエリセット
    permission_classes = (AllowAny,)    # 2: アクセス許可範囲を指定
    serializer_class = BlogSerializer   # 3: 利用するSerializer指定
    filterset_class = BlogFilter        # 【修正箇所】4: 利用するFilter指定


# 【Blog】シリアライザー
class BlogSerializer(serializers.ModelSerializer):

    class Meta:
        model = Blog
        fields = &#39;__all__&#39;


# 【Blog】フィルタ
class BlogFilter(serializers.ModelSerializer):
    title = filters.CharFilter(name=&quot;title&quot;, lookup_expr=&#39;contains&#39;)

    class Meta:
        model = Blog
        fields = &#39;__all__&#39;</code></pre></div>



<h2><span id="i-3">まとめ</span></h2>



<p>やっぱり常に公式ドキュメントを見る癖をつけないといけないですね。</p>



<p>あと他環境で<code>filter_class</code>が動作して、今回は動作しなかった詳しい原因がわからないままですが、<strong>バージョン管理の重要さ</strong>についても実感することができました。</p>



<ul class="references"><li><a href="https://django-filter.readthedocs.io/en/stable/guide/usage.html">Getting Started — django-filter 22.1 documentation</a></li></ul>


「django-filter」の記事一覧