Как создать форму в Django с помощью Django Forms: Пошаговое руководство с примерами

Что такое Django Forms и зачем они нужны

Django Forms – это мощный инструмент в Django framework, предназначенный для упрощения работы с HTML-формами. Они позволяют определять формы на Python, обрабатывать данные, введенные пользователем, валидировать их и отображать формы в шаблонах. Без Django Forms разработчику пришлось бы самостоятельно писать логику обработки каждой формы, что значительно увеличивает время разработки и повышает вероятность ошибок.

Преимущества использования Django Forms

• Валидация данных: Автоматическая валидация данных, введенных пользователем, с возможностью определения собственных правил.
• Упрощение работы с HTML: Генерация HTML-кода формы на основе Python-описания, что уменьшает количество ручного кода.
• Защита от XSS: Автоматическая защита от межсайтового скриптинга (XSS) при отображении данных формы.
• Переиспользование: Forms можно переиспользовать в разных частях приложения.
• Удобная обработка ошибок: Предоставление информации об ошибках валидации для отображения пользователю.

Настройка окружения Django (если необходимо)

Предполагается, что у вас уже настроено окружение Django. Если нет, вам потребуется установить Python, pip и сам Django. Затем создайте новый проект и приложение Django.

Создание простой формы с использованием Django Forms

Определение формы в forms.py

Создайте файл forms.py в вашем приложении Django. Определите форму, наследуясь от класса django.forms.Form или django.forms.ModelForm (если форма связана с моделью).

from django import forms

class ContactForm(forms.Form):
    name: str = forms.CharField(label="Имя", max_length=100)
    email: str = forms.EmailField(label="Email")
    message: str = forms.CharField(label="Сообщение", widget=forms.Textarea)

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.label_suffix = '' # remove colon after label

Основные типы полей Django Forms (CharField, IntegerField, и т.д.)

Django Forms предоставляет различные типы полей для разных типов данных:

• CharField: Текстовое поле.
• IntegerField: Целочисленное поле.
• EmailField: Поле для ввода email-адреса.
• BooleanField: Логическое поле (флажок).
• DateField: Поле для выбора даты.
• DateTimeField: Поле для выбора даты и времени.
• ChoiceField: Поле с выпадающим списком вариантов.
• FileField: Поле для загрузки файла.

Каждое поле принимает различные аргументы, такие как label (отображаемое имя поля), max_length (максимальная длина), required (обязательно ли поле для заполнения) и widget (виджет отображения поля).

Добавление формы в представление (view)

Импортируйте форму в ваше представление и создайте экземпляр формы. Передайте форму в контекст шаблона.

from django.shortcuts import render
from .forms import ContactForm
from django.http import HttpResponse

def contact_view(request):
    if request.method == 'POST':
        form: ContactForm = ContactForm(request.POST)
        if form.is_valid():
            name: str = form.cleaned_data['name']
            email: str = form.cleaned_data['email']
            message: str = form.cleaned_data['message']
            # Здесь можно добавить код для отправки email или сохранения в базу данных
            return HttpResponse('Спасибо за ваше сообщение!')
    else:
        form: ContactForm = ContactForm()
    return render(request, 'contact.html', {'form': form})

Отображение формы в шаблоне (template)

В шаблоне используйте тег {{ form }} для отображения всех полей формы. Вы можете также отображать поля по отдельности, используя {{ form.field_name }}. Для отображения ошибок валидации используйте {{ form.errors }} или {{ form.field_name.errors }}.

<form method="post">
    {% csrf_token %}
    {{ form.as_p }}
    <button type="submit">Отправить</button>
</form>

Использование {{ form.as_p }} выводит каждое поле формы, обернутое в параграф (<p>). Можно использовать {{ form.as_table }} или {{ form.as_ul }} для табличного или списочного отображения соответственно.

Обработка данных формы

Проверка данных формы на валидность (is_valid())

Метод is_valid() проверяет данные формы на соответствие определенным правилам валидации. Он возвращает True, если все поля заполнены корректно, и False в противном случае.

Получение очищенных данных (cleaned_data)

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

Обработка ошибок валидации

Если форма не прошла валидацию, ошибки можно получить через атрибут errors. Для отображения конкретных ошибок для каждого поля, используйте form.field_name.errors в шаблоне.

Сохранение данных формы в базу данных (модель Django)

Если форма связана с моделью Django (через ModelForm), можно использовать метод save() для сохранения данных в базу данных.

from django.shortcuts import render
from .forms import MyModelForm
from django.http import HttpResponse

def my_form_view(request):
    if request.method == 'POST':
        form: MyModelForm = MyModelForm(request.POST)
        if form.is_valid():
            form.save()
            return HttpResponse('Данные сохранены!')
    else:
        form: MyModelForm = MyModelForm()
    return render(request, 'my_form.html', {'form': form})

Расширенные возможности Django Forms

Использование виджетов (Widgets) для кастомизации полей

Виджеты позволяют изменять внешний вид полей формы. Например, можно использовать Textarea для многострочного текстового поля или Select для выпадающего списка.

from django import forms

class MyForm(forms.Form):
    description: str = forms.CharField(widget=forms.Textarea(attrs={'rows': 5, 'cols': 40}))

Добавление валидаторов (Validators) для сложных проверок

Валидаторы позволяют определять собственные правила валидации для полей формы. Например, можно проверить, что введенное значение соответствует определенному формату.

from django import forms
from django.core.validators import RegexValidator

class MyForm(forms.Form):
    phone_number: str = forms.CharField(validators=[RegexValidator(regex=r'^\+?[1-9]\d{1,14}$', message='Неверный формат номера телефона.')])

Создание медиа-файлов для форм

Медиа-файлы (CSS, JavaScript) можно связать с формой для добавления интерактивности или стилизации. Для этого нужно определить свойство Media внутри класса формы.

Работа с FormSets

FormSets позволяют работать с несколькими формами одного типа одновременно. Это полезно, например, для редактирования нескольких связанных объектов.

Примеры создания различных форм

Форма обратной связи

(Пример уже приведен в разделе «Создание простой формы с использованием Django Forms»)

Форма регистрации пользователя

from django import forms
from django.contrib.auth.models import User

class UserRegistrationForm(forms.Form):
    username: str = forms.CharField(label="Имя пользователя", max_length=150)
    email: str = forms.EmailField(label="Email")
    password: str = forms.CharField(label="Пароль", widget=forms.PasswordInput)
    password_confirm: str = forms.CharField(label="Подтвердите пароль", widget=forms.PasswordInput)

    def clean_username(self) -> str:
        username: str = self.cleaned_data.get('username')
        if User.objects.filter(username=username).exists():
            raise forms.ValidationError('Имя пользователя уже занято.')
        return username

    def clean(self) -> dict:
        cleaned_data: dict = super().clean()
        password: str = cleaned_data.get('password')
        password_confirm: str = cleaned_data.get('password_confirm')

        if password != password_confirm:
            raise forms.ValidationError("Пароли не совпадают.")

        return cleaned_data

Форма для создания или редактирования модели

from django import forms
from .models import MyModel

class MyModelForm(forms.ModelForm):
    class Meta:
        model: MyModel = MyModel
        fields: tuple = ('name', 'description') # specify fields to include in form