Template fragment caching in Django - Mini Project: Build & Apply

Django Template Fragment Caching

📖 Scenario: You are building a blog page in Django. Some parts of the page, like the list of recent posts, do not change often. To make the page load faster, you want to save (cache) that part of the page so Django can reuse it without rebuilding every time.

🎯 Goal: Learn how to use Django's template fragment caching to save and reuse parts of a template for faster page loading.

📋 What You'll Learn

Create a Django template with a list of recent posts

Add a cache timeout variable in the template context

Use the cache template tag to cache the recent posts fragment

Set the cache timeout using the variable

💡 Why This Matters

🌍 Real World

Caching parts of a web page helps websites load faster by reusing content that does not change often.

💼 Career

Knowing how to use Django's template fragment caching is useful for web developers to optimize performance and improve user experience.

1

Create the recent posts list in the template

In your Django template, create an unordered list with the class recent-posts. Inside it, add three list items with the exact text: Post 1, Post 2, and Post 3.

Django

Hint

Use <ul> with class recent-posts and three <li> items with the exact post names.

2

Add a cache timeout variable in the template context

In your Django view, create a variable called cache_timeout and set it to 300 (seconds). This variable will control how long the cache lasts.

Django

    Post 1
    Post 2
    Post 3


# Your code here

Hint

Just create a variable named cache_timeout and assign it the value 300.

3

Wrap the recent posts list with the cache template tag

In your Django template, wrap the <ul class="recent-posts"> block with the {% cache %} template tag. Use the cache key 'recent_posts' and the timeout variable cache_timeout. The syntax is {% cache cache_timeout 'recent_posts' %} before the list and {% endcache %} after.

Django

{% load cache %}

# Your code here

    Post 1
    Post 2
    Post 3


cache_timeout = 300

Hint

Use {% cache cache_timeout 'recent_posts' %} before the list and {% endcache %} after it. Also add {% load cache %} at the top.

4

Complete the template fragment caching setup

Make sure the template starts with {% load cache %} to enable caching tags. Confirm the cache block uses the key 'recent_posts' and the timeout variable cache_timeout. The cache block should wrap the entire <ul> list.

Django

{% load cache %}

{% cache cache_timeout 'recent_posts' %}

    Post 1
    Post 2
    Post 3

{% endcache %}

# Your code here

Hint

Check that {% load cache %} is at the top and the cache block wraps the list with the correct key and timeout.

Practice

1. What is the main purpose of using {% cache %} in Django templates?

easy

A. To permanently store user data in the database

B. To save a part of the page output and reuse it to speed up loading

C. To encrypt sensitive information in the template

D. To validate form inputs before rendering

Solution

1. Step 1: Understand what template fragment caching does

   Template fragment caching stores the rendered output of a part of a template to avoid re-rendering it every time.

2. Step 2: Identify the purpose of the {% cache %} tag

   The {% cache %} tag is used to wrap parts of a template that should be cached for faster page loads.

3. Final Answer:

   To save a part of the page output and reuse it to speed up loading -> Option B

4. Quick Check:

   Template fragment caching = save and reuse output [OK]

Hint: Cache stores parts of page output to speed loading [OK]

Common Mistakes:

• Thinking cache stores user data permanently
• Confusing cache with encryption
• Using cache tag for form validation

2. Which of the following is the correct syntax to cache a template fragment for 300 seconds with key 'sidebar'?

easy

A. {% cache 300 sidebar %} ... {% endcache %}

B. {% cache sidebar 300 %} ... {% endcache %}

C. {% cache 'sidebar' 300 %} ... {% endcache %}

D. {% cache 300 'sidebar' %} ... {% endcache %}

Solution

1. Step 1: Recall the correct order of arguments in the cache tag

   The syntax is {% cache timeout key %} where timeout is an integer and key is a string.

2. Step 2: Match the syntax with the options

   {% cache 300 'sidebar' %} ... {% endcache %} uses 300 as timeout and 'sidebar' as key in correct order and quotes.

3. Final Answer:

   {% cache 300 'sidebar' %} ... {% endcache %} -> Option D

4. Quick Check:

   Cache syntax = timeout then quoted key [OK]

Hint: Timeout first, then quoted key in cache tag [OK]

Common Mistakes:

• Putting key before timeout
• Not quoting the cache key string
• Using variable name without quotes

3. Given this template code:

{% cache 600 'menu' user.id %}

  
Home
  
Profile

{% endcache %}

What happens if user.id changes?

medium

A. A new cache entry is created for the new user.id

B. The cached fragment is reused regardless of user.id

C. The cache is cleared completely

D. An error occurs because user.id cannot be used

Solution

1. Step 1: Understand cache key with extra parameters

   Extra parameters after the key string are used to create a unique cache key per value.

2. Step 2: Effect of changing user.id on cache

   When user.id changes, Django creates a new cache entry for that user, so the fragment is cached separately.

3. Final Answer:

   A new cache entry is created for the new user.id -> Option A

4. Quick Check:

   Cache key + params = unique cache per user [OK]

Hint: Extra params create unique cache keys [OK]

Common Mistakes:

• Assuming cache ignores extra parameters
• Thinking cache clears all entries on param change
• Believing user.id cannot be used in cache tag

4. Identify the error in this template fragment caching usage:

{% cache 'sidebar' 300 %}
Sidebar content
{% endcache %}

medium

A. The timeout and key order is reversed; timeout must come first

B. Missing closing tag {% endcache %}

C. The cache key must be an integer, not a string

D. Cache tag cannot wrap HTML elements

Solution

1. Step 1: Check the order of arguments in the cache tag

   The correct order is timeout (integer) first, then cache key (string).

2. Step 2: Identify the mistake in the given code

   The code uses 'sidebar' first and 300 second, which is reversed.

3. Final Answer:

   The timeout and key order is reversed; timeout must come first -> Option A

4. Quick Check:

   Timeout first, key second in cache tag [OK]

Hint: Timeout always before key in cache tag [OK]

Common Mistakes:

• Swapping timeout and key order
• Forgetting to close cache tag
• Thinking cache tag can't wrap HTML

5. You want to cache a sidebar that shows user-specific data but also updates every 10 minutes. Which is the best way to use template fragment caching?

hard

A. Do not use cache because user data changes

B. {% cache 600 'sidebar' %} ... {% endcache %} to cache once for all users

C. {% cache 600 'sidebar' user.id %} ... {% endcache %} to cache per user for 10 minutes

D. {% cache 'sidebar' 600 user.id %} ... {% endcache %} with wrong argument order

Solution

1. Step 1: Understand caching user-specific data

   To cache user-specific content, include a unique user identifier in the cache key.

2. Step 2: Set cache timeout to 600 seconds (10 minutes)

   Use 600 seconds as timeout to update cache every 10 minutes.

3. Step 3: Verify correct syntax and usage

   {% cache 600 'sidebar' user.id %} ... {% endcache %} to cache per user for 10 minutes uses correct syntax with timeout first, key string second, and user.id as extra parameter.

4. Final Answer:

   {% cache 600 'sidebar' user.id %} ... {% endcache %} to cache per user for 10 minutes -> Option C

5. Quick Check:

   User-specific cache with timeout = {% cache 600 'sidebar' user.id %} ... {% endcache %} to cache per user for 10 minutes [OK]

Hint: Use user.id param and timeout for user-specific cache [OK]

Common Mistakes:

• Caching once for all users ignoring user.id
• Swapping timeout and key order
• Avoiding cache for user data unnecessarily