https://hirotoshimizu.github.io/categories/django/ Recent content in Django on Shiglass Hugo -- gohugo.io Wed, 28 Jul 2021 19:59:35 +0900 https://hirotoshimizu.github.io/posts/2021-07-29/ Wed, 28 Jul 2021 19:59:35 +0900 https://hirotoshimizu.github.io/posts/2021-07-29/ Responses HttpResponse オブジェクトと違い、レンダリングされたコンテンツでResponseオブジェクトをインスタンス化する必要がない。 その代わりにレンダリングされていないデータをパスする必要がある。 Responseクラスで使用されるレンダラーは、Djangoモデルインスタンスなどの複雑なデータ型をネイティブに処理できないため、Responseオブジェクトを作成する前に、データをプリミティブデータ型にシリアル化する必要があります。 REST frameworkのSerializerクラスを使ってこのデータをシリアライズするか、カスタムシリアライザーを使用する。 引数 data : レスポンス用のシリアライズされたデータ status : レスポンス用のステータスコード　デフォルトでは 200 template_name : HTMLRenderer が選択されているならテンプレート名 header : レスポンス用の辞書型 HTTP ヘッダー content_type : レスポンス用のコンテンツタイプ。一般的にコンテンツネゴシエーションのrenderer によって自動的に設定される。しかし、場合によっては明示的にコンテンツタイプを特定する必要もある。 プロジェクトが既にある場合 ユーザーモデルは拡張する。 最初から作成する場合は モデルをオーバーライドして独自のカスタムモデルを作成 カスタムユーザーモデルは https://hirotoshimizu.github.io/posts/2021-07-28/ Tue, 27 Jul 2021 21:51:50 +0900 https://hirotoshimizu.github.io/posts/2021-07-28/ APIView REST frameworkは Djangoの View class のサブクラスである、 APIViewclassを提供する。 APIViewclass は下記のようにView classとは異なる。 handler methods を通ったRequests は REST frameworkの Request インスタンスになり。 Django の HttpRequestインスタンスではない。 handler methods の return は REST frameworkの Responseとなり、 その view は content negotiation と response に一致した renderer を返す。 どの APIException のエクセプションは正しいレスポンスに仲介される。 来るリクエストは認証され、handler methodsに送る前に、 適切な権限やスロットルチェックが行われる。 DRF ドキュメント ViewSet viewSet classは APIViewを継承している。 viewsetで API policy をコントロールするにあたり、 スタンダードの属性であるpermission_classes,authentication_classesが使える。 viewSet classはどのアクションも含んでいないので、 クラスをオーバーライドして明示的に定義する必要がある。 https://hirotoshimizu.github.io/posts/2021-07-19/ Mon, 19 Jul 2021 11:56:10 +0900 https://hirotoshimizu.github.io/posts/2021-07-19/ 今回は restaurants というアプリを作成し進めていきます。 CSVのファイルは管理画面のレストランの一覧画面 http://127.0.0.1:8000/admin/restaurants/restaurant/ からアップ。 アプリの作成 python manage.py startapp restaurants モデルは restaurant で作成。 Admin テンプレートの Override templatesフォルダは manage.py と同じ階層に作成。 templates/admin/restaurants/restaurant/change_list.html を作成 {% extends 'admin/change_list.html' %} {% load static %} {% block content %} <a href="upload-csv/">Upload a csv file</a> {{ block.super }} {% endblock %} {{ block.super }} は親のテンプレートコンテンツ。 Django change_list.html Custom Admin Page の作成 上記で作成したリンク先の upload-csv/ の URL を設定 restaurants/admin.py の RestaurantAdmin で get_urls()を設定。 def get_urls(self): urls = super().get_urls() new_urls = [ path('upload-csv/', self. 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() 含む。