Bird
Raised Fist0
Djangoframework~5 mins

Template fragment caching in Django

Choose your learning style10 modes available
LearnWhyDeepVisualTryChallengeProjectRecallPerf

Start learning this pattern below

Jump into concepts and practice - no test required

or
Recommended
Test this pattern10 questions across easy, medium, and hard to know if this pattern is strong
Introduction

Template fragment caching helps speed up your website by saving parts of a page so they don't have to be rebuilt every time.

When a part of your webpage takes a long time to generate but doesn't change often.
When you want to reduce the load on your server by reusing saved HTML snippets.
When you have a sidebar or menu that stays the same for many users.
When you want to improve page load speed without caching the whole page.
When you want to cache only specific sections like a list of popular articles.
Syntax
Django
{% cache <timeout_in_seconds> <cache_key> %}
  ... template code to cache ...
{% endcache %}

<timeout_in_seconds> is how long the cached content stays saved.

<cache_key> is a unique name for the cached part.

Examples
This caches the sidebar for 10 minutes (600 seconds).
Django
{% cache 600 sidebar %}
  <div>Sidebar content here</div>
{% endcache %}
This caches a user profile section for 5 minutes, using the user's ID to create a unique cache key.
Django
{% cache 300 user_profile user.id %}
  <p>User: {{ user.username }}</p>
{% endcache %}
Sample Program

This template caches the greeting message for 2 minutes. The current time below it updates every time the page loads, showing the difference between cached and dynamic content.

Django
{% load cache %}
<html lang="en">
<head><title>Fragment Cache Example</title></head>
<body>
  <h1>Welcome to my site</h1>

  {% cache 120 greeting %}
    <p>Hello, this message is cached for 2 minutes.</p>
  {% endcache %}

  <p>Current time: {{ now }}</p>
</body>
</html>
OutputSuccess
Important Notes

Make sure caching is enabled in your Django settings for fragment caching to work.

Use unique cache keys to avoid mixing cached content from different parts of your site.

Remember that cached content will not update until the timeout expires or the cache is cleared.

Summary

Template fragment caching saves parts of a page to speed up loading.

Use the {% cache %} tag with a timeout and a unique key.

It helps when only some parts of a page are slow or rarely change.

Practice

(1/5)
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