Python | Django | class-based viewsのFormViewの使い方

2021年8月22日2024年9月12日

公開日：2021/8/22

Pythonには，DjangoというWebアプリケーションフレームワークがある．フレームワークのため，Djangoを利用するとWebアプリを通常よりも短時間で開発することが可能になる．

class-based viewsは，viewsを実装する手段の1つであり，関数の代わりにPythonのオブジェクトとしてviewsを定義する．viewsの作成とデータの追加・更新・削除が容易になる．

前記事では，「class-based viewsで作成した一覧画面の更新」を作成した．前記事での設定をそのまま引き継いだ上で，本記事では，「class-based viewsのFormViewの使い方」を以下2つの構成にて記す．

◆実施環境

Python 3.8.8
Django 3.2.3
VS Code 1.59.0

■class-based viewsのFormViewの使い方

Formを利用する際にFormViewが利用される．

基本の利用

“ec_site/views.py"に追記し，以下のように編集する．"ec_site/views.py"の"TopView"で記述した内容を今回編集する内容で代替する．

from django.shortcuts import render
from django.views.generic.base import (
    View, TemplateView
)
from django.views.generic.detail import DetailView
from django.views.generic.list import ListView
from django.views.generic.edit import ( # 変更箇所
    CreateView, UpdateView, DeleteView,
    FormView,
)
from . import forms
import random
from .models import Medicines
from datetime import datetime
from django.urls import reverse_lazy

class TopView(View):

    def get(self, request, *args, **kwargs):
        medicine_form = forms.MedicineForm()
        return render(request, 'top.html', context={
            'medicine_form': medicine_form,
        })

    def post(self, request, *args, **kwargs):
        medicine_form = forms.MedicineForm(request.POST or None)
        if medicine_form.is_valid():
            medicine_form.save()
        return render(request, 'top.html', context={
            'medicine_form': medicine_form,
        })

class HomeView(TemplateView):

    template_name = 'home.html'

    def get_context_data(self, **kwargs):
        context = super().get_context_data(**kwargs)
        context['name'] = kwargs.get('name')
        context['alphabet'] = random.randint(0,9999)
        return context

class MedicineDetailView(DetailView):
    model = Medicines
    template_name = 'medicine.html'

    def get_context_data(self, **kwargs):
        context = super().get_context_data(**kwargs)
        context['time'] = datetime.now()
        return context

class MedicineListView(ListView):
    model = Medicines
    template_name = 'medicine_list.html'

    def get_queryset(self):
        qs = super(MedicineListView, self).get_queryset()
        if 'name' in self.kwargs:
            qs = qs.filter(name__startswith=self.kwargs['name'])
        qs = qs.order_by('-id') # 変更箇所(新たに追加した薬品を一番上にするため)
        return qs

class MedicineCreateView(CreateView):
    model = Medicines
    fields = ['name', 'description', 'price']
    template_name = 'insert_medicine.html'
    # success_url = reverse_lazy('ec_site:list_medicines')

    def form_valid(self, form):
        form.instance.create_time = datetime.now()
        form.instance.update_time = datetime.now()
        return super(MedicineCreateView, self).form_valid(form)

    def get_initial(self, **kwargs):
        initial = super(MedicineCreateView, self).get_initial(**kwargs)
        initial['price'] = '1000'
        return initial

class MedicineUpdateView(UpdateView):
    template_name = 'update_medicine.html'
    model = Medicines
    form_class = forms.MedicineUpdateForm

class MedicineDeleteView(DeleteView):
    model = Medicines
    template_name = 'delete_medicine.html'
    success_url = reverse_lazy('ec_site:list_medicines')

class MedicineFormView(FormView): # 以下追記箇所

    template_name = 'form_medicine.html'
    form_class = forms.MedicineForm
    success_url = reverse_lazy('ec_site:list_medicines')

    def get_initial(self):
        initial = super(MedicineFormView, self).get_initial()
        initial['price'] = '2000'
        return initial

    def form_valid(self, form):
        if form.is_valid():
            form.save()
        return super(MedicineFormView, self).form_valid(form)

“ec_site/views.py"に"form_medicine.html"を記載したので，"templates"フォルダに"form_medicine.html"を以下のように作成する．

“templates/form_medicine.html"を以下のように編集する．

<form method="POST">
  {% csrf_token %}
  {{ form.as_p }}
  <input type="submit" value="save">
</form>

“ec_site/urls.py"に追記し，以下のように編集する．

from django.urls import path
from .views import ( # 変更箇所
    TopView, HomeView, MedicineDetailView,
    MedicineListView, MedicineCreateView,
    MedicineUpdateView, MedicineDeleteView,
    MedicineFormView,
    )

app_name = 'ec_site'

urlpatterns = [
    path('top/', TopView.as_view(), name='top'),
    path('home/', HomeView.as_view(), name='home'),
    path('detail_medicine/', MedicineDetailView.as_view(), name='detail_medicine'),
    path('list_medicines', MedicineListView.as_view(), name='list_medicines'),
    path('list_medicines/', MedicineListView.as_view(), name='list_medicines'),
    path('insert_medicine/', MedicineCreateView.as_view(), name='insert_medicine'),
    path('update_medicine/', MedicineUpdateView.as_view(), name='update_medicine'),
    path('delete_medicine/', MedicineDeleteView.as_view(), name='delete_medicine'),
    path('form_medicine/', MedicineFormView.as_view(), name='form_medicine'), # 追記箇所
]

VS Codeの"View"を開き，"Terminal"をクリックする．クリックするとVS Codeの下部にターミナルが開くので，”conda activate 仮想環境名”を実行し，仮想環境に移行する(移行方法の詳細はこちら)．その後，ターミナルで"cd class_based_view"を入力し，ディレクトリを変更する．変更後，以下のように”python manage.py runserver”を実行する．以下が出力される．

(djangoenv) C:\Users\shiro\Desktop\210517_python development\myclassbasedviewtest\class_based_view
>python manage.py runserver
Watching for file changes with StatReloader
Performing system checks...

System check identified no issues (0 silenced). # 以下出力箇所
August 22, 2021 - 15:52:24
Django version 3.2.3, using settings 'class_based_view.settings'
Starting development server at http://127.0.0.1:8000/
Quit the server with CTRL-BREAK.

上記の"http://127.0.0.1:8000/"をクリックすると，ブラウザが開き，以下画面が出力される．

ブラウザのURLに"http://127.0.0.1:8000/ec_site/form_medicine"を入力すると，以下ページに遷移する．赤枠には"def get_initial"で設定した"2000″も最初から入力されている．

以下のように記述し，"save"をクリックする．

成功すると，一覧画面である"list_medicines"ページに遷移する．以下赤枠のように追記されたことが分かる．

参照

https://docs.djangoproject.com/en/3.2/ref/class-based-views/generic-editing/#formview

以上

Pythonclass-based views,Django,FormView,クラスベースビュー

Posted by クマガイ