naritoブログ

このブログはPython/DjangoとBootstrap4で作成されました
Githubのソースコード

Djangoで、フォームの内容を保持する(Context編)

約82日前 2018年5月1日1:05
プログラミング関連

概要


Djangoで、ユーザー情報の入力後に確認画面を表示したいと思います。

どう実装するのかと言いますと、ユーザー情報入力後のデータが入ったformオブジェクトを、入力画面のビュー→確認画面のビュー→データ作成のビュー と渡していきます。

今回の例だけでなく、フォームの内容を保持したいという場合には使えます。

見た目


トップページは、ユーザーの一覧が表示されています。
トップページの様子。ユーザーの一覧が表示される

ユーザー情報入力画面で入力し、送信を押すと
ユーザー情報の入力画面

確認画面で、内容を確認できます。
送信を押すと確認画面へ。さきほど入力した内容が移されている

戻るで入力画面に戻ると、ユーザー名は既に入力済みの状態です。画像のように、パスワードも入力済みにして戻らせることもできます。
戻るを押したら、ちゃんと入力済みの状態で戻れます

送信では、データが正しく追加されます。
送信すると、正しく追加されます

ソースコード



urls.py


from django.urls import path
from . import views

app_name = 'register'

urlpatterns = [
    path('', views.UserList.as_view(), name='user_list'),
    path('user_data_input/', views.UserDataInput.as_view(), name='user_data_input'),
    path('user_data_confirm/', views.UserDataConfirm.as_view(), name='user_data_confirm'),
    path('user_data_create/', views.UserDataCreate.as_view(), name='user_data_create'),
]


forms.py


UserCreationFormを継承した、ユーザー作成用の一般的で、汎用的なフォームです。Bootstrap4対応しています。
from django.contrib.auth.forms import UserCreationForm
from django.contrib.auth import get_user_model

User = get_user_model()  # Userモデルの柔軟な取得方法


class UserCreateForm(UserCreationForm):
    """ユーザー登録用フォーム"""

    class Meta:
        model = User
        fields = (User.USERNAME_FIELD,)  # ユーザー名として扱っているフィールドだけ、作成時に入力する

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        for field in self.fields.values():
            field.widget.attrs['class'] = 'form-control'



views.py


ドックストリングで解説しているとおりです。
FormViewはCreateViewからデータ作成処理を抜いたようなもので、POSTで飛んできたデータをフォームに束縛してくれるため、こういう時は便利です。
from django.contrib.auth import get_user_model
from django.shortcuts import render
from django.urls import reverse_lazy
from django.views import generic
from .forms import UserCreateForm

User = get_user_model()


class UserList(generic.ListView):
    template_name = 'register/user_list.html'  # デフォルトUserだと、authアプリケーションのuser_list.htmlを探すため、明示的に書いておく
    model = User


class UserDataInput(generic.FormView):
    """ユーザー情報の入力

    このビューが呼ばれるのは、以下の2箇所です。
    ・初回の入力欄表示(aタグでの遷移)
    ・確認画面から戻るを押した場合(これはPOSTで飛んできます)

    初回の入力欄表示の際は、空のフォームをuser_data_input.htmlに渡し、
    戻る場合は、POSTで飛んできたフォームデータをそのままuser_data_input.htmlに渡します。

    """
    template_name = 'register/user_data_input.html'
    form_class = UserCreateForm

    def form_valid(self, form):
        return render(self.request, 'register/user_data_input.html', {'form': form})


class UserDataConfirm(generic.FormView):
    """ユーザー情報の確認

    ユーザー情報入力後、「送信」を押すとこのビューが呼ばれます。(user_data_input.htmlのform action属性がこのビュー)
    データが問題なければuser_data_confirm.html(確認ページ)を、入力内容に不備があればuser_data_input.html(入力ページ)に
    フォームデータを渡します。

    """
    form_class = UserCreateForm

    def form_valid(self, form):
        return render(self.request, 'register/user_data_confirm.html', {'form': form})

    def form_invalid(self, form):
        return render(self.request, 'register/user_data_input.html', {'form': form})


class UserDataCreate(generic.CreateView):
    """ユーザーデータの登録ビュー。ここ以外では、CreateViewを使わないでください"""
    form_class = UserCreateForm
    success_url = reverse_lazy('register:user_list')

    def form_invalid(self, form):
        """ここは飛んでこないはずです。UserDataConfrimでバリデーションは済んでるため"""
        return render(self.request, 'register/user_data_input.html', {'form': form})




base.html


Bootstrap4を使った、よくあるbase.html
<!doctype html>
<html lang="ja">
<head>
    <!-- Required meta tags -->
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">

    <!-- Bootstrap CSS -->
    <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.0/css/bootstrap.min.css"
          integrity="sha384-9gVQ4dYFwwWSjIDZnLEWnxCjeSWFphJiwGPXr1jddIhOegiu1FwO5qRGvFXOdJZ4" crossorigin="anonymous">

    <title>会員登録サンプル</title>
</head>
<body>

    <div class="container mt-3">
        {% block content %}{% endblock %}
    </div>

    <!-- Optional JavaScript -->
    <!-- jQuery first, then Popper.js, then Bootstrap JS -->
    <script src="https://code.jquery.com/jquery-3.3.1.slim.min.js"
            integrity="sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo"
            crossorigin="anonymous"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.0/umd/popper.min.js"
            integrity="sha384-cs/chFZiN24E4KMATLdqdvsezGxaGsi4hLGOzlXwp5UZB1LY//20VyM2taTB4QvJ"
            crossorigin="anonymous"></script>
    <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.1.0/js/bootstrap.min.js"
            integrity="sha384-uefMccjFJAIv6A+rW+L4AHf99KvxDjWSu1z9VI8SKNVmz4sk7buKt/6v9KI65qnm"
            crossorigin="anonymous"></script>
</body>
</html>



user_list.html


ユーザー作成ページへのリンクと、ユーザーの一覧が表示されるページ。
{% extends "register/base.html" %}
{% block content %}
<p><a href="{% url 'register:user_data_input' %}">ユーザー作成</a></p><hr>
{% for user in user_list %}
    <p>ユーザー名: {{ user.username }}</p><hr>
{% endfor %}
{% endblock %}



user_data_input.html


ユーザー情報の入力ページ。formのaction属性が、{% url 'register:user_data_confirm' %}となっていることに注意してください。(よくある、action=""ではないです)
{% extends "register/base.html" %}
{% block content %}
<form action="{% url 'register:user_data_confirm' %}" method="POST">
    {{ form.non_field_errors }}
    {% for field in form %}
    <div class="form-group">
        <label for="{{ field.id_for_label }}">{{ field.label_tag }}</label>
        {{ field }}
        {{ field.errors }}
    </div>
    {% endfor %}
    {% csrf_token %}
    <button type="submit" class="btn btn-primary btn-lg">送信</button>
</form>
{% endblock %}



user_data_confirm.html


確認ページです。
{% extends "register/base.html" %}
{% block content %}
    {% for field in form %}
    <div class="form-group">
        <label for="{{ field.id_for_label }}">{{ field.label_tag }}</label>
        {{ field.value }}
    </div>
    {% endfor %}

    <form action="{% url 'register:user_data_input' %}" method="POST">
        <button type="submit" class="btn btn-primary btn-lg">戻る</button>
        {% for field in form %}{{ field.as_hidden }}{% endfor %}
        {% csrf_token %}
    </form>
    <hr>
    <form action="{% url 'register:user_data_create' %}" method="POST">
        <button type="submit" class="btn btn-primary btn-lg">送信</button>
        {% for field in form %}{{ field.as_hidden }}{% endfor %}
        {% csrf_token %}
    </form>
{% endblock %}



ここは、入力された情報を表示するための部分です。{{ field.value }}で、値やテキストだけ取り出すことができます(input要素は生成しない)。生のパスワードが表示されて気持ち悪い場合は、各フィールドを直接書いていくとよいでしょう。
    {% for field in form %}
    <div class="form-group">
        <label for="{{ field.id_for_label }}">{{ field.label_tag }}</label>
        {{ field.value }}
    </div>
    {% endfor %}



そして、戻る部分です。入力内容をGETメソッドで送るのはアレなので、POSTで送信します。
POSTで送信するためにはinput type=...のような要素が必要ですが、それを表示する訳にはいきません(見た目的な問題です。やってみるとわかります)。
幸いにも、{{ field.as_hidden }} でinput type="hidden"な表示されない要素にすることができるので、それをしています。
    <form action="{% url 'register:user_data_input' %}" method="POST">
        <button type="submit" class="btn btn-primary btn-lg">戻る</button>
        {% for field in form %}{{ field.as_hidden }}{% endfor %}
        {% csrf_token %}
    </form>


送信ボタンも同じで、formのaction属性がuser_data_createになる以外は、戻るボタンと同じです。
    <form action="{% url 'register:user_data_create' %}" method="POST">
        <button type="submit" class="btn btn-primary btn-lg">送信</button>
        {% for field in form %}{{ field.as_hidden }}{% endfor %}
        {% csrf_token %}
    </form>


参考としてお見せすると、as_hiddenで隠している部分は以下のような感じになります。
<input type="hidden" name="username" value="toritoritorina@gmail.com" id="id_username" />
<input type="hidden" name="password1" value="hello12345" id="id_password1" />
<input type="hidden" name="password2" value="hello12345" id="id_password2" />



処理の流れ


流れとしては、以下のようになります。

UserDataInputビュー

user_data_input.html(入力画面)
↓(送信ボタンを押す)
UserDataConfirmビュー
↓(入力値に問題がなければ)
user_data_confirm.html(確認画面)

この後、「戻る」を押すとUserDataInputビューに戻ります。
「送信」を押すとUserDataCreateビューへ行き、データを作成後一覧画面へ戻ります。


戻った際に、パスワードも入力済みにしたい場合


forms.pyの__init__内を、以下のようします。widget.render_value = Trueで、input type="password"の場合でも入力欄がクリアされません。
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.fields['password1'].widget.render_value = True
        self.fields['password2'].widget.render_value = True
        for field in self.fields.values():
            field.widget.attrs['class'] = 'form-control'
太陽少年django 約69日前 2018年5月14日11:47 返信する
こんにちは、なりとさん。
私は現在djangoを学んでいて、一つどうしても原因のわからないエラーが起きているので質問させてください。

ユーザー登録の際に画像が必要なようにUserモデルを改良したのですが、ユーザー登録フォームを送信しようとすると、画像選択欄に「このフィールドは必須です」と出て送信できません。
きっちりと画像は選択されているのですが、まるで選択していないかのように'必須です'と出てしまうのはなぜなのでしょうか?

こちらがコードです。
<models.py>
class User(AbstractBaseUser, PermissionsMixin):
uuid = models.UUIDField(default=uuid_lib.uuid4,
primary_key=True, editable=False)
username_validator = UnicodeUsernameValidator()

username = models.CharField(
_('username'),
max_length=150,
unique=True,
help_text=_(
'Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.'),
validators=[username_validator],
error_messages={
'unique': _("A user with that username already exists."),
},
)
image = models.ImageField(upload_to='media/')
email = models.EmailField(
_('email address'),
unique=True,
help_text='input correct email address'
)

is_staff = models.BooleanField(
_('staff status'),
default=False,
help_text=_(
'Designates whether the user can log into this admin site.'),
)
is_active = models.BooleanField(
_('active'),
default=True,
help_text=_(
'Designates whether this user should be treated as active. '
'Unselect this instead of deleting accounts.'
),
)
date_joined = models.DateTimeField(_('date joined'), default=timezone.now)

objects = UserManager()

EMAIL_FIELD = 'email'
USERNAME_FIELD = 'username'
REQUIRED_FIELDS = ['email']

class Meta:
verbose_name = _('user')
verbose_name_plural = _('users')

def clean(self):
super().clean()
self.email = self.__class__.objects.normalize_email(self.email)

def email_user(self, subject, message, from_email=None, **kwargs):
"""Send an email to this user."""
send_mail(subject, message, from_email, [self.email], **kwargs)
なりと 約68日前 2018年5月14日14:14
htmlのform要素に、enctype="multipart/form-data"をつけわすれていませんか。
django 約68日前 2018年5月14日14:50 返信する
おっしゃる通り、その要素を追加すると成功しました。本当にありがとうございます。
もしよろしければその記述にはどんな効果や意味があるのか教えていただいてもいいでしょうか?
なりと 約68日前 2018年5月14日15:00
これはHTML(HTTP)の仕様によるものなのですが、ファイルを送信する場合はenctype="multipart/form-data"とつけないと正しく送信されないためです。
ファイルが送信されなかったので、Djangoではimageフォールドは必須なのにデータが来てないぞ、ということで「このフィールドは必須です」と表示されていました。
太陽少年django 約68日前 2018年5月14日16:10 返信する
なるほどよくわかりました。
平易に解説してくださりありがとうございます。