Python – ページ 3 – igreks開発日記

djangoのフォームを扱うビュー3種類

フォーム入力画面を作成するには、

CreateViewクラスをオーバーライドする方法
FormViewクラスをオーバーライドする方法
関数ビューで自分で書く方法

の主に3種類があります。

以下は、まったく同じ動きをするフォームを、3種類の書き方で書いています。（フォームのクラスはforms.pyで別途定義してあるものとします。）

CreateViewクラスをオーバーライドする方法

CreateViewクラスは、FormViewクラスをオーバーライドした、フォームからのデータ登録に特化したクラスです。

単純に入力→保存を行うような機能がめちゃくちゃ簡単にできます。テンプレートは指定がなければ、アプリ名_form.htmlがデフォルトテンプレートとなります。

from django.views.generic.edit import CreateView
from django.urls import reverse_lazy
from .forms import HogeForm

class HogeCreateView(CreateView):
    # modelに基となるクラスを指定
    model = Hoge
    # 別途定義したフォームのクラスを指定
    form_class = HogeForm
    # 登録完了後の遷移ページ
    success_url = reverse_lazy('hoge:top')

from django.views.generic.edit import CreateView

from django.urls import reverse_lazy

from .forms import HogeForm

class HogeCreateView(CreateView):

# modelに基となるクラスを指定

model = Hoge

# 別途定義したフォームのクラスを指定

form_class = HogeForm

# 登録完了後の遷移ページ

success_url = reverse_lazy('hoge:top')

FormViewクラスをオーバーライドする方法

CreateViewは値が正しければDBに自動的に登録してくれるクラスですが、FormViewはそのままでは登録までは勝手にしてくれません。

送られた値が正しかった時に他に何かしたい、といった時に使うのがいいのではないかと思います。

from django.views.generic.edit import FormView
from django.urls import reverse_lazy
from .forms import HogeForm

class HogeCreateView(FormView):
    template_name = 'hoge_form.html'
    # 別途定義したフォームのクラスを指定
    form_class = HogeForm
    # 登録完了後の遷移ページ
    success_url = reverse_lazy('hoge:top')

    # 送られた値が正しかった時の処理
    def form_valid(self, form):
        # 保存
        form.save()
        return super().form_valid(form)

from django.views.generic.edit import FormView

from django.urls import reverse_lazy

from .forms import HogeForm

class HogeCreateView(FormView):

template_name = 'hoge_form.html'

# 別途定義したフォームのクラスを指定

form_class = HogeForm

# 登録完了後の遷移ページ

success_url = reverse_lazy('hoge:top')

# 送られた値が正しかった時の処理

def form_valid(self, form):

# 保存

form.save()

return super().form_valid(form)

関数ビューで自分で書く方法

FormViewクラスに比べ、テンプレートへのレンダリングなども含みます。

sessionやcookieに何か保存したり呼び出したりなど、仕様を細かく指定した時には自分で関数ビューを書いた方が良いです。

from django.shortcuts import redirect
from .forms import HogeForm

def HogeCreateView(request):
    # フォームから送信されたオブジェクトを取得
    form = HogeForm(request.POST)
    # 送られた値が正しかった時の処理
    if form.is_valid():
        # 保存
        form.save()
        # 登録完了後の遷移ページ
        return redirect('hoge:top')
    # コンテキストデータにフォームのオブジェクトを指定しレンダリング
    context = {
        'form': form,
    }
    return render(request, 'hoge_form.html', context)

from django.shortcuts import redirect

from .forms import HogeForm

def HogeCreateView(request):

# フォームから送信されたオブジェクトを取得

form = HogeForm(request.POST)

# 送られた値が正しかった時の処理

if form.is_valid():

# 保存

form.save()

# 登録完了後の遷移ページ

return redirect('hoge:top')

# コンテキストデータにフォームのオブジェクトを指定しレンダリング

context = {

'form': form,

}

return render(request, 'hoge_form.html', context)

以上、備忘録。

djangoの関数ビューでログイン必須にする

djangoのビューにおいて、クラスビューの場合はLoginRequiredMixinを渡しておけば勝手にログイン必須になるのでいいのですが、関数ビューの場合は引数の制限の関係でこの方法が使えません。

なので、login_requiredクラスを別に読み込んで書く必要があります。

クラスビューの場合

from django.contrib.auth.mixins import LoginRequiredMixin
from django.views.generic import TemplateView,

class HogeFugaView(LoginRequiredMixin, TemplateView):
    template_name = 'hoge.html'
    """ 処理 """

from django.contrib.auth.mixins import LoginRequiredMixin

from django.views.generic import TemplateView,

class HogeFugaView(LoginRequiredMixin, TemplateView):

template_name = 'hoge.html'

""" 処理 """

関数ビューの場合

from django.contrib.auth.decorators import login_required
from django.shortcuts import redirect

# ログイン必須
@login_required
def HogeFugaView(request):

    """ 処理 """

from django.contrib.auth.decorators import login_required

from django.shortcuts import redirect

# ログイン必須

@login_required

def HogeFugaView(request):

""" 処理 """

以上、備忘録。

Djangoのアプリ管理画面でユーザのフルネームを表示させる

フレームワークって、決まったことをやる分にはめちゃくちゃ速く開発出来ちゃうけど、ほんのちょっとここをこうしたいって時に、仕様が理解できてないと、ものすごい時間と労力を取られることがある、、。

Djangoで作成したアプリのモデルを定義すると、管理画面上に自動的にレジスターが出てくるので非常に便利。

でもそのレジスターを一覧表示した時、外部キー(foreignkey)で紐づけたユーザ情報が、デフォルトだとユーザ名(ログインID)になってしまう。

せっかくカスタムユーザモデルを定義したのだから、ここにフルネームを出したい。

カスタムユーザモデルを修正。

  :
class User(AbstractBaseUser, PermissionsMixin):
      :
　（省略）
      :
    #フルネーム（氏名）定義。ユニークじゃないと怒られるのでユニークにする
    full_name = models.CharField(_('氏名'), max_length=150, blank=True, unique=True)
      :
    #フルネームをユーザネームフィールドとして扱う
    #USERNAME_FIELD = 'username'
    USERNAME_FIELD = 'full_name'
　　　：
　（以下略）

class User(AbstractBaseUser, PermissionsMixin):

　（省略）

#フルネーム（氏名）定義。ユニークじゃないと怒られるのでユニークにする

full_name = models.CharField(_('氏名'), max_length=150, blank=True, unique=True)

#フルネームをユーザネームフィールドとして扱う

#USERNAME_FIELD = 'username'

USERNAME_FIELD = 'full_name'

　　　：

　（以下略）

マイグレーション忘れずに。

するとアプリのレジスター画面で以下のように表示される。

とりあえずこれでOK。

ただしUSERNAME_FIELDはユーザのレジスターやアクティベーションに関係してくるので、外部向けの新規ユーザ登録画面などを作った時に、弊害が出てくる可能性も、、、。

もうちょっと勉強が必要かな。

6/13追記：

さっそく弊害出ました。フルネームがユーザ名として扱われるようになったため、管理画面にログインする際のIDもフルネームで判定されるようになってしまいました。元に戻しました、、、。