Flask-WTF for form validation - Mini Project: Build & Apply

Flask-WTF for form validation

📖 Scenario: You are building a simple web page where users can submit their name and email to sign up for a newsletter.We want to make sure the form checks that the name is not empty and the email looks like a real email before accepting it.

🎯 Goal: Create a Flask app using Flask-WTF to build a form with name and email fields.Validate the form so it only accepts submissions with a non-empty name and a valid email address.

📋 What You'll Learn

Create a FlaskForm class with name and email fields

Add validators to ensure name is required and email is a valid email

Create a Flask route to display and process the form

Show a success message when the form is valid

💡 Why This Matters

🌍 Real World

Forms are everywhere on websites for user input. Validating forms on the server side ensures data is correct and secure.

💼 Career

Understanding Flask-WTF is essential for backend web developers working with Flask to build secure and user-friendly forms.

1

Set up the Flask app and form class

Import Flask, FlaskForm, StringField, and SubmitField from flask_wtf and wtforms. Create a Flask app called app. Define a form class called SignupForm that inherits from FlaskForm with two fields: name and email as StringField, and a submit button as SubmitField.

Flask

# Import Flask and FlaskForm classes
# Create Flask app called app
# Define SignupForm class with name, email, and submit fields

Hint

Remember to import all needed classes and create the Flask app instance.

Define the form class with the exact field names name, email, and submit.

2

Add validators to the form fields

Import DataRequired and Email validators from wtforms.validators. Add the DataRequired() validator to the name field and both DataRequired() and Email() validators to the email field in the SignupForm class.

Flask

from flask import Flask
from flask_wtf import FlaskForm
from wtforms import StringField, SubmitField
# Import DataRequired and Email validators

app = Flask(__name__)
app.config['SECRET_KEY'] = 'secret-key'

class SignupForm(FlaskForm):
    # Add validators to name and email fields
    name = StringField('Name')
    email = StringField('Email')
    submit = SubmitField('Sign Up')

Hint

Use the validators argument in the StringField constructor to add validation rules.

3

Create a route to display and process the form

Create a Flask route for '/' that accepts GET and POST methods. Inside the route function called signup, create an instance of SignupForm. Check if the form is submitted and valid using form.validate_on_submit(). If valid, return the string 'Thank you for signing up!'. Otherwise, render a template called 'signup.html' passing the form instance as form.

Flask

from flask import Flask, render_template
from flask_wtf import FlaskForm
from wtforms import StringField, SubmitField
from wtforms.validators import DataRequired, Email

app = Flask(__name__)
app.config['SECRET_KEY'] = 'secret-key'

class SignupForm(FlaskForm):
    name = StringField('Name', validators=[DataRequired()])
    email = StringField('Email', validators=[DataRequired(), Email()])
    submit = SubmitField('Sign Up')

# Create route '/' with GET and POST
# Create signup() function
# Instantiate SignupForm
# If form.validate_on_submit() is True, return success message
# Else render 'signup.html' with form

Hint

Use @app.route decorator with methods=['GET', 'POST'].

Use form.validate_on_submit() to check if form is valid after submission.

4

Create the HTML template for the form

Create a file named signup.html in the templates folder. Use a simple HTML form that uses method='post' and includes {{ form.hidden_tag() }} for CSRF protection. Render the name and email fields with their labels and errors. Add the submit button. Make sure the form submits to the current page.

Flask

from flask import Flask, render_template
from flask_wtf import FlaskForm
from wtforms import StringField, SubmitField
from wtforms.validators import DataRequired, Email

app = Flask(__name__)
app.config['SECRET_KEY'] = 'secret-key'

class SignupForm(FlaskForm):
    name = StringField('Name', validators=[DataRequired()])
    email = StringField('Email', validators=[DataRequired(), Email()])
    submit = SubmitField('Sign Up')

@app.route('/', methods=['GET', 'POST'])
def signup():
    form = SignupForm()
    if form.validate_on_submit():
        return 'Thank you for signing up!'
    return render_template('signup.html', form=form)

# Create signup.html template with form
# Use form.hidden_tag(), form.name.label, form.name, form.name.errors
# Use form.email.label, form.email, form.email.errors
# Use form.submit

Hint

Use form.hidden_tag() inside the form for security.

Render each field's label, input, and errors separately.

Set the form's method to post.

Practice

1. What is the main purpose of using Flask-WTF in a Flask application?

easy

A. To simplify form creation and add validation easily

B. To create database models automatically

C. To handle user authentication and sessions

D. To serve static files like images and CSS

Solution

1. Step 1: Understand Flask-WTF role

   Flask-WTF is a Flask extension that helps create forms and validate user input easily and securely.

2. Step 2: Compare options with Flask-WTF purpose

   Options A, B, and D relate to other Flask features or extensions, not form validation.

3. Final Answer:

   To simplify form creation and add validation easily -> Option A

4. Quick Check:

   Flask-WTF = form handling and validation [OK]

Hint: Flask-WTF = forms + validation helper [OK]

Common Mistakes:

• Confusing Flask-WTF with database or auth tools
• Thinking Flask-WTF serves static files
• Assuming Flask-WTF manages sessions

2. Which of the following is the correct way to import the FlaskForm base class from Flask-WTF?

easy

A. from flask_wtf import FlaskForm

B. from flask import FlaskForm

C. import FlaskForm from flask_wtf

D. from flask_wtf.forms import FlaskForm

Solution

1. Step 1: Recall Flask-WTF import syntax

   The FlaskForm class is imported directly from the flask_wtf package using 'from flask_wtf import FlaskForm'.

2. Step 2: Check other options for syntax errors or wrong paths

   from flask import FlaskForm imports from flask (wrong package). import FlaskForm from flask_wtf uses invalid syntax. from flask_wtf.forms import FlaskForm imports from a non-existent submodule.

3. Final Answer:

   from flask_wtf import FlaskForm -> Option A

4. Quick Check:

   Correct import = from flask_wtf import FlaskForm [OK]

Hint: FlaskForm is from flask_wtf, not flask [OK]

Common Mistakes:

• Importing FlaskForm from flask instead of flask_wtf
• Using incorrect import syntax like 'import X from Y'
• Assuming FlaskForm is in a submodule

3. Given this Flask-WTF form class, what will form.validate_on_submit() return if the submitted email is empty?

from flask_wtf import FlaskForm
from wtforms import StringField
from wtforms.validators import DataRequired, Email

class EmailForm(FlaskForm):
    email = StringField('Email', validators=[DataRequired(), Email()])

medium

A. Raises an exception due to missing email

B. True, because the form is submitted

C. True, because Email validator ignores empty fields

D. False, because the email field is empty and required

Solution

1. Step 1: Understand validators on email field

   The email field uses DataRequired() which means it must not be empty, and Email() to check format.

2. Step 2: Analyze validate_on_submit() behavior with empty email

   Since email is empty, DataRequired() fails, so validate_on_submit() returns False.

3. Final Answer:

   False, because the email field is empty and required -> Option D

4. Quick Check:

   Empty required field = validation fails [OK]

Hint: Empty required fields cause validation to fail [OK]

Common Mistakes:

• Assuming empty fields pass Email validator
• Thinking form submission means validation is True
• Expecting exceptions instead of False return

4. Identify the error in this Flask-WTF form definition:

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

class NameForm(FlaskForm):
    name = StringField('Name', validators=Length(min=3, max=25))

medium

A. FlaskForm must be imported from wtforms, not flask_wtf

B. StringField does not accept validators argument

C. validators should be a list, not a single Length instance

D. Length validator requires a message argument

Solution

1. Step 1: Check validators argument type

   Validators must be passed as a list or tuple, even if only one validator is used.

2. Step 2: Identify the error in code

   Here, validators=Length(...) passes a single instance, not a list, causing a TypeError.

3. Final Answer:

   validators should be a list, not a single Length instance -> Option C

4. Quick Check:

   Validators must be in a list [OK]

Hint: Always wrap validators in a list [] [OK]

Common Mistakes:

• Passing a single validator without list brackets
• Thinking validators argument is optional
• Importing FlaskForm from wrong package

5. You want to create a Flask-WTF form that requires a username between 4 and 12 characters and an optional email that must be valid if provided. Which validator setup is correct?

from flask_wtf import FlaskForm
from wtforms import StringField
from wtforms.validators import DataRequired, Length, Email, Optional

class UserForm(FlaskForm):
    username = StringField('Username', validators=[DataRequired(), Length(min=4, max=12)])
    email = StringField('Email', validators=[???])

hard

A. [DataRequired(), Email()]

B. [Optional(), Email()]

C. [Email(), Optional()]

D. [Length(min=4, max=12), Optional()]

Solution

1. Step 1: Understand optional email validation

   Email is optional, so Optional() must come before Email() to allow empty input without error.

2. Step 2: Check validator order and correctness

   [Optional(), Email()] correctly uses [Optional(), Email()] so empty email passes, and if present, Email() validates format.

3. Final Answer:

   [Optional(), Email()] -> Option B

4. Quick Check:

   Optional before Email for optional valid email [OK]

Hint: Put Optional() before Email() for optional email fields [OK]

Common Mistakes:

• Using DataRequired() on optional fields
• Reversing order of Optional() and Email()
• Using Length validator on email field