List display configuration in Django - Mini Project: Build & Apply

List Display Configuration in Django Admin

📖 Scenario: You are building a Django web application to manage a bookstore. You want to customize the Django admin interface to show a list of books with specific details.

🎯 Goal: Configure the Django admin to display a list of books showing the title, author, and published_year columns.

📋 What You'll Learn

Create a Django model called Book with fields title, author, and published_year.

Create an admin class called BookAdmin.

Add a list_display attribute to BookAdmin with the fields title, author, and published_year.

Register the Book model with the BookAdmin class.

💡 Why This Matters

🌍 Real World

Customizing the Django admin list display helps administrators quickly see important information about data entries, improving management efficiency.

💼 Career

Knowing how to configure Django admin is essential for backend developers working with Django to build maintainable and user-friendly admin interfaces.

1

Create the Book model

Create a Django model called Book in models.py with these exact fields: title as a CharField with max length 100, author as a CharField with max length 50, and published_year as an IntegerField.

Django

# Your code here to define the Book model

Hint

Use models.CharField for text fields and models.IntegerField for numbers.

2

Create the BookAdmin class

In admin.py, import admin and the Book model. Then create a class called BookAdmin that inherits from admin.ModelAdmin.

Django

from django.db import models

class Book(models.Model):
    title = models.CharField(max_length=100)
    author = models.CharField(max_length=50)
    published_year = models.IntegerField()

# Your code here to create BookAdmin class

Hint

Remember to import admin and Book before defining BookAdmin.

3

Add list_display to BookAdmin

Add a list_display attribute to the BookAdmin class with the exact list: 'title', 'author', and 'published_year'.

Django

from django.db import models
from django.contrib import admin
from .models import Book

class BookAdmin(admin.ModelAdmin):
    # Your code here to add list_display

Hint

Use a tuple with the field names as strings for list_display.

4

Register Book with BookAdmin

Register the Book model with the BookAdmin class using admin.site.register(Book, BookAdmin).

Django

from django.db import models
from django.contrib import admin
from .models import Book

class BookAdmin(admin.ModelAdmin):
    list_display = ('title', 'author', 'published_year')

# Your code here to register Book with BookAdmin

Hint

Use admin.site.register() with two arguments: the model and the admin class.

Practice

1. In Django admin, what does the list_display attribute control?

easy

A. Which fields or methods appear as columns in the admin list view

B. The order of models in the admin site

C. The fields editable in the admin form

D. The database table names for models

Solution

1. Step 1: Understand the purpose of list_display

   The list_display attribute in Django admin defines which model fields or methods are shown as columns in the list view of the admin interface.

2. Step 2: Differentiate from other admin attributes

   Other attributes like ordering control order, fields control form fields, and database table names are unrelated to list_display.

3. Final Answer:

   Which fields or methods appear as columns in the admin list view -> Option A

4. Quick Check:

   list_display = columns shown [OK]

Hint: Remember: list_display = columns in admin list view [OK]

Common Mistakes:

• Confusing list_display with ordering or form fields
• Thinking list_display changes database schema
• Assuming list_display controls permissions

2. Which of the following is the correct way to set list_display in a Django admin class?

easy

A. list_display = 'field1, field2, method_name'

B. list_display = (field1, field2, method_name)

C. list_display = {'field1', 'field2', 'method_name'}

D. list_display = ['field1', 'field2', 'method_name']

Solution

1. Step 1: Identify the correct data type for list_display

   The list_display attribute expects a list or tuple of strings naming fields or methods. Both list and tuple are valid, but list is most common.

2. Step 2: Analyze each option's syntax

   list_display = ['field1', 'field2', 'method_name'] uses a list with square brackets and strings, which is correct. list_display = (field1, field2, method_name) uses tuple syntax but lacks quotes around the names, treating them as undefined variables (NameError). list_display = {'field1', 'field2', 'method_name'} uses a set, which is unordered and invalid here. list_display = 'field1, field2, method_name' is a string, which is incorrect.

3. Final Answer:

   list_display = ['field1', 'field2', 'method_name'] -> Option D

4. Quick Check:

   list_display uses list syntax [OK]

Hint: Use square brackets for list_display fields [OK]

Common Mistakes:

• Using a string instead of a list or tuple
• Using a set which is unordered
• Forgetting quotes around field names

3. Given this Django admin code snippet, what columns will appear in the admin list view?

class ProductAdmin(admin.ModelAdmin):
    list_display = ['name', 'price', 'discounted_price']

    def discounted_price(self, obj):
        return obj.price * 0.9

medium

A. Columns: name, price, discounted_price but discounted_price shows an error

B. Columns: name, price only; discounted_price is ignored

C. Columns: name, price, discounted_price showing name, price, and 90% of price

D. Only discounted_price column appears

Solution

1. Step 1: Understand list_display with methods

   The list_display includes 'discounted_price', which is a method defined in the admin class. Django calls this method for each object to show the computed value.

2. Step 2: Analyze the method's return value

   The method returns 90% of the product's price, so the column will show the discounted price correctly.

3. Final Answer:

   Columns: name, price, discounted_price showing name, price, and 90% of price -> Option C

4. Quick Check:

   Method in list_display shows computed column [OK]

Hint: Methods in list_display show computed columns [OK]

Common Mistakes:

• Assuming methods in list_display are ignored
• Forgetting to define the method in admin
• Method returning wrong or no value

4. What is wrong with this Django admin code?

class OrderAdmin(admin.ModelAdmin):
    list_display = ['id', 'total_price', 'calculate_tax']

    def calculate_tax(self):
        return self.total_price * 0.1

medium

A. calculate_tax should be a property, not a method

B. The method calculate_tax is missing the obj parameter

C. total_price is not a valid field

D. list_display should not include methods

Solution

1. Step 1: Check method signature for list_display methods

   Methods used in list_display must accept the model instance as the first parameter, usually named obj. Here, calculate_tax has no parameters, so it will cause an error.

2. Step 2: Confirm other options

   Methods can be in list_display, total_price is assumed valid, and methods do not have to be properties.

3. Final Answer:

   The method calculate_tax is missing the obj parameter -> Option B

4. Quick Check:

   list_display methods need obj parameter [OK]

Hint: list_display methods must accept obj parameter [OK]

Common Mistakes:

• Defining method without obj parameter
• Thinking methods can't be in list_display
• Confusing method with property decorator

5. You want to show a custom column in Django admin that displays 'Yes' if a product's stock is above 0, otherwise 'No'. Which is the correct way to add this to list_display?

hard

A. Define a method in admin: def in_stock(self, obj): return 'Yes' if obj.stock > 0 else 'No' and add 'in_stock' to list_display

B. Add 'in_stock' to list_display without defining a method

C. Override the model's __str__ method to return 'Yes' or 'No'

D. Use a property on the model named in_stock

Solution

1. Step 1: Create a method in admin for custom display

   To show a custom column based on logic, define a method in the admin class that takes self and obj and returns the desired string.

2. Step 2: Add the method name as a string to list_display

   Adding the method name to list_display tells Django to call it for each row and show the result.

3. Final Answer:

   Define a method in admin: def in_stock(self, obj): return 'Yes' if obj.stock > 0 else 'No' and add 'in_stock' to list_display -> Option A

4. Quick Check:

   Custom columns need admin methods + list_display [OK]

Hint: Custom columns need admin methods and list_display entry [OK]

Common Mistakes:

• Adding method name without defining it
• Trying to use model __str__ for columns
• Assuming properties on model auto-show in list_display