https://hirotoshimizu.github.io/tags/drf/ Recent content in DRF on Shiglass Hugo -- gohugo.io Tue, 13 Jul 2021 23:32:01 +0900 https://hirotoshimizu.github.io/posts/2021-07-14/ Tue, 13 Jul 2021 23:32:01 +0900 https://hirotoshimizu.github.io/posts/2021-07-14/ PrimaryKeyRelatedField PrimaryKeyRelatedField を使用することでリレーションのあるテーブルのプライマリーキーを取得することが出来る。 class StatusSerializer(serializers.ModelSerializer): uri = serializers.SerializerMethodField(read_only=True) user = UserPublicSerializer(read_only=True) user_id = serializers.PrimaryKeyRelatedField(source='user', read_only=True) class Meta: model = Status fields = [ 'uri', 'user_id', 'id', 'user', 'content', 'image' ] read_only_fields = ['user'] "results": [ { "uri": "http://127.0.0.1:8000/api/status/1/", "id": 7, "user_id": 1, "user": { "id": 1, "username": "test", "uri": "http://127.0.0.1:8000/api/user/test/" }, "content": "do some stuff here", "image": "http://127.0.0.1:8000/media/status/test/images.png" }, DRF ドキュメント HyperlinkedRelatedField PrimaryKeyRelatedField を使用することでリレーションのあるテーブルのターゲットのハイパーリンクを取得することが出来る。 class StatusSerializer(serializers.ModelSerializer): uri = serializers.SerializerMethodField(read_only=True) user = UserPublicSerializer(read_only=True) user_id = serializers. https://hirotoshimizu.github.io/posts/2021-07-12/ Sun, 11 Jul 2021 06:49:02 +0900 https://hirotoshimizu.github.io/posts/2021-07-12/ Authenticating users authenticate(request=None, **credentials) authenticate() は認証の承認のために使用する関数。 デフォルトでは keyword arguments で username と password で認証し、 User オブジェクトを返す。 set_password(raw_password) パスワードをハッシュ化するのに使う。 https://hirotoshimizu.github.io/posts/2021-07-11/ Fri, 09 Jul 2021 23:37:25 +0900 https://hirotoshimizu.github.io/posts/2021-07-11/ python での JSON の扱いについてわすれるのでメモ。 json.dumps json.dumps()に入れた変数を JSON string に変換する。 >>> import json >>> data = {'abc': 123} >>> type(data_json) <class 'str'> >>> data_json = json.dumps(data) >>> data_json '{"abc": 123}' json.loads json.loads(JSON string) で python dictionary に型を変換する。 >>> import json >>> data = {'abc': 123} >>> type(data_json) <class 'str'> >>> data_json = json.dumps(data) >>> data_json '{"abc": 123}' >>> load_json = json.loads(data_json) >>> load_json {'abc': 123} >>> type(load_json) <class 'dict'> >>> load_json['abc'] 123 Django Rest Framework https://hirotoshimizu.github.io/posts/2021-07-08/ Thu, 08 Jul 2021 08:04:28 +0900 https://hirotoshimizu.github.io/posts/2021-07-08/ DRFでオブジェクトを作成したとき、 デフォルトで、 作成したオブジェクトを含むディクショナリー型でデータを返す。 keys() Pythonの組み込み関数。 keys() dict = {"A": "Abalone", "B": "bluefin tuna", "C": "cod"} print(dict.keys()) >>>dict_keys(['A', 'B', 'C']) dict = {"A": "Abalone", "B": "bluefin tuna", "C": "cod"} for key in dict.keys(): print(key) >>>A >>>B >>>C getattr Pythonの組み込み関数。 getattr(object, name[,default]) 第一引数に指定された object の値を返す。 第二引数の name は文字列である必要があり、文字列が object の属性の一つの名前であった場合、戻り値はその属性の値になる。 query_params request.GETと同義語。 DRF では query_params を使用することを推奨。 DRF ドキュメント https://hirotoshimizu.github.io/posts/django-rest-framework/ Wed, 07 Jul 2021 11:51:51 +0900 https://hirotoshimizu.github.io/posts/django-rest-framework/ APIClient APIClientは Djang の Clientクラスを拡張したもの .get()、.post()、.put()、.pathch()、.delete()、.head()、.options()が利用可能。 例 from rest_framework.test import APIClient client = APIClient() client.post('/notes/', {'title': 'new idea'}, format='json') status from rest_framework import status 人間が読むことができるステータスコードを含む。 テストの際に理解が簡単 github refresh_from_db() モデルのバリューをリフレッシュ使うのに使用。 このメソッドが引数なしで呼ばれると モデル上の遅延評価されない全てのフィールドはその時点でデータベース上に存在する値に更新されます。 キャッシュされたリレーションはリロードされたインスタンスに削除される。 Django ドキュメント force_authenticate() テストする際に強制的に認証をリクエストする force_authenticate(request, user=None, token=None)が呼ばれる時 user か token のいずれか、または両方を設定できる。 GenericViewSet GenericViewSet クラスは GenericAPIView の継承し、get_object、get_queryset を提供し、デフォルトでは GenericViewSetクラスを使用するには、クラスをオーバーライドして、必要なmixinクラスをミックスインするか、アクションの実装を明示的に定義します。 DRF ドキュメント ModelSerializer ModelSerializerクラスはSerializer class とモデルの一致するフィールドを自動で作成する ModelSerializer クラスは Serializer と同じだが、 *モデルを基にフィールドを自動で作成する *unique_together のようなserializerのためのvalidatorを自動で作成する *デフォルトで .create() .update() 含む。