Using a custom user model in Django is recommended, especially in the early stage of the project; 2. Extend fields by inheriting AbstractUser and modifying the login method, such as setting the mailbox as a unique login field; 3. You must set AUTH_USER_MODEL in settings.py to point to the custom model in advance, otherwise subsequent changes will cause foreign keys to break; 4. Create migration and run to generate a database table structure; 5. You can customize the admin class to display new fields in the background; 6. Create a super user to verify that the configuration is effective; 7. You can handle registration logic through custom forms; 8. AbstractUser is suitable for extended field scenarios, and AbstractBaseUser is used for fully custom authentication; 9. If you need to hide username, it can be automatically generated in the form or save method. The complete process covers model definition, configuration, migration, background management and form adaptation, and user model settings must be completed early in the project to avoid data dependency issues.

Using Custom User Model in Django is recommended, especially in the early stages of the project. It provides greater flexibility, such as expanding fields (such as mobile phone number, nickname), modifying authentication methods (such as logging in with email instead of username), and better adapting to future needs.

Below is a complete example of Django custom user model , using the AbstractUser extension and setting the mailbox as a unique login field.

? 1. Create a custom user model

Suppose your project is called myproject and your application is called users .

Create the app first (if not already):

 python manage.py startapp users

Then define the custom user model in users/models.py :

 # users/models.py
from django.contrib.auth.models import AbstractUser
from django.db import models

class CustomUser(AbstractUser):
    email = models.EmailField(unique=True) # Email Unique phone = models.CharField(max_length=15, blank=True, null=True)
    nickname = models.CharField(max_length=50, blank=True, null=True)

    USERNAME_FIELD = 'email' # Log in with email REQUIRED_FIELDS = ['username', 'first_name', 'last_name'] # Fields that superusers need to fill in def __str__(self):
        return self.email

? Notice:

• Inheriting AbstractUser can retain the original functions and expand fields at the same time.
• USERNAME_FIELD is set to email , which means that the user logs in through the email address.
• REQUIRED_FIELDS is a field (except the password) that must be entered when creating a superuser.

? 2. Update settings.py

Tell Django to use your new user model in myproject/settings.py :

 # myproject/settings.py

# Modify the default user model AUTH_USER_MODEL = 'users.CustomUser'

#Other settings...
INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'users', # Register users app]

?? Note: This step must be completed before the first migration! Otherwise, subsequent modifications will be very troublesome.

? 3. Create and run the migration

 python management.py makemigrations users
python manage.py migrate

This creates a database structure containing your custom user tables.

? 4. Custom management background (optional)

In order to make the custom fields appear normally in Django admin, modify users/admin.py :

 # users/admin.py
from django.contrib import admin
from django.contrib.auth.admin import UserAdmin
from .models import CustomUser

class CustomUserAdmin(UserAdmin):
    model = CustomUser
    list_display = ['email', 'username', 'first_name', 'last_name', 'is_staff']
    fieldsets = UserAdmin.fieldsets (
        (None, {'fields': ('phone', 'nickname')}),
    )
    add_fieldsets = UserAdmin.add_fieldsets (
        (None, {'fields': ('phone', 'nickname')}),
    )

admin.site.register(CustomUser, CustomUserAdmin)

? 5. Create a superuser test

Run the command to create a superuser:

 python manage.py createsuperuser

Enter your email, username, password and other information, and log in to http://ipnx.cn/link/d5a44bdaee01bac1c4490d1aded4c0d8 to see if it is effective.

? 6. Use in the form (optional)

You can customize the registration form to adapt to the new model:

 # users/forms.py
from django import forms
from django.contrib.auth.forms import UserCreationForm
from .models import CustomUser

class CustomUserCreationForm(UserCreationForm):
    class Meta:
        model = CustomUser
        fields = ('username', 'email', 'first_name', 'last_name', 'password1', 'password2', 'phone', 'nickname')

Then use this form in the view to process the registration logic.

? FAQ Notes

• Why can't you change the user model halfway?
  Because Django's foreign key dependencies (such as auth, sessions, and log entry) all point to auth.User , changing the foreign keys will break. So it must be set up early in the project.

• AbstractUser vs AbstractBaseUser?

  • AbstractUser : Suitable for scenarios where only fields need to be expanded or logged in (recommended for most cases).
  • AbstractBaseUser : Fully customizes authentication logic (such as using only mobile phone number, logging in without password, etc.), which is more complicated.

• How to log in with email without letting users fill in username?
  You can automatically generate username in the form (such as prefixed with a mailbox), or override save() method.

Basically that's it. This example covers the complete process from model definition to backend management and is suitable for most project needs. Not complicated but it is easy to ignore details, especially AUTH_USER_MODEL must be set as early as possible.

The above is the detailed content of python django custom user model example. For more information, please follow other related articles on the PHP Chinese website!