Messages framework for flash messages in Django - Step-by-Step Execution

Concept Flow - Messages framework for flash messages

View adds message

↓

Message stored in session

↓

Redirect or render response

↓

Template reads messages

↓

Messages displayed to user

↓

Messages cleared from session

The view adds a message which is saved in the session. Then the template reads and shows it once, after which the message is removed.

Execution Sample

Django

from django.contrib import messages
from django.shortcuts import redirect

def my_view(request):
    messages.success(request, 'Profile updated!')
    return redirect('home')

This code adds a success flash message and redirects the user to the home page.

Execution Table

Step	Action	Message Storage	Template Reads	Message Displayed
1	View calls messages.success()	Message added to session storage	No	No
2	Redirect to 'home' triggered	Message remains in session	No	No
3	Template renders on 'home' page	Message available in session	Yes	Yes: 'Profile updated!'
4	After rendering, message cleared from session	Session message removed	No	No

💡 Message is removed after being displayed once to avoid repeated showing.

Variable Tracker

Variable	Start	After Step 1	After Step 2	After Step 3	Final
messages in session	empty	['Profile updated!']	['Profile updated!']	empty	empty

Key Moments - 3 Insights

Why does the message disappear after one page load?

Because the messages framework stores messages in the session and clears them after the template reads and displays them, as shown in execution_table step 4.

Can messages be added without redirecting?

Yes, messages can be added and displayed on the same page render, but they still follow the same lifecycle of being stored and then cleared after display (see execution_table steps 1 and 3).

Where are messages stored temporarily?

Messages are stored in the user's session between requests, as shown in the 'Message Storage' column of the execution_table.

Visual Quiz - 3 Questions

Look at the execution table, at which step does the template read the message?

A Step 1

B Step 2

C Step 3

D Step 4

💡 Hint

Check the 'Template Reads' column in the execution_table.

According to the variable tracker, what happens to messages in session after step 4?

A They remain stored

B They are cleared

C They double in number

D They move to cookies

💡 Hint

Look at the 'Final' column for 'messages in session' in variable_tracker.

If the view does not redirect but renders a template directly, when will the message be cleared?

A After template renders

B Immediately after adding

C Before template renders

D Never cleared

💡 Hint

Refer to the flow where messages are cleared after being displayed in the template.

Concept Snapshot

Django messages framework lets views add flash messages stored in session.
Messages show once in the next template render and then clear automatically.
Use messages.success(), messages.error(), etc. to add messages.
Templates access messages via the 'messages' context variable.
Messages survive redirects and disappear after display.

Full Transcript

The Django messages framework allows a view to add temporary flash messages that inform users about actions like success or errors. When a view calls a function like messages.success(), the message is saved in the user's session. After the view redirects or renders a response, the template can read these messages from the session and display them to the user. Once displayed, the messages are cleared from the session so they do not appear again. This process ensures messages appear only once, providing clear feedback without clutter. The execution table shows each step: adding the message, redirecting, rendering the template, displaying the message, and clearing it. The variable tracker confirms the message's presence in the session until it is shown. This framework helps keep user feedback simple and effective.

Practice

1. What is the main purpose of Django's messages framework?

easy

A. To handle user authentication and login

B. To display one-time notification messages to users

C. To store user data permanently in the database

D. To manage URL routing in the application

Solution

1. Step 1: Understand the role of messages framework

   The messages framework is designed to show temporary messages to users, such as success or error notifications.

2. Step 2: Compare with other Django features

   Other options like authentication, URL routing, or data storage are handled by different Django components, not messages.

3. Final Answer:

   To display one-time notification messages to users -> Option B

4. Quick Check:

   Messages framework = one-time notifications [OK]

Hint: Messages framework shows temporary user notifications [OK]

Common Mistakes:

• Confusing messages with database storage
• Thinking messages handle user login
• Mixing messages with URL routing

2. Which of the following is the correct way to add a success message in a Django view using the messages framework?

easy

A. messages.success(request, 'Operation completed')

B. messages.add(request, messages.SUCCESS, 'Operation completed')

C. messages.send(request, 'Operation completed', level='success')

D. messages.create(request, 'Operation completed', messages.SUCCESS)

Solution

1. Step 1: Recall the correct method to add messages

   Django's messages framework provides shortcut methods like messages.success(request, message) to add messages easily.

2. Step 2: Check other options for syntax correctness

   Options A, C, and D use incorrect method names or argument orders that do not match Django's API.

3. Final Answer:

   messages.success(request, 'Operation completed') -> Option A

4. Quick Check:

   Use messages.success() to add success messages [OK]

Hint: Use messages.success(request, message) for success messages [OK]

Common Mistakes:

• Using non-existent methods like add or send
• Passing arguments in wrong order
• Confusing message level parameter

3. Given this Django view code snippet, what will be the output in the template if messages are displayed correctly?

from django.contrib import messages

def my_view(request):
    messages.error(request, 'Error occurred')
    messages.info(request, 'Information message')
    return render(request, 'template.html')

medium

A. No messages will be shown unless manually added in template

B. Only 'Error occurred' will be shown, 'Information message' ignored

C. Both 'Error occurred' and 'Information message' will be shown once

D. Messages will repeat every time the page reloads

Solution

1. Step 1: Understand message adding in the view

   Two messages with different levels (error and info) are added to the request.

2. Step 2: Know how messages display in template

   If the template includes the proper code to loop and show messages, both messages appear once and disappear on reload.

3. Final Answer:

   Both 'Error occurred' and 'Information message' will be shown once -> Option C

4. Quick Check:

   All added messages show once if template displays them [OK]

Hint: All added messages show once if template loops over messages [OK]

Common Mistakes:

• Assuming only one message level shows
• Thinking messages persist after reload
• Forgetting to add template code to display messages

4. Identify the error in this Django view code using the messages framework:

from django.contrib import messages

def my_view(request):
    messages.error('Error occurred')
    return render(request, 'template.html')

medium

A. Template name should be 'messages.html' to show messages

B. Using 'error' instead of 'danger' for message level

C. Messages framework not imported correctly

D. Missing 'request' argument in messages.error() call

Solution

1. Step 1: Check messages.error() method signature

   The first argument must be the request object, but it is missing here.

2. Step 2: Verify other parts of the code

   Import is correct, message level 'error' is valid, and template name can be any valid template.

3. Final Answer:

   Missing 'request' argument in messages.error() call -> Option D

4. Quick Check:

   messages.error() needs request as first argument [OK]

Hint: Always pass request as first argument to messages methods [OK]

Common Mistakes:

• Omitting request argument in messages calls
• Confusing message levels with CSS classes
• Assuming template name must be specific for messages

5. You want to display a success message after a form submission and then redirect the user to the homepage. Which is the correct way to do this using Django's messages framework?

hard

A. messages.success(request, 'Form submitted successfully')\nreturn redirect('home')

B. messages.success('Form submitted successfully')\nreturn redirect('home')

C. messages.add(request, messages.SUCCESS, 'Form submitted successfully')\nreturn render(request, 'home.html')

D. messages.info(request, 'Form submitted successfully')\nreturn redirect('home')

Solution

1. Step 1: Add a success message with correct syntax

   Use messages.success(request, message) to add a success-level message.

2. Step 2: Redirect after adding the message

   Use redirect('home') to send the user to the homepage, ensuring the message appears on the next page load.

3. Final Answer:

   messages.success(request, 'Form submitted successfully') return redirect('home') -> Option A

4. Quick Check:

   Success message + redirect = messages.success(request, 'Form submitted successfully')\nreturn redirect('home') [OK]

Hint: Add message then redirect to show flash message on next page [OK]

Common Mistakes:

• Forgetting to pass request to messages.success
• Using messages.info instead of success for success feedback
• Rendering template instead of redirecting after message