Custom user model with AbstractUser in Django - Mini Project: Build & Apply

Custom user model with AbstractUser

📖 Scenario: You are building a Django web application that needs a user model with extra fields beyond the default ones. To do this properly, you will create a custom user model by extending Django's AbstractUser class.

🎯 Goal: Create a custom user model called CustomUser that inherits from AbstractUser and adds a new field called bio to store a short biography. Then configure Django to use this custom user model.

📋 What You'll Learn

Create a new model CustomUser that inherits from AbstractUser

Add a bio field of type TextField to CustomUser

Set the AUTH_USER_MODEL setting to point to CustomUser

Create and apply migrations for the new user model

💡 Why This Matters

🌍 Real World

Many real-world Django applications need to store extra user information beyond the default username and email. Creating a custom user model with AbstractUser is the recommended way to do this cleanly and maintainably.

💼 Career

Understanding how to customize the user model is a common requirement for Django developers working on projects that require user profiles, authentication customization, or additional user data.

1

Create the CustomUser model

In your Django app's models.py, import AbstractUser from django.contrib.auth.models. Then create a class called CustomUser that inherits from AbstractUser. Inside it, add a new field called bio which is a TextField with blank=True.

Django

from django.contrib.auth.models import AbstractUser
from django.db import models

# Your code here

Hint

Remember to import AbstractUser and models. Define CustomUser as a subclass of AbstractUser. Add bio = models.TextField(blank=True) inside the class.

2

Configure AUTH_USER_MODEL setting

Open your Django project's settings.py file. Add a line that sets AUTH_USER_MODEL to the string "yourapp.CustomUser", replacing yourapp with the actual name of your Django app where CustomUser is defined.

Django

from django.contrib.auth.models import AbstractUser
from django.db import models

class CustomUser(AbstractUser):
    bio = models.TextField(blank=True)

# Your code here in settings.py

Hint

In settings.py, add the line AUTH_USER_MODEL = "yourapp.CustomUser" with your app name instead of yourapp.

3

Create migrations for the custom user model

Run the Django management command to create migrations for your app. Use the command python manage.py makemigrations yourapp in your terminal, replacing yourapp with your app's name.

Django

from django.contrib.auth.models import AbstractUser
from django.db import models

class CustomUser(AbstractUser):
    bio = models.TextField(blank=True)

# Run makemigrations command in terminal
# Your code here

Hint

Open your terminal and run python manage.py makemigrations yourapp to create migration files for your custom user model.

4

Apply migrations to update the database

Run the Django management command to apply migrations and update your database schema. Use the command python manage.py migrate in your terminal.

Django

from django.contrib.auth.models import AbstractUser
from django.db import models

class CustomUser(AbstractUser):
    bio = models.TextField(blank=True)

# Run migrate command in terminal
# Your code here

Hint

In your terminal, run python manage.py migrate to apply all migrations and update your database.

Practice

1. What is the main reason to create a custom user model by extending AbstractUser in Django?

easy

A. To add extra fields or change user behavior while keeping Django's default features

B. To remove all default user features and start from scratch

C. To automatically create admin users without configuration

D. To avoid using migrations in the project

Solution

1. Step 1: Understand AbstractUser purpose

   AbstractUser provides Django's default user fields and behavior as a base class.

2. Step 2: Reason for extending AbstractUser

   Extending it allows adding custom fields or changing behavior without losing built-in features.

3. Final Answer:

   To add extra fields or change user behavior while keeping Django's default features -> Option A

4. Quick Check:

   Custom user model = Extend AbstractUser for extra fields [OK]

Hint: AbstractUser keeps defaults; extend it to add fields [OK]

Common Mistakes:

• Thinking AbstractUser removes default features
• Believing custom user models skip migrations
• Assuming admin users are auto-created

2. Which of the following is the correct way to declare a custom user model by extending AbstractUser in Django?

easy

A. class CustomUser(AbstractBaseUser):\n pass

B. class CustomUser(User):\n pass

C. class CustomUser(models.Model):\n pass

D. class CustomUser(AbstractUser):\n pass

Solution

1. Step 1: Identify correct base class

   The question asks for extending AbstractUser, so the class must inherit from it.

2. Step 2: Check syntax correctness

   class CustomUser(AbstractUser):\n pass correctly defines class CustomUser(AbstractUser): pass which is valid syntax.

3. Final Answer:

   class CustomUser(AbstractUser):\n pass -> Option D

4. Quick Check:

   Extend AbstractUser with class CustomUser(AbstractUser) [OK]

Hint: Use AbstractUser as base class for custom user model [OK]

Common Mistakes:

• Using User instead of AbstractUser as base
• Inheriting directly from models.Model without user features
• Confusing AbstractBaseUser with AbstractUser

3. Given this custom user model:

from django.contrib.auth.models import AbstractUser
from django.db import models

class CustomUser(AbstractUser):
    age = models.PositiveIntegerField(null=True, blank=True)

# settings.py
AUTH_USER_MODEL = 'myapp.CustomUser'

What will happen if you try to create a user without specifying age?

medium

A. User creation fails due to missing age field

B. User is created successfully with age set to None

C. User is created but age defaults to 0

D. Error because age is required

Solution

1. Step 1: Analyze age field definition

   Age is defined as PositiveIntegerField with null=True and blank=True, so it is optional.

2. Step 2: Understand user creation behavior

   Since age is optional, creating a user without it sets age to None (null in database).

3. Final Answer:

   User is created successfully with age set to None -> Option B

4. Quick Check:

   Optional field with null=True allows missing value [OK]

Hint: null=True means field can be empty on creation [OK]

Common Mistakes:

• Assuming blank=True means field is required
• Thinking missing fields default to 0 automatically
• Confusing null=True with default values

4. You created a custom user model extending AbstractUser and set AUTH_USER_MODEL in settings. After running migrations, you get an error about conflicting user models. What is the most likely cause?

medium

A. You set AUTH_USER_MODEL after initial migrations were created

B. You forgot to import AbstractUser in your model

C. You did not define a primary key in your custom user model

D. You used AbstractBaseUser instead of AbstractUser

Solution

1. Step 1: Understand migration timing

   If AUTH_USER_MODEL is set after initial migrations, Django creates default user tables causing conflicts.

2. Step 2: Identify cause of conflict error

   The conflict arises because two user models exist: default and custom, due to late setting of AUTH_USER_MODEL.

3. Final Answer:

   You set AUTH_USER_MODEL after initial migrations were created -> Option A

4. Quick Check:

   Set AUTH_USER_MODEL before first migration [OK]

Hint: Set AUTH_USER_MODEL before first migration to avoid conflicts [OK]

Common Mistakes:

• Ignoring migration order importance
• Assuming import errors cause this conflict
• Confusing AbstractUser with AbstractBaseUser issues

5. You want to add a bio text field to your custom user model extending AbstractUser. You also want to display this bio in Django admin user list view. Which steps should you follow?

hard

A. Add bio field to model, override save() to print bio

B. Add bio field to model, no admin changes needed

C. Add bio field to model, register custom user admin with list_display including 'bio'

D. Add bio field to model, create a new admin site

Solution

1. Step 1: Add bio field to custom user model

   Define bio = models.TextField(blank=True, null=True) in your model to store user bios.

2. Step 2: Customize admin to show bio

   Register your custom user model admin and set list_display = ('username', 'email', 'bio') to show bio in list view.

3. Final Answer:

   Add bio field to model, register custom user admin with list_display including 'bio' -> Option C

4. Quick Check:

   Model field + admin list_display shows field [OK]

Hint: Add field + update admin list_display to show it [OK]

Common Mistakes:

• Forgetting to update admin list_display
• Overriding save() unnecessarily
• Creating new admin site instead of customizing existing