Error message display in templates in Flask

Introduction

Showing error messages helps users understand what went wrong. It guides them to fix mistakes easily.

When a user submits a form with missing or wrong information.

When login fails due to incorrect username or password.

When a required field is left empty in a web form.

When server-side validation finds invalid data.

When you want to give feedback after user actions.

Syntax

Flask

{% if error_message %}
  <div class="error">{{ error_message }}</div>
{% endif %}

Use Jinja2 template syntax to check if an error message exists.

Place the error message inside a visible HTML element for styling.

Examples

Show a paragraph with the error text if the variable error is set.

Flask

{% if error %}
  <p class="error">{{ error }}</p>
{% endif %}

Display a list of all form field errors when using Flask-WTF forms.

Flask

{% if form.errors %}
  <ul class="error-list">
  {% for field, errors in form.errors.items() %}
    {% for error in errors %}
      <li>{{ field }}: {{ error }}</li>
    {% endfor %}
  {% endfor %}
  </ul>
{% endif %}

Sample Program

This Flask app shows a simple form asking for a name. If the user submits without typing a name, it shows an error message in red above the form. If a name is entered, it greets the user.

The error message uses ARIA roles for accessibility and appears only when needed.

Flask

from flask import Flask, render_template_string, request

app = Flask(__name__)

html_template = '''
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>Simple Form</title>
  <style>
    .error { color: red; font-weight: bold; }
  </style>
</head>
<body>
  <h1>Enter your name</h1>
  {% if error_message %}
    <div class="error" role="alert" aria-live="assertive">{{ error_message }}</div>
  {% endif %}
  <form method="POST">
    <label for="name">Name:</label>
    <input type="text" id="name" name="name" aria-describedby="error-msg">
    <button type="submit">Submit</button>
  </form>
</body>
</html>
'''

@app.route('/', methods=['GET', 'POST'])
def index():
    error_message = None
    if request.method == 'POST':
        name = request.form.get('name', '').strip()
        if not name:
            error_message = 'Please enter your name.'
        else:
            return f'Hello, {name}!'
    return render_template_string(html_template, error_message=error_message)

if __name__ == '__main__':
    app.run(debug=True)

Important Notes

Always escape error messages to avoid security issues.

Use ARIA roles like role="alert" and aria-live="assertive" to help screen readers announce errors immediately.

Style error messages clearly with colors and spacing to catch user attention.

Summary

Error messages help users fix problems quickly.

Use Jinja2 conditions to show errors only when they exist.

Make error messages accessible and visually clear.

Practice

1. In Flask templates, how do you check if an error message exists before displaying it?

easy

A. Use Python if error: directly inside the template.

B. Always display the error message without any condition.

C. Use JavaScript to check for errors inside the template.

D. Use a Jinja2 {% if error %} condition to check if the error variable is set.

Solution

1. Step 1: Understand template logic in Flask

   Flask uses Jinja2 templating, which supports {% if %} statements to conditionally render content.

2. Step 2: Use Jinja2 syntax to check error existence

   Inside the template, you write {% if error %} to check if the error variable has a value before showing it.

3. Final Answer:

   Use a Jinja2 {% if error %} condition to check if the error variable is set. -> Option D

4. Quick Check:

   Jinja2 if condition = B [OK]

Hint: Use Jinja2 {% if %} to show errors only when present [OK]

Common Mistakes:

• Trying to use Python if statements directly in templates
• Displaying errors without checking if they exist
• Using JavaScript inside templates for error display

2. Which of the following is the correct syntax to display an error message stored in a variable named error inside a Flask template?

easy

A. {{ error }}

B. {% error %}

C. {% display error %}

D. [[ error ]]

Solution

1. Step 1: Recall Jinja2 variable display syntax

   In Flask templates, variables are shown using double curly braces like {{ variable }}.

2. Step 2: Apply to the error variable

   To display the error message stored in error, use {{ error }}.

3. Final Answer:

   {{ error }} -> Option A

4. Quick Check:

   Variable display uses {{ }} = A [OK]

Hint: Use {{ variable }} to show values in Flask templates [OK]

Common Mistakes:

• Using {% %} which is for logic, not display
• Using incorrect brackets like [[ ]]
• Trying to use custom tags like {% display %}

3. Given this Flask template snippet:

{% if errors %}
  
{{ errors[0] }}
{% endif %}

And the variable errors is a list: ["Invalid email"], what will be rendered?

medium

A. No output because errors is a list

B. errors[0]

C. Invalid email

D. Syntax error in template

Solution

1. Step 1: Check the condition {% if errors %}

   The list errors contains one item, so it is truthy and the block runs.

2. Step 2: Render the first error message

   The template outputs {{ errors[0] }} which is "Invalid email" inside a div with class "error".

3. Final Answer:

   <div class="error">Invalid email</div> -> Option C

4. Quick Check:

   Truthy list shows first error = C [OK]

Hint: If list has items, {% if list %} is true and shows first element [OK]

Common Mistakes:

• Thinking lists can't be checked in if conditions
• Expecting literal text 'errors[0]' instead of value
• Assuming syntax error due to list indexing

4. You wrote this Flask template code to show errors:

{% if error %}
  
{{ error }}
{% endif %}

But no error message shows even when you pass error='Invalid input' from Flask. What is the likely problem?

medium

A. Flask templates cannot display error messages.

B. The variable name in the template does not match the one passed from Flask.

C. The {% if %} block is not valid syntax.

D. You must use {{ error.message }} to display the error.

Solution

1. Step 1: Check variable names consistency

   If the Flask code passes error but the template uses a different variable name or none, the condition fails.

2. Step 2: Confirm template uses the exact variable name

   The template must use the same variable name error to display the message correctly.

3. Final Answer:

   Variable name mismatch causes no display. -> Option B

4. Quick Check:

   Variable name mismatch = D [OK]

Hint: Ensure template variable names match Flask context keys exactly [OK]

Common Mistakes:

• Assuming error is an object needing .message
• Thinking {% if %} syntax is wrong
• Believing Flask templates can't show errors

5. You want to display multiple error messages in a Flask template, but only if they exist. Which template code correctly shows all errors from a list errors with accessible markup?

hard

A. {% if errors %}

{% for e in errors %}
{{ e }}
{% endfor %}

{% endif %}

B. {% for e in errors %}
{{ e }}
{% endfor %}

C. {% if errors %}
{{ errors }}
{% endif %}

D.
{{ errors }}

Solution

1. Step 1: Check for errors existence before display

   Using {% if errors %} ensures the list is not empty before rendering.

2. Step 2: Loop through errors with {% for %} and use accessible markup

   Each error is shown in a list item inside a <ul> with aria-live="polite" for screen readers.

3. Final Answer:

   {% if errors %} with {% for %} loop in accessible <ul aria-live="polite"> -> Option A

4. Quick Check:

   Check if errors + loop + aria-live = A [OK]

Hint: Use {% if %} + {% for %} + aria-live for accessible error lists [OK]

Common Mistakes:

• Not checking if errors exist before looping
• Displaying the whole list as a string
• Missing accessibility attributes for screen readers