Компонент форм Django

Компоненты форм Django используются для инициализации страниц, генерации HTML-тегов, а также проверки данных, отправленных пользователями (с отображением сообщений об ошибках).

Порядок отображения сообщений об ошибках:

  • Сначала отображаются сообщения об ошибках из атрибутов поля, затем отображаются сообщения об ошибках из локальных хуков.
  • Если отображаются сообщения об ошибках из атрибутов поля, сообщения об ошибках из локальных хуков отображаться не будут.
  • Если есть глобальные хуки, глобальные хуки начнут валидацию только после того, как все данные будут провалидированы, и сообщения об ошибках из глобальных хуков обязательно будут отображены.

Чтобы использовать компоненты Form, сначала нужно импортировать forms:

from django import forms

Далее мы создаём файл My_forms.py в каталоге app01:

app01/My_forms.py

from django import forms
from django.core.exceptions import ValidationError
from app01 import models

class EmpForm(forms.Form):
    name = forms.CharField(min_length=4, label="Имя", error_messages={"min_length": "Слишком коротко.", "required": "Это поле не может быть пустым!"})
    age = forms.IntegerField(label="Возраст")
    salary = forms.DecimalField(label="Зарплата")

Атрибуты поля:

  • label: Текстовая информация перед полем ввода.
  • error_message: Настройте отображаемые сообщения об ошибках. Значение атрибута — словарь, где `required` — ключ для настройки сообщения об ошибке, отображаемого, когда поле не может быть пустым.

app01/views.py

from django.shortcuts import render, HttpResponse
from app01.My_Forms import EmpForm
from app01 import models
from django.core.exceptions import ValidationError
# Создайте здесь свои представления.


def add_emp(request):
    if request.method == "GET":
        form = EmpForm()
        return render(request, "add_emp.html", {"form": form})
    else:
        form = EmpForm(request.POST)
        if form.is_valid():  # Выполнить валидацию данных
            # Валидация успешно завершена
            data = form.cleaned_data  # Значения, прошедшие валидацию, помещаются в cleaned_data.
            data.pop('r_salary')
            print(data)

            models.Emp.objects.create(**data)
            return HttpResponse(
                'ok'
            )
            # return render(request, "add_emp.html", {"form": form})
        else:
            print(form.errors)    # Вывести сообщения об ошибках
            clean_errors = form.errors.get("__all__")
            print(222, clean_errors)
        return render(request, "add_emp.html", {"form": form, "clean_errors": clean_errors})

Добавьте следующие правила в файл app01/urls.py:

path('add_emp/', views.add_emp)

HTML-шаблон:

app01/add_emp.html

<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title></title> </head> <body> <h3>Добавить сотрудника</h3>{#1. Написать HTML-страницы вручную#}<form action="" method="post"> <p>Имя:<input type="text" name="name"></p> <p>Возраст:<input type="text" name="age"></p> <p>Зарплата:<input type="text" name="salary"></p> <input type="submit"> </form>{#2. Реализовано с помощью метода as_p объекта формы#} {#<form action="" method="post" novalidate>#} {# {% csrf_token %}#} {# {{ form.as_p }}#} {# <input type="submit">#} {#</form>#} {#3. Вручную получите поля объекта формы#} {#<form action="" method="post" novalidate>#} {# {% csrf_token %}#} {# <div>#} {# <label for="id_{{ form.name.name }}">Имя</label>#} {# {{ form.name }} <span>{{ form.name.errors.0 }}</span>#} {# </div>#} {# <div>#} {# <label for="id_{{ form.age.name }}">Возраст</label>#} {# {{ form.age }} <span>{{ form.age.errors.0 }}</span>#} {# </div>#} {# <div>#} {# <label for="id_salary">Зарплата</label>#} {# {{ form.salary }} <span>{{ form.salary.errors.0 }}</span>#} {# </div>#} {# <input type="submit">#} {#</form>#} {#4. Используйте цикл for для отображения всех полей#} {#<form action="" method="post" novalidate>#} {# {% csrf_token %}#} {# {% for field in form %}#} {# <div>#} {# <label for="id_{{ field.name }}">{{ field.label }}</label>#} {# {{ field }} <span>{{ field.errors.0 }}</span>#} {# </div>#} {# {% endfor %}#} {# <input type="submit">#} {#</form>#} </body> </html>

Результат выполнения показан на рисунке ниже:

Локальные и глобальные хуки

Определите класс Form:

app01/My_forms.py

from django import forms
from django.core.exceptions import ValidationError
from app01 import models
class EmpForm(forms.Form):
    name = forms.CharField(min_length=5, label="Имя", error_messages={"required": "Это поле не может быть пустым!",
                                                                     "min_length": "Имя пользователя слишком короткое."})
    age = forms.IntegerField(label="Возраст")
    salary = forms.DecimalField(max_digits=5, decimal_places=2, label="Зарплата")
    r_salary = forms.DecimalField(max_digits=5, decimal_places=2, label="Пожалуйста, введите зарплату снова.")


    def clean_name(self):  # Локальный хук
        val = self.cleaned_data.get("name")


        if val.isdigit():
            raise ValidationError("Имя пользователя не может состоять только из цифр")
        elif models.Emp.objects.filter(name=val):
            raise ValidationError("Имя пользователя уже существует!")
        else:
            return val

    def clean(self):  # Глобальный хук для проверки, совпадают ли две введённые зарплаты.
        val = self.cleaned_data.get("salary")
        r_val = self.cleaned_data.get("r_salary")


        if val == r_val:
            return self.cleaned_data
        else:
            raise ValidationError("Пожалуйста, подтвердите, согласована ли зарплата.")

код файла views.py:

app01/views.py

def add_emp(request):
    if request.method == "GET":
        form = EmpForm()  # Инициализировать объект формы
        return render(request, "add_emp.html", {"form":form})
    else:
        form = EmpForm(request.POST)  # Передать данные в объект формы
        if form.is_valid():  # Выполнить проверку
            data = form.cleaned_data
            data.pop("r_salary")
            models.Emp.objects.create(**data)
            return redirect("/index/")
        else:  # Проверка не пройдена
            clear_errors = form.errors.get("__all__")  # Получить информацию об ошибке глобального хука
            return render(request, "add_emp.html", {"form": form, "clear_errors": clear_errors})

Код файла шаблона следующий:

app01/add_emp.html

<form action="" method="post" novalidate> {% csrf_token %} <div> <label for="id_{{ form.name.name }}">Имя</label> {{ form.name }} <span>{{ form.name.errors.0 }}</span> </div> <div> <label for="id_{{ form.age.name }}">Возраст</label> {{ form.age }} <span>{{ form.age.errors.0 }}</span> </div> <div> <label for="id_salary">Зарплата</label> {{ form.salary }} <span>{{ form.salary.errors.0 }}{{ clear_errors.0 }}</span> </div> <div> <label for="id_r_salary">Пожалуйста, введите зарплату еще раз.</label> {{ form.r_salary }} <span>{{ form.r_salary.errors.0 }}{{ clear_errors.0 }}</span> </div> <input type="submit"> </форма>

Результат выполнения показан на рисунке ниже:

Другие расширения