Flash message categories in Flask

Introduction

Flash message categories help organize messages by type, like success or error. This makes it easy to show different styles for each message.

When you want to show a success message after a user submits a form.

When you need to display error messages for invalid input.

When you want to give informational messages like 'Profile updated'.

When you want to style messages differently based on their meaning.

When you want to group messages for better user experience.

Syntax

Flask

flash(message, category)

# Example:
flash('Login successful', 'success')

The category is optional but helps separate message types.

Common categories: success, error, warning, info.

Examples

This shows a success message.

Flask

flash('Data saved successfully', 'success')

This shows an error message.

Flask

flash('Invalid password', 'error')

This shows an informational message.

Flask

flash('Remember to verify your email', 'info')

Sample Program

This Flask app flashes three messages with different categories. The template shows each message styled by its category color.

Flask

from flask import Flask, flash, render_template_string, get_flashed_messages

app = Flask(__name__)
app.secret_key = 'secret'

@app.route('/')
def index():
    flash('Welcome back!', 'success')
    flash('Your password will expire soon.', 'warning')
    flash('Failed to load profile picture.', 'error')
    messages = get_flashed_messages(with_categories=True)
    html = '''
    <!DOCTYPE html>
    <html lang="en">
    <head>
      <meta charset="UTF-8">
      <meta name="viewport" content="width=device-width, initial-scale=1.0">
      <title>Flash Messages</title>
      <style>
        .success { color: green; }
        .error { color: red; }
        .warning { color: orange; }
      </style>
    </head>
    <body>
      <h1>Flash Messages</h1>
      <ul>
        {% for category, message in messages %}
          <li class="{{ category }}">{{ message }}</li>
        {% endfor %}
      </ul>
    </body>
    </html>
    '''
    return render_template_string(html, messages=messages)

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

Important Notes

Always set secret_key in Flask to use flash messages.

Use get_flashed_messages(with_categories=True) to get both message and category.

Categories help you style messages differently in your HTML.

Summary

Flash message categories label messages by type like success or error.

They help show messages with different styles for better user feedback.

Use flash(message, category) and get messages with categories in templates.

Practice

1. What is the purpose of using categories in Flask flash messages?

easy

A. To encrypt messages for security

B. To store messages permanently in the database

C. To label messages by type like success or error for styling

D. To send messages to different users

Solution

1. Step 1: Understand flash message categories

   Categories help group messages by type, such as 'success' or 'error'.

2. Step 2: Recognize their use in styling

   These categories allow different styles or icons to show user feedback clearly.

3. Final Answer:

   To label messages by type like success or error for styling -> Option C

4. Quick Check:

   Flash message categories = Label messages by type [OK]

Hint: Categories tag messages for style and meaning [OK]

Common Mistakes:

• Thinking categories store messages permanently
• Confusing categories with encryption
• Assuming categories send messages to users

2. Which is the correct syntax to flash a message with a category in Flask?

easy

A. flash('Welcome!', 'info')

B. flash('Welcome!', cat='info')

C. flash('Welcome!', category: 'info')

D. flash('Welcome!').category('info')

Solution

1. Step 1: Recall flash function signature

   Flask's flash function takes message first, then category as second positional argument.

2. Step 2: Identify correct syntax

   Using flash('Welcome!', 'info') correctly passes the category as second argument.

3. Final Answer:

   flash('Welcome!', 'info') -> Option A

4. Quick Check:

   flash(message, category) = flash('Welcome!', 'info') [OK]

Hint: Category is second argument without keyword [OK]

Common Mistakes:

• Using misspelled keyword argument 'cat=' which is invalid
• Using colon instead of comma
• Trying to chain category as method

3. Given this Flask code snippet:

flash('Saved successfully', 'success')
flash('Invalid input', 'error')

What will be the categories of the flashed messages retrieved in the template?

medium

A. ['success', 'error']

B. ['info', 'warning']

C. ['error', 'success']

D. ['message', 'alert']

Solution

1. Step 1: Identify categories used in flash calls

   The first flash uses 'success', the second uses 'error' as categories.

2. Step 2: Understand retrieval order

   Messages are retrieved in the order flashed, so categories list is ['success', 'error'].

3. Final Answer:

   ['success', 'error'] -> Option A

4. Quick Check:

   Flashed categories = ['success', 'error'] [OK]

Hint: Categories match second argument in flash() calls [OK]

Common Mistakes:

• Mixing up category names
• Assuming default categories like 'info'
• Reversing order of categories

4. What is wrong with this Flask code snippet?

flash('Error occurred', cat='error')

medium

A. Message string must be a list, not a string

B. Using keyword argument 'cat' causes a TypeError

C. Category must be uppercase like 'ERROR'

D. flash() requires three arguments

Solution

1. Step 1: Check flash function parameters

   flash() accepts message and optional category as positional arguments, not keyword arguments.

2. Step 2: Identify error cause

   Using cat='error' keyword causes TypeError: unexpected keyword argument.

3. Final Answer:

   Using keyword argument 'cat' causes a TypeError -> Option B

4. Quick Check:

   flash() keyword 'cat' = TypeError [OK]

Hint: flash() takes category as second positional argument only [OK]

Common Mistakes:

• Using invalid keyword argument 'cat'
• Assuming category must be uppercase
• Thinking flash needs more than two arguments

5. You want to display flash messages with different colors based on their categories: 'success' in green, 'error' in red, and 'info' in blue. Which approach correctly uses categories in your Flask template?

hard

A. {% for message, category in get_flashed_messages() %} {{ message }}{% endfor %}

B. {% for message in get_flashed_messages() %} {{ message }}{% endfor %}

C. {% for message, category in get_flashed_messages(with_categories=True) %} {{ message }}{% endfor %}

D. {% for category, message in get_flashed_messages(with_categories=True) %} {{ category }}{% endfor %}

Solution

1. Step 1: Use get_flashed_messages with categories

   To access categories, call get_flashed_messages(with_categories=True) which returns (category, message) pairs.

2. Step 2: Correctly unpack and use variables in template

   Unpack as (category, message) and use category in CSS class for styling.

3. Final Answer:

   {% for category, message in get_flashed_messages(with_categories=True) %} <div class="alert alert-{{ category }}">{{ message }}</div> {% endfor %} -> Option D

4. Quick Check:

   Use with_categories=True and unpack (category, message) [OK]

Hint: Use with_categories=True and unpack (category, message) [OK]

Common Mistakes:

• Not using with_categories=True to get categories
• Swapping message and category order
• Using get_flashed_messages() without categories