Session framework configuration in Django - Mini Project: Build & Apply

Session Framework Configuration in Django

📖 Scenario: You are building a simple Django web application that needs to remember user information across different pages. To do this, you will configure Django's session framework step-by-step.

🎯 Goal: Configure Django's session framework by setting up the session engine, adding session middleware, and using sessions in a view.

📋 What You'll Learn

Create a Django setting for the session engine

Add session middleware to the middleware list

Write a view function that sets a session variable

Write a view function that reads the session variable

💡 Why This Matters

🌍 Real World

Web applications often need to remember user information like login status or preferences across pages. Django's session framework helps store this data securely on the server.

💼 Career

Understanding session management is essential for backend web developers working with Django to build user-friendly and secure web applications.

1

Set the session engine in Django settings

In the Django settings file, create a variable called SESSION_ENGINE and set it to the string 'django.contrib.sessions.backends.db' to use the database-backed session engine.

Django

# Your code here

Hint

The session engine controls where session data is stored. The database backend is the default and stores sessions in your database.

2

Add session middleware to the middleware list

In the Django settings file, add the string 'django.contrib.sessions.middleware.SessionMiddleware' to the MIDDLEWARE list. Make sure it is included as one of the middleware entries.

Django

SESSION_ENGINE = 'django.contrib.sessions.backends.db'
MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'django.middleware.common.CommonMiddleware',
    # Add session middleware below
]

Hint

Middleware processes requests and responses. SessionMiddleware enables session support in your app.

3

Create a view that sets a session variable

In your Django views file, write a function called set_session that takes a request argument and sets request.session['favorite_color'] to the string 'blue'. Return a simple HttpResponse with the text 'Session set'.

Django

SESSION_ENGINE = 'django.contrib.sessions.backends.db'
MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
]

from django.http import HttpResponse

def set_session(request):
    # Your code here

Hint

Use request.session like a dictionary to store data for the user.

4

Create a view that reads the session variable

In your Django views file, write a function called get_session that takes a request argument and reads the value of request.session['favorite_color']. Return an HttpResponse with the text 'Favorite color is: ' followed by the session value. Use request.session.get('favorite_color', 'unknown') to avoid errors if the session key is missing.

Django

SESSION_ENGINE = 'django.contrib.sessions.backends.db'
MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
]

from django.http import HttpResponse

def set_session(request):
    request.session['favorite_color'] = 'blue'
    return HttpResponse('Session set')

def get_session(request):
    # Your code here

Hint

Use request.session.get() to safely read session data with a default value.

Practice

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

easy

A. To store static files like images and CSS

B. To handle database migrations automatically

C. To remember user data between different pages

D. To manage user authentication only

Solution

1. Step 1: Understand session framework role

   Django sessions store data to keep track of users as they move between pages.

2. Step 2: Compare options with session purpose

   Only To remember user data between different pages describes remembering user data between pages, which is the session's job.

3. Final Answer:

   To remember user data between different pages -> Option C

4. Quick Check:

   Sessions remember users = B [OK]

Hint: Sessions remember users across pages, not files or migrations [OK]

Common Mistakes:

• Confusing sessions with static file storage
• Thinking sessions only handle login
• Mixing sessions with database migrations

2. Which setting in settings.py specifies the backend storage for sessions?

easy

A. SESSION_ENGINE

B. SESSION_COOKIE_AGE

C. SESSION_SAVE_EVERY_REQUEST

D. SESSION_EXPIRE_AT_BROWSER_CLOSE

Solution

1. Step 1: Identify session backend setting

   The setting that controls where sessions are stored is SESSION_ENGINE.

2. Step 2: Review other options

   Other options control cookie age, saving behavior, or expiration, not storage backend.

3. Final Answer:

   SESSION_ENGINE -> Option A

4. Quick Check:

   Backend storage = SESSION_ENGINE [OK]

Hint: SESSION_ENGINE sets storage backend, not cookie or expiration [OK]

Common Mistakes:

• Confusing SESSION_ENGINE with cookie age
• Mixing save behavior with storage backend
• Assuming expiration settings control storage

3. Given this settings.py snippet:

SESSION_ENGINE = 'django.contrib.sessions.backends.cache'
SESSION_COOKIE_AGE = 1209600  # 2 weeks
SESSION_EXPIRE_AT_BROWSER_CLOSE = False

What happens when a user closes and reopens their browser?

medium

A. The session cookie is deleted but data remains in cache

B. The session expires immediately on browser close

C. The session is stored in the database and expires on logout

D. The session is kept for 2 weeks and user stays logged in

Solution

1. Step 1: Analyze SESSION_EXPIRE_AT_BROWSER_CLOSE

   It is set to False, so session cookies do not expire when browser closes.

2. Step 2: Check SESSION_COOKIE_AGE

   Set to 2 weeks, so session lasts that long unless user logs out.

3. Final Answer:

   The session is kept for 2 weeks and user stays logged in -> Option D

4. Quick Check:

   Expire at close = False means session kept [OK]

Hint: False expire at close means session lasts cookie age [OK]

Common Mistakes:

• Assuming session expires on browser close by default
• Confusing cache backend with database storage
• Thinking cookie deletion removes session data immediately

4. You set SESSION_ENGINE = 'django.contrib.sessions.backends.file' but get errors about missing directories. What is the likely cause?

medium

A. The session file directory does not exist or lacks write permission

B. SESSION_ENGINE value is invalid and causes syntax error

C. You forgot to add sessions to INSTALLED_APPS

D. SESSION_COOKIE_AGE is set too low causing session loss

Solution

1. Step 1: Understand file backend requirements

   The file backend stores sessions in files, needing a writable directory.

2. Step 2: Identify cause of errors

   If directory is missing or not writable, errors occur when saving sessions.

3. Final Answer:

   The session file directory does not exist or lacks write permission -> Option A

4. Quick Check:

   File backend needs writable directory [OK]

Hint: File backend needs writable folder, else errors occur [OK]

Common Mistakes:

• Assuming SESSION_ENGINE value syntax is wrong
• Forgetting sessions are built-in, no INSTALLED_APPS needed
• Blaming cookie age for file write errors

5. You want sessions to expire when the user closes the browser but also want to keep sessions for 1 hour if the browser stays open. Which settings combination achieves this?

hard

A. SESSION_EXPIRE_AT_BROWSER_CLOSE = False and SESSION_COOKIE_AGE = 3600

B. SESSION_EXPIRE_AT_BROWSER_CLOSE = True and SESSION_COOKIE_AGE = 3600

C. SESSION_EXPIRE_AT_BROWSER_CLOSE = True and SESSION_COOKIE_AGE = None

D. SESSION_EXPIRE_AT_BROWSER_CLOSE = False and SESSION_COOKIE_AGE = None

Solution

1. Step 1: Understand SESSION_EXPIRE_AT_BROWSER_CLOSE

   Setting it to True makes the session expire when browser closes.

2. Step 2: Understand SESSION_COOKIE_AGE

   Setting it to 3600 seconds (1 hour) limits session lifetime if browser stays open.

3. Final Answer:

   SESSION_EXPIRE_AT_BROWSER_CLOSE = True and SESSION_COOKIE_AGE = 3600 -> Option B

4. Quick Check:

   Expire at close True + 1 hour age = A [OK]

Hint: Expire at close True + cookie age limits session time [OK]

Common Mistakes:

• Setting expire at close False when wanting session to end on close
• Using None for cookie age disables expiration
• Confusing cookie age with session storage backend