Django - Урок 052. Переопределение модели пользователя

Model, QuerySet, Python, django

Существуют различные варианты работы с моделью пользователя для создания профиля пользователя и добавления определенной информации, например, фотографии профиля. Один из способов — добавить модель профиля с полем OneToOneField для пользователя. Этот вариант проще, чем прокси-модель или переопределение пользовательской модели. Но лично для меня переопределение пользовательской модели оказалось более эффективным с точки зрения организации кода и написания различных методов, позволяющих извлекать нужную информацию из пользовательского объекта в шаблонах, не прибегая к написанию шаблонных тегов.

Поэтому рассмотрим именно вариант переопределения модели пользователя в проекте на Django

Вступление

В качестве вступления обращу внимание на то, что переопределение пользовательской модели лучше делать в самом начале проекта, иначе могут возникнуть проблемы с миграциями, которые нужно исправлять вручную.

Я сам делал переопределение пользовательской модели уже когда сайт просуществовал больше двух лет. Однако у меня процесс переопределения прошел относительно гладко, по крайней мере я не помню, чтобы были какие-то проблемы с тем, что я переопределял пользовательскую модель.

Переопределение пользовательской модели

Чтобы правильно переопределить модель пользователя, вам нужно импортировать абстрактную модель пользователя AbstractUser и наследоваться от нее в приложении, где у вас будет модель.

В моем приложении evileg_auth я сделал так

# -*- coding: utf-8 -*-

from django.contrib.auth.models import AbstractUser


class User(AbstractUser):
    pass

Далее вам нужно указать эту модель как новую пользовательскую модель в файле настроек settings.py

AUTH_USER_MODEL = 'evileg_auth.User'

Это нужно для того, чтобы стороннее приложение начало использовать вашу пользовательскую модель вместо стандартной.

Затем вы можете создать миграции и перенести проект

python manage.py makemigrations
python manage.py migrate

Также не забудьте зарегистрировать свою модель в админке

# -*- coding: utf-8 -*-

from django.contrib import admin
from django.contrib.auth.admin import UserAdmin

from .models import User

admin.site.register(User, UserAdmin)

Примечания

Если вы внедряете переопределенную пользовательскую модель в существующий проект, я рекомендую вам выполнить следующие шаги, чтобы переопределенная модель использовалась везде в вашем проекте.

настройки.AUTH_USER_MODEL

Во всех файлах models.py используйте переменную settings.AUTH_USER_MODEL из настроек вместо стандартной модели.

# -*- coding: utf-8 -*-

from django.conf import settings
from django.db import models


class SomeModel(models.Model):
    user = models.ForeignKey(settings.AUTH_USER_MODEL, verbose_name='User')

get_user_model()

Везде в коде, где предполагается, что экземпляр Django уже запущен, используйте динамическое получение класса пользовательской модели через get_user_model()

Например, у меня есть такой миксин

class EInUserProfileMixin:
    user_profile = None

    def dispatch(self, request, *args, **kwargs):
        self.user_profile = get_object_or_404(get_user_model(), username=kwargs['user'], is_active=True)
        return super().dispatch(request, *args, **kwargs)

Стороннее приложение

Если вы пишете стороннее приложение, то рекомендации из раздела заметок должны быть для вас обязательными, потому что иначе ваше стороннее приложение будет бесполезным для тех разработчиков, которые переопределяют пользовательские модели в своих проектах на Django

Преимущества переопределения пользовательской модели

Переопределение модели пользователя имеет, на мой взгляд, большие преимущества по сравнению с использованием OneToOneField, так как позволяет без костылей переопределить диспетчер объектов, а также добавить ряд методов, которые могут пригодиться в вашем проекте. А также эти методы можно вызывать в шаблонах без написания тегов шаблона.

Вот пример части пользовательской модели в моем проекте

class User(AbstractUser):

    last_online = models.DateTimeField(blank=True, null=True)

    objects = UserManager()

    class Meta:
        ordering = ['username']

    def get_absolute_url(self):
        return reverse('users:profile', kwargs={'user': self.username})

Как минимум, мне всегда не хватало использования стандартного метода get_absolute_url для профиля пользователя на сайте.