django-rest-frameworkでgroup_byしたい

Question

django-rest-frameworkを使ってリクエストパラメーターで駅テーブルのnameカラムを取得して、それに部分一致した駅名のリストをjsonで返したいです。
部分一致した駅名のリストは返せたのですが、同じ値が出力されており、（駅名を改札口の数の分insertしたので）これをgroup_byやらdistinctやらでnameごとにグループ化したいのですが、どう書けばわからない状況です
なのでその書き方を教えていただきたいです。よろしくお願い申し上げます。

station_api.py

from ..models import station
from ..serializers import stationSerializer
from django.shortcuts import render
from rest_framework import generics
from rest_framework.response import Response


from ..models import station


class stationList(generics.ListCreateAPIView):
    queryset = station.objects.all()
    serializer_class = stationSerializer
     
    
    def get_queryset(self):
        queryset = station.objects.all()
        name = self.request.query_params.get('name', None)
        if name is not None:
            queryset = queryset.filter(name__icontains=name)  
        return queryset

Comments

[nerianighthawk]

出来ていることとやりたいことをもう少し詳しくお聞きしたいのですが、
今出来ているものだと「原」で部分一致をかけて
["原宿", "原宿", "秋葉原", "秋葉原", "秋葉原", …]
のように改札の数分出てしまうと言ったイメージでいいですか？
そしてそれを1つずつにするもしくは2重のリストにしたいということでしょうか？

[jomaboy]

そうです！
なので["原宿", "秋葉原"]のように１つずつにしたいです！
お手数ですが、よろしくお願いします

Answer 1

上記やり方ではquerysetで取得しているものはモデルのため、setのコンストラクタでは一致判定してくれませんでした。忘れてください。
querysetでdistinct関数を使うことで重複削除できるようです。
実際に書くと以下のようになるかと思います。

    def get_queryset(self):
        queryset = station.objects.all()
        name = self.request.query_params.get('name', None)
        if name is not None:
            queryset = queryset.filter(name__icontains=name).distinct('name')  
        return queryset

このように書くことでnameが一致しているモデルは重複削除して返してくれるかと思います。

Comments

[jomaboy]

やってみたのですが、
'stationSerializer' object is not callableというエラーが出ました、、、

[jomaboy]

```
def get_queryset(self):
queryset = station.objects.all()
name = self.request.query_params.get('name', None)
if name is not None:
queryset = queryset.filter(name__icontains=name).distinct('name')
return queryset
```

[nerianighthawk]

私の環境で試そうとしたところ、DBが対応していないと言われました。
どうやら distinct の引数に入れて distinct on として使えるのは Postgres だけのようです。
全く同じではないですが、ちょっと似たような物を作成して、私の環境で検証したところ
```
queryset = queryset.filter(name__icontains=name).values('name').distinct()
```
でできましたが、どうですか？
エラー内容が私と違うので、もしかしたら別の要因かもしれませんが…

[nerianighthawk]

紛らわしい書き方をした気がするので、補足ですが、`distinct`は引数無しであれば Postgres ではなくても扱えます。

[jomaboy]

変わらず、同じエラーがでました、、、
お手数おかけしてすみません、、

[nerianighthawk]

こちらこそ、ちゃんと解決出来ずすみません。
エラーは何行目で出た等わかりますか？

[jomaboy]

get_querysetメソッドを消しても同じエラー出ちゃいました、、
どこもいじったつもりはないのですが、、
stationSerializerはちゃんと定義してあるしimportもしているのですが、、

[nerianighthawk]

エラーメッセージの上に行数とか書いてないですか？
```
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
TypeError: 'stationSerializer' object is not callable
```
こんな感じじゃないですか？

[jomaboy]

書いてないです、、、

Internal Server Error: /api/v1/station_api/station_list/
Traceback (most recent call last):
File "/Users/imaijoma/.local/share/virtualenvs/nomad-cafe-backend-ZlR-gHYT/lib/python3.7/site-packages/django/core/handlers/exception.py", line 34, in inner
response = get_response(request)
File "/Users/imaijoma/.local/share/virtualenvs/nomad-cafe-backend-ZlR-gHYT/lib/python3.7/site-packages/django/core/handlers/base.py", line 115, in _get_response
response = self.process_exception_by_middleware(e, request)
File "/Users/imaijoma/.local/share/virtualenvs/nomad-cafe-backend-ZlR-gHYT/lib/python3.7/site-packages/django/core/handlers/base.py", line 113, in _get_response
response = wrapped_callback(request, *callback_args, **callback_kwargs)
File "/Users/imaijoma/.local/share/virtualenvs/nomad-cafe-backend-ZlR-gHYT/lib/python3.7/site-packages/django/views/decorators/csrf.py", line 54, in wrapped_view
return view_func(*args, **kwargs)
File "/Users/imaijoma/.local/share/virtualenvs/nomad-cafe-backend-ZlR-gHYT/lib/python3.7/site-packages/django/views/generic/base.py", line 71, in view
return self.dispatch(request, *args, **kwargs)
File "/Users/imaijoma/.local/share/virtualenvs/nomad-cafe-backend-ZlR-gHYT/lib/python3.7/site-packages/rest_framework/views.py", line 505, in dispatch
response = self.handle_exception(exc)
File "/Users/imaijoma/.local/share/virtualenvs/nomad-cafe-backend-ZlR-gHYT/lib/python3.7/site-packages/rest_framework/views.py", line 465, in handle_exception
self.raise_uncaught_exception(exc)
File "/Users/imaijoma/.local/share/virtualenvs/nomad-cafe-backend-ZlR-gHYT/lib/python3.7/site-packages/rest_framework/views.py", line 476, in raise_uncaught_exception
raise exc
File "/Users/imaijoma/.local/share/virtualenvs/nomad-cafe-backend-ZlR-gHYT/lib/python3.7/site-packages/rest_framework/views.py", line 502, in dispatch
response = handler(request, *args, **kwargs)
File "/Users/imaijoma/.local/share/virtualenvs/nomad-cafe-backend-ZlR-gHYT/lib/python3.7/site-packages/rest_framework/generics.py", line 239, in get
return self.list(request, *args, **kwargs)
File "/Users/imaijoma/.local/share/virtualenvs/nomad-cafe-backend-ZlR-gHYT/lib/python3.7/site-packages/rest_framework/mixins.py", line 45, in list
serializer = self.get_serializer(queryset, many=True)
File "/Users/imaijoma/.local/share/virtualenvs/nomad-cafe-backend-ZlR-gHYT/lib/python3.7/site-packages/rest_framework/generics.py", line 110, in get_serializer
return serializer_class(*args, **kwargs)
TypeError: 'stationSerializer' object is not callable

[nerianighthawk]

generics.py の 110行目ですね。
```
return serializer_class(*args, **kwargs)
```
という記載がダメだと書いてありますが…
serializer_class っていうのは stationSerializer クラスのインスタンスですかね？
インスタンスに引数を渡すことは出来なさそうな気がします。

[jomaboy]

generics.pyというファイルを作成していないのですがデフォルトで入っているのでしょうか？

Answer 2

Djangoのクエリセットでやるやり方もあるかもしれませんが、Pythonのリスト処理でできるので、その方法を記載します。
Pythonにはsetというデータ構造が存在します。
このデータ構造は重複を許さないリストのような構造になっています。
したがって、listをsetのコンストラクタに入れると重複する要素を消したsetが取得できます。
さらにそれをlistのコンストラクタに入れることで、重複要素の無いlistを生成できます。

l = ["原宿", "原宿", "秋葉原", "秋葉原", "秋葉原"]

print(set(l))
# {"原宿", "秋葉原"}

print(list(set(l)))
# ["原宿", "秋葉原"]

Comments

[jomaboy]

このようにやってみたのですが、なにも変わりませんでした。どのように書けばいいのでしょうか？
```
def get_queryset(self):
queryset = station.objects.all()
name = self.request.query_params.get('name', None)
if name is not None:
queryset = queryset.filter(name__icontains=name)
return list(set(queryset))
```

[nerianighthawk]

`queryset = queryset.filter(name__icontains=name)`
この記載だとクエリセットになってしまっていて、リストになっていないような気がします。
Djangoは関数がreturnで返すタイミングでクエリセットのものは勝手にリスト化してくれますが、それはあくまでクエリセットなので、setのコンストラクタに入れてもリストだと判定してくれません。
`queryset = queryset.filter(name__icontains=name).all()`
とすることで、queryset にリストが入ると思うので(変数名は変えた方がいいかもしれません)、出来ると思うのですが…(これで出来ない場合はバージョン等での仕様の違いが発生しているかもしれません)

[jomaboy]

.all()をつけて変数名も変えてみたのですが、変化なしです、、、

[nerianighthawk]

そうですか…
print を使って、queryset の出力を教えていただくことは可能ですか？

[jomaboy]

こんな感じです！
<QuerySet [<station: 新宿>, <station: 新宿>, <station: 新宿>, <station: 新宿>, <station: 新宿>, <station: 新宿>, <station: 新宿>, <station: 新宿>, <station: 新宿三丁目>, <station: 新宿御苑前>, <station: 西新宿>, <station: 西新宿五丁目>]>
<QuerySet [<station: 新宿>, <station: 新宿>, <station: 新宿>, <station: 新宿>, <station: 新宿>, <station: 新宿>, <station: 新宿>, <station: 新宿>, <station: 新宿三丁目>, <station: 新宿御苑前>, <station: 西新宿>, <station: 西新宿五丁目>]>

[nerianighthawk]

すみません、querysetから取得できるのはモデルなので、setのコンストラクタでは一致判定してくれませんでした。
querysetでやるやり方を見つけたので、新しく解答を書きますね。