Recommended
More Related Content
What's hot
What's hot (20)
Similar to 理解して使いこなすDjangoのForm機能(2021 Django Congress発表資料)
Similar to 理解して使いこなすDjangoのForm機能(2021 Django Congress発表資料) (20)
Recently uploaded
Recently uploaded (11)
理解して使いこなすDjangoのForm機能(2021 Django Congress発表資料)
- 9. 9
- 13. 0章.Djangoshellの入り方 $ python manage.py shell ...省略... (InteractiveConsole) >>> 参照できるfield、ヘルプをその場で見れる。 テストコードを書くハードルが下がる. 13
- 14. 0章:Templateへのレンダリングをshellから確認 formの定義 class NameForm(forms.Form): name = forms.CharField() インスタンス化 >>> form = NameForm() 14
- 16. 0章:Templateへのレンダリングをshellから確認 カギカッコのアクセスはドットで行う。 Template上でnameフィールドをレンダリング. {{ form.name }} ↓ <input type="text" name="name" required id="id_name"> shell上で同じことをする場合. 最終的に__str__()される。->printを呼ぶ。 >>> print(form['name']) # []を使ったアクセス <input type="text" name="name" required id="id_name"> 16
- 17. 0章:Templateへのレンダリングをshellから確認 メソッドはコールされる。 Template上でnameフィールドのラベルをレンダリング. {{ form.name.label_tag }} ↓ <label for="id_name">Name:</label> shellで同じことをする場合 最終的に__str__()される。->printを呼ぶ。 >>> print(form['name'].get_label()) # 関数呼び出し <label for="id_name">Name:</label> 17
- 20. 1章.Formを構成する要素 以下のFormを例に説明します。 class MemberForm(forms.Form): name = forms.CharField() # 名前 age = forms.IntegerField() # 年齢 FormにはFieldを定義できる。 Fieldは、デフォルトのwidgetとvalidatorを持っています. 20
- 22. 1章.Formを構成する要素:Widget HTMLを生成するためのクラス. form = MemberForm()) form.fields['name'].widget <django.forms.widgets.TextInput at 0x7fe0fb4b04f0> renderメソッドで、inputタグのようなウィジェットのHTMLを作ります。 form.fields['name'].widget.render('これがname属性', 'これがvalue') '<input type="text" name="これがname属性" value="これがvalue">' 22
- 24. 1章.Formを構成する要素:Validator 受け取った値が条件を満たすかをチェックする. form = MemberForm() form.fields['name'].validators # listに入ってる. [<django.core.validators.ProhibitNullCharactersValidator at 0x7fe0fc0700a0>] 24
- 27. 1章.Formを構成する要素 Form BoundField Field Widget Validator ↓テンプレートでアクセスしているこれです。 {{ form.field_name }} 27
- 29. 1章.Formを構成する要素:BoundFieldとField Field form.fields['name'] <django.forms.fields.CharField at 0x7fecdcbd7fa0> BoundField form['name'] <django.forms.boundfield.BoundField at 0x7fecdc936100> 29
- 35. 2章.フロント編:BoundField BoundFieldはWidgetやErrorListクラスにHTMLレンダリングを任せて いる. BoundFieldをprintすると,widgetによりinputタグがでている print(form['name']) <input type="text" name="name" required> error自体はFormクラスがまとめている。( form.errors ) ul タグの作成は、ErrorListクラスが行っている。 BoundFieldは、Formクラスから自分のFieldに対応するErrorListを取り出すだけ。 print(form['name'].errors) <ul class="errorlist"><li>この項目は必須です。</li></ul> 35
- 36. 2章.フロント編:BoundField BoundFieldはField,Formそれぞれのインスタンス化する時の引数で変更を入れられる. class MemberForm(forms.Form): name = forms.CharField(label='変更したラベル') form = MemberForm(auto_id='変更したID_%s') print(form['name'].label_tag()) <label for="変更したID_name">変更したラベル:</label> 36
- 39. 2章.フロント編:HTMLをレンダリング:Widget https://docs.djangoproject.com/ja/3.2/ref/forms/widgets/ class MemberForm(forms.Form): name = forms.CharField() ↓と同じ. class MemberForm(forms.Form): name = forms.CharField( widget=forms.TextInput, ) 39
- 41. 2章.フロント編:Widgetの差し替え Formの定義 class MemberForm(forms.Form): name = forms.CharField() form['フィールド名'] はBoundFieldです。 これをprintすると、BoundFieldからWidgetのrenderがよばれ,HTMLが作られます。 form = MemberForm() print(form['name']) <input type="text" name="name" required id="id_name"> CharFieldのデフォルトwidget(TextInput)によりinputタグが作成される. 41
- 42. 2章.フロント編:Widgetの差し替え Formの定義 class MemberForm(forms.Form): name = forms.CharField(widget=forms.Textarea) # TexInput-> Textarea form['フィールド名'] はBoundFieldです。 form = MemberForm() print(form['name']) <textarea name="name" cols="40" rows="10" required id="id_name"> </textarea> input->textareaタグに変更された。 42
- 43. 2章.フロント編:Widgetの差し替え HTMLタグのattributeを差し替えることができます。 widgetにはattr引数でdictを渡します。 class MemberForm(forms.Form): name = forms.CharField( # inputタグにclassを設定. widget=forms.TextInput(attrs={'class': 'user-defined-attr'})) form = MemberForm() print(form['name']) # クラスが設定された！ <input type="text" name="name" class="user-defined-attr" required id="id_name"> TextInputwidgetに渡したattrにより、printしたHTMLタグにclass属性が追加されてい る. 43
- 44. 2章.フロント編:Widgetはテンプレートを持つ 例:TextInputクラスのソースコード上の定義 class TextInput(Input): input_type = 'text' template_name = 'django/forms/widgets/text.html' django/forms/widgets.py より抜粋. {% include "django/forms/widgets/input.html" %} /django/forms/templates/django/forms/widgets/text.html より。 44
- 45. 2章.フロント編:Widgetはテンプレートを持つ <input type="{{ widget.type }}" name="{{ widget.name }}"i {% if widget.value != None %} value="{{ widget.value|stringformat:'s' }}" {% endif %} {% include "django/forms/widgets/attrs.html" %}> /django/forms/templates/django/forms/widgets/input.html より改行などを加えて 抜粋。 45
- 47. 2章のまとめ Widgetは <input> のようなFormの部品を定義している。 BoundFieldはField単位のHTMLレンダリングの取りまとめ役. BoundFieldはwidgetやErrorListクラスにおねがい して、タグを丸ごとレンダリングす ることもある. 47
- 49. 3章.バリデーション編:validationの結果 class JslMemberForm(forms.Form): name = forms.CharField() # 名前 age = forms.IntegerField() # 年齢 1.Validation成功->form.cleaned_dataに整形された値が入る. 2.Validation失敗->エラーがform.errorsにまとめられる. 49
- 50. 3章.バリデーション編:validation成功 form.cleaned_data (dict)に「cleanされた」値が入る。 form = JslMemberForm({'name': 'たろう ', 'age': '20'}) form.is_valid() Out[69]: True form.cleaned_data Out[70]: {'name': 'たろう', 'age': 20} nameは後ろのスペースが除去されている ageはint型に変更されている. 50
- 51. 3章.バリデーション編:validation失敗 validationに失敗(エラーが発生)すると、 form.errors にエラーがまとめられる. form = JslMemberForm({'name': '', 'age': 'にじゅっさい'}) form.is_valid() Out[72]: False form.errors Out[73]: {'name': ['This field is required.'], 'age': ['Enter a whole number.']} 51
- 53. 3章.バリデーション編:エラーを構成するクラス form.errors Out[73]: {'name': ['This field is required.'], 'age': ['Enter a whole number.']} 53
- 54. 3章.バリデーション編:ErrorDictクラス print(form.errors) <ul class="errorlist"> <li>name<ul class="errorlist"><li>This field is required.</li></ul></li> <li>age<ul class="errorlist"><li>Enter a whole number.</li></ul></li> </ul> __str__ メソッドでas_ul()を呼ぶようになっており,エラーメッセージのHTMLを作る ※ 一部改行とインデントを加えて表示. 54
- 55. 3章.バリデーション編:ErrorListクラス 再掲 form.errors Out[73]: {'name': ['This field is required.'], 'age': ['Enter a whole number.']} ErrorDictのvalue部分はlistに見えるが、実際はErrorListと言うクラス. form.errors['name'] Out[74]: ['This field is required.'] print(form.errors['name']) <ul class="errorlist"><li>This field is required.</li></ul> __str__ メソッドでas_ul()を呼ぶようになっており,エラーメッセージのHTMLを作る 55
- 56. 3章.バリデーション編:ErrorListクラス ポイント: form['name'] はBoundField. Form._error から自分のFieldに属するエラーを引き出してきている. print(form['name'].errors) <ul class="errorlist"><li>この項目は必須です。</li></ul> BoundFieldのソースコード↓ django/forms/boundfield.py 56
- 57. 3章.バリデーション編:ValidationErrorr例外 form.errors['name'] Out[74]: ['This field is required.'] ErrorListクラスはValidationError例外を保持している. Validationの失敗でraiseされるのは、全てこのValidationError例外. form.errors['name'].data Out[84]: [ValidationError(['This field is required.'])] 57
- 64. 3章.Form.clean():複数Fieldをvalidateする class WorkTimeForm(forms.Form): start_at = forms.DateTimeField() finish_at = forms.DateTimeField() def clean(self): cleaned_data = super().clean() start_at = cleaned_data.get("start_at") finish_at = cleaned_data.get("finish_at") if finish_at and start_at and finish_at <= start_at: raise forms.ValidationError("終了時刻は開始時刻より後にしてください", code='work_time_order') 64
- 65. 3章.Form.clean():複数Fieldをvalidateする form = WorkTimeForm({"start_at": "2020-01-02 08:00:00", "finish_at": "2020-01-01 17:30:00"}) form.errors {'__all__': ['終了時刻は開始時刻より後にしてください']} finish_at<start_atとなるようなデータを渡してerrorsを見ると、エラーが出ている. 特定のFieldに結びついていないため、ErorrsDictのkeyは** __all__ **となっている. 65
- 66. 3章. __all__ keyのエラーはform.non_field_errors() で取得できる. form.non_field_errors() Out[101]: ['終了時刻は開始時刻より後にしてください'] print(form.non_field_errors()) <ul class="errorlist nonfield"><li>終了時刻は開始時刻より後にしてください</li></ul> 66
- 67. 3章.key: __all__ のエラーはform.non_field_errors() で取得できる. テンプレートでは下のように書くと同じ意味になる. {{ form.non_field_error }} ↓ <ul class="errorlist nonfield"><li>終了時刻は開始時刻より後にしてください</li></ul> 67
- 68. 3章.form.add_errorで各Fieldにエラーメッセージをセッ トする https://docs.djangoproject.com/ja/3.2/ref/forms/validation/#cleaning-and-validating- fields-that-depend-on-each-other Form.add_errorsメソッドを呼ぶ. class WorkTimeForm(forms.Form): # .........(省略)........... def clean(self): # .......(省略)....... if finish_at <= start_at: self.add_error('start_at', forms.ValidationError('開始時刻のエラー')) self.add_error('finish_at', forms.ValidationError('終了時刻のエラー')) 68
- 69. 3章.form.add_errorで各Fieldにエラーメッセージをセッ トする 再掲.raiseValidationErrorした場合. form.errors {'__all__': ['終了時刻は開始時刻より後にしてください']} 修正後:add_errorを使った場合. form = WorkTimeForm({"start_at": "2020-01-02 08:00:00", "finish_at": "2020-01-01 17:30:00"}) form.errors Out[105]: {'start_at': ['開始時刻が×'], 'finish_at': ['終了時刻が×']} 69
- 74. 3章.validatorの定義2/4 from django.core.exceptions import ValidationError def validate_even(value): if value % 2 != 0: raise ValidationError('これは偶数ではありません!') https://docs.djangoproject.com/ja/3.2/ref/validators/を参考に記述. 単なる関数(など)なので、再利用性が高い。 74
- 75. 3章.validatorの定義3/4 >>> validate_even(2) # 何も返さない。(None) 奇数(3)を与えると、ValidationErrorをraiseする。 >>> validate_even(3) ...省略... django.core.exceptions.ValidationError: ['これは偶数ではありません!'] 75
- 76. 3章.validatorの定義4/4 class NumberForm(forms.Form): even = forms.IntegerField(validators=[validate_even]) form = NumberForm({'even': '3'}) form.errors Out[37]: {'even': ['これは偶数ではありません!']} 76
- 77. 3章.build-inのValidatorクラス https://docs.djangoproject.com/en/3.2/ref/validators/#built-in-validators built-inのvalidatorは一度見ておくと良い。 パラメータを渡し、インスタンス化して使うことができる。 from django.core.validators import RegexValidator start_with_jsl = RegexValidator(regex='^jsl.*', message='「jsl」から始めてください') start_with_jsl('jsl00000') # OK start_with_jsl('AAA00000') # NG! # django.core.exceptions.ValidationError: ['「jsl」から始めてください'] 77
- 84. 4章.FormSet class Member(models.Model): name = models.CharField(max_length=100) age = models.IntegerField(null=True, blank=True) class MemberModelForm(forms.ModelForm): class Meta: model = Member fields = ('name',) 84
- 85. 4章.FormSet from django.forms import modelformset_factory MemberFormSet = modelformset_factory( model=Member, form=MemberModelForm, extra=5, # いくつ空のFormを並べるか。 ) これだけ！ 85
- 86. 4章.FormSet:Viewでの使い方 通常のモデルフォーム # 空 form = MemberModelForm() # データあり form = MemberModelForm(request.POST) ↓ # 空 form_set = MemberFormSet(queryset=Member.objects.none()) # データあり form_set = MemberFormSet(request.POST, queryset=Member.objects.none()) querysetを指定すると、DB上のデータを投入したFormSetを表示できる(編集) Model.objects.non()を指定すると、空のformsetができます(新規登録) 86
- 87. 4章.テンプレートでは https://docs.djangoproject.com/ja/3.2/topics/forms/modelforms/#using-the-formset-in- the-template <form method="POST"> {% csrf_token %} <!-- 補助フィールド --> {{ form_set.management_form }} {% for f in form_set %} {{ f }} {% endfor %} <input type="submit" value="SUBMIT!"> </form> 87
- 91. 3章.ModelFormとは https://docs.djangoproject.com/ja/3.2/topics/forms/modelforms/ model定義 class Member(models.Model): name = models.CharField(verbose_name='名前', max_length=100) age = models.IntegerField(verbose_name='年齢') Form定義 class MemberModelForm(forms.ModelForm): class Meta: model = Member fields = ('name', 'age') 91
- 92. 3章.Modelにもvalidatiorを設定できる. class ProjectCode(models.Model): jsl_code = models.CharField( verbose_name='プロジェクトコード', max_length=7, validators=[RegexValidator(regex='^jsl[0-9]{4}$')]) project_code = ProjectCode(jsl_code='jsl0') project_code.full_clean() django.core.exceptions.ValidationError: {'jsl_code': ['Enter a valid value.']} 92
- 94. ModelとModelFormにvalidatorを設定すると... class ProjectCode(models.Model): jsl_code = models.CharField( max_length=7, validators=[RegexValidator(regex='^jsl[0-9]{4}$', message='model側')]) class ProjectCodeModelForm(forms.ModelForm): class Meta: model = ProjectCode fields = ('jsl_code', ) # Form由来は末尾1としてみる. jsl_code = forms.CharField( validators=[RegexValidator(regex='1$', message='Form側')]) 94
- 95. ModelとModelFormにvalidatorを設定すると... form = ProjectCodeModelForm({'jsl_code': 'jsl0000'}) form.errors Out[14]: {'jsl_code': ['Form側']} form = ProjectCodeModelForm({'jsl_code': '0001'}) form.errors Out[12]: {'jsl_code': ['model側']} 95
- 96. ModelとModelFormにvalidatorを設定すると... Model,Formどちらも満たさない場合. Form側のメッセージしか表示されません. form = ProjectCodeModelForm({'jsl_code': '00'}) form.errors Out[16]: {'jsl_code': ['Form側']} Model側でやっていたチェック(jsl...となること)のメッセージも出したければ Form側に同じvalidatorを設定する必要があります. class ProjectCodeModelForm(forms.ModelForm): # ...省略.... validators=[ RegexValidator(regex='1$', message='Form側'), RegexValidator(regex='^jsl[0-9]{4}$', message='Form側その２')]) 96
- 97. ModelとModelFormにvalidatorを設定すると... ModelForm側で設定した2つのバリデーション結果がerrorsに入っている。 form = ProjectCodeModelForm({'jsl_code': '00'}) form.errors Out[28]: {'jsl_code': ['Form側', 'Form側その２']} 97