Flask：Flask-WTF 中的默认错误信息解读

在本文中，我们将介绍 Flask-WTF 扩展中的默认错误信息的含义和如何进行自定义。Flask-WTF 是一个用于处理 Web 表单的扩展，Flask-WTF 提供了一些默认的错误信息，用于提示用户输入的表单数据是否符合要求。

阅读更多：Flask 教程

Flask-WTF 概述

Flask-WTF 是一个与 Flask 高度集成的表单处理扩展，它建立在 WTForms 之上，并提供了一些额外的功能和与 Flask 的无缝集成。它简化了表单的验证、渲染和提交过程，并提供了一些默认的错误信息。

在使用 Flask-WTF 进行表单验证时，如果用户输入的数据不符合要求，Flask-WTF 将自动生成一些默认的错误信息。这些错误信息包含在 Flask-WTF 的 Form 类的 errors 属性中，我们可以通过调用这个属性来获取错误信息。

默认错误信息

Flask-WTF 提供了一些默认的错误信息，这些错误信息可以在表单验证时使用。下面是一些常见的默认错误信息及其含义：

This field is required.：该字段为必填字段，不能为空。
This field is invalid.：该字段无效，数据类型或格式错误。
File is too large.：文件过大，超出了允许的大小限制。
File type not allowed.：文件类型不允许，不符合允许上传的文件类型。
Invalid email address.：邮箱地址无效，格式不正确。
Invalid URL.：无效的 URL，格式不正确。
Length must be between X and Y.：长度必须在 X 和 Y 之间。

这些默认错误信息是根据表单字段的验证规则自动生成的，我们可以通过在表单字段的验证规则中添加自定义的错误信息来覆盖默认的错误信息。

自定义错误信息

除了使用默认的错误信息之外，我们还可以自定义错误信息，以便更好地满足我们的需求。在 Flask-WTF 中，我们可以通过在表单字段的验证规则中使用 message 参数来定义自定义错误信息。

from flask_wtf import FlaskForm
from wtforms import StringField, SubmitField
from wtforms.validators import Length

class MyForm(FlaskForm):
    name = StringField('Name', validators=[Length(min=2, max=10, message='姓名长度必须在2到10个字符之间')])
    submit = SubmitField('Submit')

在上述代码中，我们定义了一个名为 MyForm 的表单类，其中包含一个名为 name 的字符串字段。在验证规则中，我们使用了 Length 验证器，并通过 message 参数指定了自定义的错误信息。

当用户输入的姓名长度不在 2 到 10 个字符之间时，将会返回我们自定义的错误信息。

错误信息的显示

在 Flask-WTF 中，我们可以通过在模板中使用 form.errors 属性来显示表单验证时产生的错误信息。form.errors 是一个字典类型的属性，其中 key 是字段的名称，value 是一个列表类型的错误信息。

下面是一个简单的例子，展示了如何在模板中遍历并显示错误信息：

<form method="POST">
  {{ form.csrf_token }}
  <div>
    {{ form.name.label }}: {{ form.name }}
    {% for error in form.name.errors %}
      <span>{{ error }}</span>
    {% endfor %}
  </div>
  {{ form.submit }}
</form>

在上述代码中，我们首先使用 {{ form.csrf_token }} 渲染 CSRF 令牌，然后遍历 form.name.errors 列表，将错误信息逐个展示在模板中。

总结

在本文中，我们介绍了 Flask-WTF 扩展中的默认错误信息，并讲解了如何自定义错误信息。Flask-WTF 提供了一些常见的默认错误信息，用于提示用户的输入数据是否符合要求。如果默认的错误信息不满足需求，我们可以通过在表单字段的验证规则中使用 message 参数来自定义错误信息。同时，我们还学习了如何在模板中显示错误信息。

通过掌握和使用 Flask-WTF 扩展中的错误信息功能，我们可以更好地处理表单验证，并向用户提供准确和友好的错误提示，提升用户体验。