Обработка форм — Flask-WTF

В этой главе вы научитесь использовать Flask-WTF для стандартизации обработки форм: определение классов форм, автоматическая защита CSRF, валидация полей и сообщения об ошибках.


Зачем использовать Flask-WTF?

Формы регистрации и входа в предыдущей главе были написаны вручную: вручную изrequest.form.get()Получение значений, ручная валидация, ручное отображение ошибок.

Flask-WTFОбёртка вокруг WTForms для Flask, предоставляющая:

  • Определение классов форм, централизованное управление полями + правила валидации.
  • Автоматическая защита CSRF
  • Отображение полей и сообщений об ошибках в шаблонах
  • form.validate_on_submit()Унифицированная обработка определения GET/POST и валидации.

Установка и настройка

(venv) $ pip install flask-wtf

Настройте SECRET_KEY в app.py (CSRF-токен зависит от этого ключа):

Пример

# Путь к файлу: app.py
app.config['SECRET_KEY'] = 'your-secret-key'    # Используйте переменные среды для production-окружения
app.config['WTF_CSRF_ENABLED'] = True            # Включено по умолчанию, явно объявите это

Определите класс формы

Пример

# Путь к файлу: app/forms.py (новый файл)
from flask_wtf import FlaskForm
from wtforms import StringField, PasswordField, EmailField, BooleanField
from wtforms.validators import DataRequired, Length, Email, EqualTo, ValidationError
from app.models import User

class RegisterForm(FlaskForm):
    Форма регистрации
    username = StringField(Username, validators=[
        DataRequired(message=Имя пользователя не может быть пустым),
        Length(min=3, max=50, message=Имя пользователя должно содержать от 3 до 50 символов)
    ])
    email = EmailField(Email, validators=[
        DataRequired(message=Email не может быть пустым),
        Email(message=Пожалуйста, введите корректный адрес электронной почты)
    ])
    password = PasswordField(Password, validators=[
        DataRequired(message=Пароль не может быть пустым),
        Length(min=6, message=Пароль должен содержать не менее 6 символов)
    ])
    confirm_password = PasswordField(Подтвердите пароль, validators=[
        DataRequired(message=Пожалуйста, введите пароль ещё раз),
        EqualTo('password', message=Пароли не совпадают)
    ])

    # Пользовательский валидатор: проверить, не зарегистрировано ли имя пользователя
    def validate_username(self, field):
        if User.query.filter_by(username=field.data).first():
            raise ValidationError(Это имя пользователя уже занято.)

    def validate_email(self, field):
        if User.query.filter_by(email=field.data).first():
            raise ValidationError(Эта электронная почта уже зарегистрирована.)


class LoginForm(FlaskForm):
    """Форма входа"""
    username = StringField(Username, validators=[
        DataRequired(message=Имя пользователя не может быть пустым)
    ])
    password = PasswordField(Password, validators=[
        DataRequired(message=Пароль не может быть пустым)
    ])
    remember = BooleanField(Запомнить меня)

Распространённые типы полей

Класс FieldHTML-тегОписание
StringField<input type="text">Однострочный текст
PasswordField<input type="password">Ввод пароля
EmailField<input type="email">Поле email
TextAreaField<textarea>Многострочный текст
BooleanField<input type="checkbox">Флажок
SelectField<select>Выбор из выпадающего списка

Общие валидаторы

ВалидаторФункция
DataRequired()Поле не может быть пустым
Length(min=, max=)Длина символов
Email()Проверка формата email
EqualTo('field_name')Совпадает со значением другого поля
Optional()Разрешить пустое поле (пропустить последующие валидаторы).

Использование форм в представлении

Пример

# Путь к файлу: app/blueprints/auth.py (рефакторинг и вход)
from flask import Blueprint, render_template, redirect, url_for, flash
from flask_login import login_user, logout_user, login_required, current_user
from app.forms import RegisterForm, LoginForm
from app.models import User, db

auth_bp = Blueprint('auth', __name__)

@auth_bp.route("/register", methods=['GET', 'POST'])
def register():
    if current_user.is_authenticated:
        return redirect(url_for('main.index'))

    form = RegisterForm()
    # form.validate_on_submit() проверяет форму при POST-запросах
    # Возвращает False при GET-запросах или когда валидация не проходит
    if form.validate_on_submit():
        user = User(username=form.username.data, email=form.email.data)
        user.set_password(form.password.data)
        db.session.add(user)
        db.session.commit()
        login_user(user)
        flash(fРегистрация прошла успешно, добро пожаловать, {user.username}!, 'success')
        return redirect(url_for('main.index'))

    # При GET-запросах или неудачной валидации отображает шаблон с формой
    return render_template('register.html', form=form)


@auth_bp.route("/login", methods=['GET', 'POST'])
def login():
    if current_user.is_authenticated:
        return redirect(url_for('main.index'))

    form = LoginForm()
    if form.validate_on_submit():
        user = User.query.filter_by(username=form.username.data).first()
        if user is None or not user.check_password(form.password.data):
            flash(Неправильное имя пользователя или пароль., 'error')
            return render_template('login.html', form=form)

        login_user(user, remember=form.remember.data)
        flash(fС возвращением, {user.username}!, 'success')
        next_page = request.args.get('next')
        return redirect(next_page or url_for('main.index'))

    return render_template('login.html', form=form)

Рендеринг форм в шаблонах

Пример

<!-- Путь к файлу: app/templates/register.html -->
{% extends 'base.html' %}

{% block title %}Регистрация - EXAMPLE Blog{% endblock %}

{% block content %}
<div class="auth-form">
    <h2>Регистр</h2>
    <form method="post">
        <!-- form.hidden_tag() автоматически генерирует скрытое поле CSRF Token -->
        {{ form.hidden_tag() }}

        <div class="form-group">
            {{ form.username.label }}
            {{ form.username(class="form-input") }}
            {% if form.username.errors %}
                {% for error in form.username.errors %}
                <span class="field-error">{{ error }}</span>
                {% endfor %}
            {% endif %}
        </div>

        <div class="form-group">
            {{ form.email.label }}
            {{ form.email(class="form-input") }}
            {% for error in form.email.errors %}
            <span class="field-error">{{ error }}</span>
            {% endfor %}
        </div>

        <div class="form-group">
            {{ form.password.label }}
            {{ form.password(class="form-input") }}
            {% for error in form.password.errors %}
            <span class="field-error">{{ error }}</span>
            {% endfor %}
        </div>

        <div class="form-group">
            {{ form.confirm_password.label }}
            {{ form.confirm_password(class="form-input") }}
            {% for error in form.confirm_password.errors %}
            <span class="field-error">{{ error }}</span>
            {% endfor %}
        </div>

        {{ form.submit(class="btn-submit") }}
    </форма>
    <p class="form-footer">
Уже есть аккаунт?<a href="{{ url_for('auth.login') }}">Войти сейчас</a>
    </p>
</div>
{% endblock %}

CSRF-защита Flask-WTF автоматическая:form.hidden_tag()Сгенерирует скрытое поле<input>Содержит случайный токен; сервер проверяет этот токен перед принятием POST-запроса. Любая форма, отправленная с внешнего сайта, отклоняется, поскольку в ней отсутствует правильный токен.


Сравнение ручного request.form и Flask-WTF

АспектРучной request.formFlask-WTF
Строк кодаДля каждого поля повторяйте три шага: получить/проверить/сообщитьОпределите класс формы один раз
CSRF-защитаТребуется ручная реализацияАвтоматические
Пользовательская валидацияРучная проверка if/elseметод validate_xxx
Отображение ошибокРучная конкатенацияАвтоматический сбор ошибок form.field.errors
Применимые сценарииПростые формы (например, поле поиска)Сложные формы (регистрация, вход, редактирование профиля)

Итоги главы

В этой главе вы выполнили рефакторинг формы аутентификации с помощью Flask-WTF: FlaskForm определяет поля и валидаторы, validate_xxx — пользовательская валидация, form.validate_on_submit() единообразно обрабатывает валидацию при POST-запросе, form.hidden_tag() обеспечивает автоматическую защиту от CSRF, а сообщения об ошибках выводятся в шаблонах.

Обработка форм теперь стала более стандартизированной и безопасной.

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