Django {% for %} Tag

Welcome to The Coding College, where we simplify Django for developers of all skill levels. In this guide, we’ll explore the {% for %} tag, a core feature of Django templates that allows you to dynamically loop through data and render repetitive content.

What Is the {% for %} Tag?

The {% for %} tag is used to iterate over sequences, such as lists, dictionaries, or querysets, and render content for each item. It’s a powerful way to dynamically generate content based on your application’s data.

Basic Syntax

{% for item in sequence %}  
    <!-- Content to render for each item -->  
{% endfor %}

Examples of Using {% for %}

1. Looping Through a List

View Function:

def display_products(request):  
    products = ['Laptop', 'Smartphone', 'Tablet']  
    return render(request, 'products.html', {'products': products})

Template (products.html):

<ul>  
    {% for product in products %}  
        <li>{{ product }}</li>  
    {% endfor %}  
</ul>

Output:

<ul>  
    <li>Laptop</li>  
    <li>Smartphone</li>  
    <li>Tablet</li>  
</ul>

2. Looping Through a Dictionary

View Function:

def user_details(request):  
    user_info = {'name': 'John', 'age': 25, 'country': 'USA'}  
    return render(request, 'user.html', {'user_info': user_info})

Template (user.html):

<ul>  
    {% for key, value in user_info.items %}  
        <li>{{ key }}: {{ value }}</li>  
    {% endfor %}  
</ul>

Output:

<ul>  
    <li>name: John</li>  
    <li>age: 25</li>  
    <li>country: USA</li>  
</ul>

3. Looping Through a QuerySet

View Function:

from .models import Product  

def show_products(request):  
    products = Product.objects.all()  
    return render(request, 'product_list.html', {'products': products})

Template (product_list.html):

<ul>  
    {% for product in products %}  
        <li>{{ product.name }} - ${{ product.price }}</li>  
    {% endfor %}  
</ul>

Using {% empty %} for Empty Sequences

You can use the {% empty %} tag to handle cases where the sequence is empty.

Example:

<ul>  
    {% for product in products %}  
        <li>{{ product }}</li>  
    {% empty %}  
        <li>No products available.</li>  
    {% endfor %}  
</ul>

Built-In Variables in {% for %}

Django provides several built-in variables that are available during iteration:

  1. forloop.counter: Current iteration index (1-based).
  2. forloop.counter0: Current iteration index (0-based).
  3. forloop.revcounter: Remaining iterations (1-based).
  4. forloop.revcounter0: Remaining iterations (0-based).
  5. forloop.first: True if it’s the first iteration.
  6. forloop.last: True if it’s the last iteration.
  7. forloop.parentloop: For nested loops, points to the parent loop.

Example Using Built-In Variables

<ul>  
    {% for product in products %}  
        <li>{{ forloop.counter }}. {{ product }}</li>  
    {% endfor %}  
</ul>

Output:

<ul>  
    <li>1. Laptop</li>  
    <li>2. Smartphone</li>  
    <li>3. Tablet</li>  
</ul>

Nested Loops

You can nest {% for %} loops to iterate through multi-dimensional data.

Example:
View Function:

def show_categories(request):  
    categories = {  
        'Electronics': ['Laptop', 'Smartphone'],  
        'Furniture': ['Chair', 'Table'],  
    }  
    return render(request, 'categories.html', {'categories': categories})

Template (categories.html):

{% for category, items in categories.items %}  
    <h3>{{ category }}</h3>  
    <ul>  
        {% for item in items %}  
            <li>{{ item }}</li>  
        {% endfor %}  
    </ul>  
{% endfor %}

Output:

<h3>Electronics</h3>  
<ul>  
    <li>Laptop</li>  
    <li>Smartphone</li>  
</ul>  

<h3>Furniture</h3>  
<ul>  
    <li>Chair</li>  
    <li>Table</li>  
</ul>

Best Practices for {% for %}

  1. Minimize Logic in Templates: Perform heavy processing in views and pass only the required data.
  2. Handle Empty Sequences: Always use {% empty %} to account for empty data.
  3. Use Meaningful Context Variables: Pass descriptive variable names for better readability.

Debugging {% for %}

  1. Inspect Context Data: Ensure that the data being passed to the template is as expected.
  2. Use Django Debug Toolbar: This tool helps analyze context variables and their values during rendering.
  3. Test Edge Cases: Verify how your template behaves with empty, single-item, and large sequences.

Explore More at The Coding College

Looking to expand your Django expertise? Visit The Coding College for comprehensive tutorials, tips, and insights into web development.

Final Thoughts

The {% for %} tag is an essential tool in Django templates, enabling you to create dynamic and data-driven web pages. By mastering its features and best practices, you’ll unlock the potential to build highly interactive and user-friendly applications.

Stay tuned to The Coding College for more tutorials on Django and beyond!

Leave a Comment