ListView for displaying collections in Django - Mini Project: Build & Apply

ListView for displaying collections

📖 Scenario: You are building a simple web app to show a list of books in a library. You want to display all books on a page using Django's built-in ListView to make it easy and clean.

🎯 Goal: Create a Django ListView to display a list of books from a model called Book. You will set up the model, configure the view, and connect it to a template to show the book titles.

📋 What You'll Learn

Create a Book model with a title field

Create a BookListView using Django's ListView

Set the view to use the Book model and a template named book_list.html

Add the URL pattern to connect the view to the path /books/

Create a simple template to display all book titles in an unordered list

💡 Why This Matters

🌍 Real World

Displaying lists of items like products, articles, or users is common in web apps. Django's ListView makes this easy and clean.

💼 Career

Understanding Django's generic views and templates is essential for backend web development jobs using Django.

1

Create the Book model

Create a Django model called Book with a single field title that is a CharField with max length 100.

Django

# Your code here

Hint

Use models.CharField(max_length=100) for the title field inside the Book model.

2

Create the BookListView

Create a Django class-based view called BookListView that inherits from ListView. Set its model attribute to Book and template_name to 'book_list.html'.

Django

from django.views.generic import ListView

# Your code here

Hint

Import ListView from django.views.generic and set the model and template_name attributes in your view.

3

Add URL pattern for BookListView

In your Django app's urls.py, import BookListView and add a URL pattern that maps the path 'books/' to BookListView.as_view(). Name this URL pattern 'book-list'.

Django

from django.urls import path
from .views import BookListView

# Your code here

Hint

Use path('books/', BookListView.as_view(), name='book-list') inside urlpatterns.

4

Create the book_list.html template

Create a Django template named book_list.html that loops over the object_list context variable and displays each book's title inside an unordered list (<ul>).

Django

{% comment %} Your code here {% endcomment %}

Hint

Use a {% for book in object_list %} loop and display {{ book.title }} inside <li> tags.

Practice

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

easy

A. To display a list of objects from the database in a web page

B. To handle user login and authentication

C. To create forms for user input

D. To manage database migrations

Solution

1. Step 1: Understand ListView's role

   ListView is a Django generic view designed to show lists of database items easily.

2. Step 2: Compare with other options

   Other options like login, forms, and migrations are handled by different Django components.

3. Final Answer:

   To display a list of objects from the database in a web page -> Option A

4. Quick Check:

   ListView shows lists = C [OK]

Hint: ListView always shows lists of data from the database [OK]

Common Mistakes:

• Confusing ListView with form or login views
• Thinking ListView manages database changes
• Assuming ListView handles user authentication

2. Which of the following is the correct way to specify the model for a Django ListView?

easy

A. model: MyModel

B. model = MyModel

C. models = MyModel

D. Model = MyModel

Solution

1. Step 1: Recall ListView syntax

   In Django, the model is set with a lowercase 'model' attribute inside the ListView class.

2. Step 2: Check other options

   Capitalized 'Model', plural 'models', or colon syntax are incorrect in Python class attributes.

3. Final Answer:

   model = MyModel -> Option B

4. Quick Check:

   Use lowercase 'model' attribute = D [OK]

Hint: Use lowercase 'model' to set the model in ListView [OK]

Common Mistakes:

• Capitalizing 'Model' instead of 'model'
• Using plural 'models' attribute
• Using colon instead of equals sign

3. Given this ListView code:

class BookListView(ListView):
    model = Book
    paginate_by = 3

What will happen when there are 7 books in the database?

medium

A. The page will show 3 books on the first two pages and 1 book on the last page

B. The page will show 3 books per page with 3 pages total

C. The page will show all 7 books at once

D. The page will show 7 books but only 3 will be clickable

Solution

1. Step 1: Understand pagination setting

   paginate_by = 3 means each page shows 3 items.

2. Step 2: Calculate pages for 7 books

   7 books divided by 3 per page gives 3 pages: two full pages (3 books each) and one page with 1 book.

3. Final Answer:

   The page will show 3 books on the first two pages and 1 book on the last page -> Option A

4. Quick Check:

   7 books, 3 per page = 3 pages, last page 1 book [OK]

Hint: Divide total items by paginate_by to find pages and last page count [OK]

Common Mistakes:

• Assuming all items show on one page ignoring pagination
• Calculating wrong number of pages
• Thinking some items are not shown or clickable

4. What is wrong with this ListView code?

class AuthorListView(ListView):
    model = Author
    template = 'authors.html'

medium

A. ListView does not support custom templates

B. The model name should be lowercase

C. The attribute should be 'template_name' not 'template'

D. The class must inherit from TemplateView instead

Solution

1. Step 1: Check attribute for template

   ListView uses 'template_name' to specify the template file, not 'template'.

2. Step 2: Verify other options

   Model names are class names and should be capitalized; ListView supports custom templates; inheritance from ListView is correct.

3. Final Answer:

   The attribute should be 'template_name' not 'template' -> Option C

4. Quick Check:

   Use 'template_name' to set template in ListView [OK]

Hint: Use 'template_name' attribute to set template file [OK]

Common Mistakes:

• Using 'template' instead of 'template_name'
• Changing model class name case
• Thinking ListView can't use custom templates

5. You want to display a list of Product items but with the context variable named items instead of the default product_list. How do you customize the ListView to do this?

hard

A. Rename your model to 'items' instead of 'Product'

B. Set template_name = 'items.html' to change the context variable

C. Override the get_queryset method to return 'items'

D. Set context_object_name = 'items' in your ListView subclass

Solution

1. Step 1: Identify how to rename context variable

   Django ListView uses 'context_object_name' to change the default variable name in the template.

2. Step 2: Check other options

   Renaming model changes database class, not context variable; get_queryset returns data, not variable name; template_name changes template file, not context variable.

3. Final Answer:

   Set context_object_name = 'items' in your ListView subclass -> Option D

4. Quick Check:

   Use 'context_object_name' to rename list variable [OK]

Hint: Use 'context_object_name' to rename list variable in template [OK]

Common Mistakes:

• Trying to rename model class to change context variable
• Overriding get_queryset to rename variable (wrong purpose)
• Changing template_name expecting variable rename