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)

Примітки

Якщо ви впроваджуєте перевизначених модель користувача в уже існуючий проект, то рекомендую виконати наступні дії, щоб перевизначених модель використовувалася всюди у вашому проекті.

settings.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()

Наприклад, у мене є такий mixin

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 для профілю користувача на сайті.