Flash messages for user feedback in Flask - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a flash message in Flask?

A flash message is a short message stored temporarily to show feedback to the user, like success or error notices, after a page reload or redirect.

beginner

How do you add a flash message in Flask?

Use the flash() function with a message string inside a route function, for example: flash('Profile updated successfully!').

beginner

How do you display flash messages in a Flask template?

Use a loop over get_flashed_messages() in your HTML template to show each message, often inside a styled alert box.

beginner

Why are flash messages useful in web apps?

They provide clear, temporary feedback to users about actions like form submissions, helping users understand what happened without extra clicks.

intermediate

What must you set in Flask to use flash messages securely?

You must set a secret key in your Flask app (e.g., app.secret_key = 'your_secret') to securely sign the session data used by flash messages.

Which Flask function is used to create a flash message?

A flash()

B message()

C notify()

D alert()

The flash() function is the built-in Flask method to create flash messages.

Where do flash messages get stored temporarily in Flask?

A In the session

B In the database

C In a cookie

D In a file

Flash messages are stored in the user's session, which requires a secret key.

How do you retrieve flash messages in a Flask template?

A Using fetch_messages()

B Using get_flashed_messages()

C Using show_flash()

D Using get_messages()

The get_flashed_messages() function returns all flash messages for display.

What must you set in your Flask app to enable flash messages?

A app.config['FLASH'] = True

B app.debug = True

C app.secret_key

D app.session_enabled = True

Setting app.secret_key is required to securely sign session data including flash messages.

Flash messages are best used for:

A Logging errors on the server

B Storing user preferences permanently

C Sending emails to users

D Temporary user feedback after actions

Flash messages provide temporary feedback to users, such as success or error notices.

Explain how to create and display a flash message in a Flask app.

Think about what you do in the Python code and what you do in the HTML template.

Why is setting a secret key important when using flash messages in Flask?

Consider how Flask keeps session data safe.

Practice

1. What is the main purpose of using flash() in a Flask application?

easy

A. To create a new route in the Flask app

B. To permanently store user data in the session

C. To send a one-time message to the user after a request

D. To handle database connections automatically

Solution

1. Step 1: Understand the role of flash messages

   Flash messages are temporary messages shown to users after actions like form submission.

2. Step 2: Identify what flash() does

   The flash() function stores these messages to be displayed once, then removed.

3. Final Answer:

   To send a one-time message to the user after a request -> Option C

4. Quick Check:

   Flash messages = one-time user feedback [OK]

Hint: Flash messages show temporary feedback after user actions [OK]

Common Mistakes:

• Thinking flash stores data permanently
• Confusing flash with routing or database functions
• Assuming flash messages appear multiple times

2. Which of the following is the correct way to import and use flash in a Flask app?

easy

A. from flask import flash; flash('Message')

B. import flash from flask; flash('Message')

C. from flask.flash import flash; flash('Message')

D. import flask.flash; flask.flash('Message')

Solution

1. Step 1: Recall correct import syntax in Flask

   Functions like flash are imported directly from the flask package using from flask import flash.

2. Step 2: Check usage after import

   After importing, calling flash('Message') is the correct way to flash a message.

3. Final Answer:

   from flask import flash; flash('Message') -> Option A

4. Quick Check:

   Correct import and call = from flask import flash; flash('Message') [OK]

Hint: Use 'from flask import flash' to import flash [OK]

Common Mistakes:

• Using incorrect import syntax
• Trying to import flash as a submodule
• Calling flash without importing

3. Given this Flask code snippet, what will be the output on the rendered page?

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!', 'info')
    messages = get_flashed_messages(with_categories=True)
    return render_template_string('''
        {% for category, message in messages %}
            <div class="{{ category }}">{{ message }}</div>
        {% endfor %}
    ''', messages=messages)

medium

A. No output because flash messages are empty

B. Welcome back!

C. SyntaxError due to incorrect template syntax

D. Welcome back!

Solution

1. Step 1: Understand flash message with category

   The code flashes a message 'Welcome back!' with category 'info'. Using get_flashed_messages(with_categories=True) returns a list of (category, message) tuples.

2. Step 2: Analyze template rendering

   The template loops over messages and creates a div with class set to the category and content as the message. So it outputs <div class="info">Welcome back!</div>.

3. Final Answer:

   <div class="info">Welcome back!</div> -> Option D

4. Quick Check:

   Flash with category 'info' outputs div with class 'info' [OK]

Hint: Flash with categories outputs div with category as class [OK]

Common Mistakes:

• Ignoring categories and using wrong class name
• Assuming flash messages are empty immediately
• Misreading template syntax causing syntax error

4. What is wrong with this Flask code that tries to flash a message?

from flask import Flask, flash
app = Flask(__name__)

@app.route('/')
def index():
    flash('Hello user!')
    return 'Done'

medium

A. Flash messages must be returned, not just called

B. Missing app.secret_key causes flash to fail

C. Flash requires a category argument

D. Flash cannot be used inside route functions

Solution

1. Step 1: Recall flash message requirements

   Flashing messages requires session support, which needs app.secret_key to be set.

2. Step 2: Identify missing secret key

   The code does not set app.secret_key, so flashing will not work properly and may raise an error.

3. Final Answer:

   Missing app.secret_key causes flash to fail -> Option B

4. Quick Check:

   Secret key needed for flash session [OK]

Hint: Always set app.secret_key before using flash [OK]

Common Mistakes:

• Forgetting to set secret_key
• Thinking flash needs category argument
• Believing flash must be returned

5. You want to show different flash messages with categories 'success' and 'error' after form submission. Which code snippet correctly flashes both messages and displays them in a template with distinct styles?

hard

A. flash('Form submitted!', 'success')\nflash('Invalid input', 'error')\nreturn render_template('index.html')\n
\n{% for category, msg in get_flashed_messages(with_categories=True) %}\n {{ msg }}\n{% endfor %}

B. flash('Form submitted!')\nflash('Invalid input')\nreturn render_template('index.html')\n
\n{% for msg in get_flashed_messages() %}\n {{ msg }}\n{% endfor %}

C. flash('Form submitted!', type='success')\nflash('Invalid input', type='error')\nreturn render_template('index.html')\n
\n{% for category, msg in get_flashed_messages(with_categories=True) %}\n {{ msg }}\n{% endfor %}

D. flash('Form submitted!', 'success')\nflash('Invalid input', 'error')\nreturn render_template('index.html', messages=get_flashed_messages())\n
\n{% for category, msg in messages %}\n {{ msg }}\n{% endfor %}

Solution

1. Step 1: Flash messages with categories

   Use flash('message', 'category') -- category as the second positional argument.

2. Step 2: Retrieve messages with categories in template

   Loop over get_flashed_messages(with_categories=True) directly in the template to unpack (category, message) and apply class="{{ category }}" for distinct styles.

3. Step 3: Distractors fail because

   No categories provided; invalid keyword argument like type='success' raises TypeError; retrieving without with_categories=True returns strings causing unpack error in for category, msg in messages.

4. Final Answer:

   flash('Form submitted!', 'success'); flash('Invalid input', 'error'); template with get_flashed_messages(with_categories=True) -> Option A

5. Quick Check:

   Flash with categories + template loop with categories = flash('Form submitted!', 'success')\nflash('Invalid input', 'error')\nreturn render_template('index.html')\n \n{% for category, msg in get_flashed_messages(with_categories=True) %}\n

   {{ msg }}

   \n{% endfor %} [OK]

Hint: Flash with category, get_flashed_messages(with_categories=True) in template [OK]

Common Mistakes:

• Not passing with_categories=True when retrieving messages
• Using invalid keyword argument like type= for category
• Passing messages without categories to template expecting categories