Формирование валидации с WTForms

Когда вам приходится работать с данными форм, отправленными браузером, код быстро становится очень трудно читаемым. Существуют библиотеки, предназначенные для упрощения этого процесса. Одна из них — WTForms, которую мы рассмотрим здесь. Если у вас много форм, стоит попробовать.

При работе с WTForms сначала необходимо определить ваши формы как классы. Рекомендуется разбить приложение на несколько модулей (Более крупные приложения) для этого и добавить отдельный модуль для форм.

Формы

Это пример формы для типичной страницы регистрации:

from wtforms import Form, BooleanField, StringField, PasswordField, validators

class RegistrationForm(Form):
    username = StringField('Username', [validators.Length(min=4, max=25)])
    email = StringField('Email Address', [validators.Length(min=6, max=35)])
    password = PasswordField('New Password', [
        validators.DataRequired(),
        validators.EqualTo('confirm', message='Passwords must match')
    ])
    confirm = PasswordField('Repeat Password')
    accept_tos = BooleanField('I accept the TOS', [validators.DataRequired()])

В представлении

В функции представления использование этой формы выглядит следующим образом:

@app.route('/register', methods=['GET', 'POST'])
def register():
    form = RegistrationForm(request.form)
    if request.method == 'POST' and form.validate():
        user = User(form.username.data, form.email.data,
                    form.password.data)
        db_session.add(user)
        flash('Thanks for registering')
        return redirect(url_for('login'))
    return render_template('register.html', form=form)

Обратите внимание, что здесь предполагается, что представление использует SQLAlchemy (SQLAlchemy в Flask), но это не обязательно. Измените код по мере необходимости.

Следует помнить:

1. создайте форму из запроса form значение, если данные отправлены через HTTP POST метод и args если данные отправлены как GET.
2. для проверки данных вызовите validate() метод, который вернёт True если данные прошли проверку, False в противном случае.
3. для доступа к отдельным значениям из формы, обратитесь к form.<NAME>.data.

Формы в шаблонах

Теперь о стороне шаблонов. Когда вы передаёте форму в шаблоны, вы можете легко отобразить её там. Посмотрите на следующий пример шаблона, чтобы увидеть, насколько это просто. WTForms уже выполняет половину генерации формы за нас. Для большей наглядности можно написать макрос, который отображает поле с меткой и списком ошибок, если таковые имеются.

Вот пример _formhelpers.html шаблона с таким макросом:

{% macro render_field(field) %}
  <dt>{{ field.label }}
  <dd>{{ field(**kwargs)|safe }}
  {% if field.errors %}
    <ul class=errors>
    {% for error in field.errors %}
      <li>{{ error }}</li>
    {% endfor %}
    </ul>
  {% endif %}
  </dd>
{% endmacro %}

Этот макрос принимает несколько ключевых аргументов, которые передаются в функцию поля WTForm, которая отображает поле для нас. Ключевые аргументы будут вставлены как атрибуты HTML. Например, вы можете вызвать render_field(form.username, class='username') чтобы добавить класс к элементу ввода. Обратите внимание, что WTForms возвращает стандартные строковые значения Python, поэтому нам нужно сказать Jinja2, что эти данные уже экранированы в HTML с помощью |safe фильтра.

Вот register.html шаблон для функции, которую мы использовали выше, который использует _formhelpers.html шаблон:

{% from "_formhelpers.html" import render_field %}
<form method=post>
  <dl>
    {{ render_field(form.username) }}
    {{ render_field(form.email) }}
    {{ render_field(form.password) }}
    {{ render_field(form.confirm) }}
    {{ render_field(form.accept_tos) }}
  </dl>
  <p><input type=submit value=Register>
</form>

Для получения дополнительной информации о WTForms перейдите на сайт WTForms.