Estendendo o modelo de Usuário com campos personalizados no Django
-
09-06-2019 - |
Pergunta
Qual é a melhor forma de estender o modelo do Usuário (junto com o Django de autenticação do aplicativo) com campos personalizados?Eu seria também, possivelmente como usar o e-mail como nome de usuário (para fins de autenticação).
Eu já vi um alguns formas para fazê-lo, mas não pode decidir sobre qual é o melhor.
Solução
A menos doloroso e, de fato, o Django-método recomendado de se fazer isto é através de um OneToOneField(User)
propriedade.
Estendendo o modelo de Usuário existente
…
Se você desejar para armazenar informações relacionadas com
User
, você pode usar um um-para-um relacionamento para um modelo que contém os campos para obter informações adicionais.Este um-para-um modelo é muitas vezes chamado de um perfil de modelo, como pode armazenar non-auth informações relacionadas sobre um usuário do site.
O que disse, estendendo-se django.contrib.auth.models.User
e suplantando também funciona...
A substituição de um modelo de Usuário personalizado
Alguns tipos de projetos podem ter requisitos de autenticação para que o Django built-in
User
modelo nem sempre é apropriado.Por exemplo, em alguns sites, faz mais sentido usar um endereço de e-mail como sua identificação token em vez de um nome de usuário.[Ed: Duas advertências e uma notificação siga, mencionando que este é muito drástica.]
Eu com certeza gostaria de ficar longe de alterar a real classe de Usuário no seu Django árvore de origem e/ou copiando e alterando o módulo de autenticação.
Outras dicas
Nota:esta resposta é preterido.veja outras respostas se você estiver usando o Django 1.7 ou posterior.
Isto é como eu faço.
#in models.py
from django.contrib.auth.models import User
from django.db.models.signals import post_save
class UserProfile(models.Model):
user = models.OneToOneField(User)
#other fields here
def __str__(self):
return "%s's profile" % self.user
def create_user_profile(sender, instance, created, **kwargs):
if created:
profile, created = UserProfile.objects.get_or_create(user=instance)
post_save.connect(create_user_profile, sender=User)
#in settings.py
AUTH_PROFILE_MODULE = 'YOURAPP.UserProfile'
Isto irá criar um perfil de usuário cada vez que um usuário for salvo se ele for criado.Em seguida, você pode usar
user.get_profile().whatever
Aqui está mais algumas informações a partir do google docs
http://docs.djangoproject.com/en/dev/topics/auth/#storing-additional-information-about-users
Atualização: Por favor, note que AUTH_PROFILE_MODULE
é preterido desde v1.5: https://docs.djangoproject.com/en/1.5/ref/settings/#auth-profile-module
Bem, algum tempo passou desde 2008 e é hora de alguns frescos resposta.Desde o Django 1.5 você será capaz de personalizar a classe de Usuário.Na verdade, no momento eu estou escrevendo isso, já mescladas em mestre, de modo que você pode experimentá-lo.
Há algumas informações sobre ele no docs ou se você quer cavar mais fundo, em este commit.
Tudo que você tem a fazer é adicionar AUTH_USER_MODEL
para configurações com o caminho para personalizar classe de usuário, que estende o AbstractBaseUser
(mais personalizável versão) ou AbstractUser
(mais ou menos antiga classe de Usuário, você pode estender).
Para as pessoas que são preguiçosos para clicar, aqui está o exemplo de código (tomadas a partir de docs):
from django.db import models
from django.contrib.auth.models import (
BaseUserManager, AbstractBaseUser
)
class MyUserManager(BaseUserManager):
def create_user(self, email, date_of_birth, password=None):
"""
Creates and saves a User with the given email, date of
birth and password.
"""
if not email:
raise ValueError('Users must have an email address')
user = self.model(
email=MyUserManager.normalize_email(email),
date_of_birth=date_of_birth,
)
user.set_password(password)
user.save(using=self._db)
return user
def create_superuser(self, username, date_of_birth, password):
"""
Creates and saves a superuser with the given email, date of
birth and password.
"""
u = self.create_user(username,
password=password,
date_of_birth=date_of_birth
)
u.is_admin = True
u.save(using=self._db)
return u
class MyUser(AbstractBaseUser):
email = models.EmailField(
verbose_name='email address',
max_length=255,
unique=True,
)
date_of_birth = models.DateField()
is_active = models.BooleanField(default=True)
is_admin = models.BooleanField(default=False)
objects = MyUserManager()
USERNAME_FIELD = 'email'
REQUIRED_FIELDS = ['date_of_birth']
def get_full_name(self):
# The user is identified by their email address
return self.email
def get_short_name(self):
# The user is identified by their email address
return self.email
def __unicode__(self):
return self.email
def has_perm(self, perm, obj=None):
"Does the user have a specific permission?"
# Simplest possible answer: Yes, always
return True
def has_module_perms(self, app_label):
"Does the user have permissions to view the app `app_label`?"
# Simplest possible answer: Yes, always
return True
@property
def is_staff(self):
"Is the user a member of staff?"
# Simplest possible answer: All admins are staff
return self.is_admin
Desde o Django 1.5 você pode facilmente estender o modelo de usuário e manter uma única tabela no banco de dados.
from django.contrib.auth.models import AbstractUser
from django.db import models
from django.utils.translation import ugettext_lazy as _
class UserProfile(AbstractUser):
age = models.PositiveIntegerField(_("age"))
Você também deve configurá-lo como usuário atual classe em seu arquivo de configurações
# supposing you put it in apps/profiles/models.py
AUTH_USER_MODEL = "profiles.UserProfile"
Se você deseja adicionar um monte de preferências de usuários a OneToOneField opção pode ser uma escolha melhor do que pensei.
Uma nota para as pessoas o desenvolvimento de bibliotecas de terceiros:se você precisa de acesso a classe de usuário lembre-se de que as pessoas podem mudar.Use o oficial ajudante para obter o direito de classe
from django.contrib.auth import get_user_model
User = get_user_model()
Há uma recomendação oficial no armazenando informações adicionais sobre os usuários.O Django Livro também aborda este problema na seção Perfis.
Abaixo é uma outra abordagem para estender um Usuário.Eu sinto que é mais clara,fácil e legível, em seguida, acima de duas abordagens.
http://scottbarnham.com/blog/2008/08/21/extending-the-django-user-model-with-inheritance/
Usando o método acima:
- você não precisa usar usuário.get_profile().newattribute para aceder a informação adicional relacionados para o usuário
- você pode apenas acessar diretamente adicionais novos atributos através de usuário.newattribute
Você pode Simplesmente estender perfil de usuário criando uma nova entrada de cada vez quando o usuário é criado usando o django pós salvar sinais
models.py
from django.db.models.signals import *
from __future__ import unicode_literals
class userProfile(models.Model):
userName = models.OneToOneField(User, related_name='profile')
city = models.CharField(max_length=100, null=True)
def __unicode__(self): # __str__
return unicode(self.userName)
def create_user_profile(sender, instance, created, **kwargs):
if created:
userProfile.objects.create(userName=instance)
post_save.connect(create_user_profile, sender=User)
Isto irá criar automaticamente um funcionário instância quando um novo usuário é criado.
Se você deseja estender o modelo de usuário e deseja adicionar mais informações ao criar o usuário que você pode usar o django-betterforms (http://django-betterforms.readthedocs.io/en/latest/multiform.html).Isto irá criar um usuário adicionar o formulário com todos os campos definidos na userProfile modelo.
models.py
from django.db.models.signals import *
from __future__ import unicode_literals
class userProfile(models.Model):
userName = models.OneToOneField(User)
city = models.CharField(max_length=100)
def __unicode__(self): # __str__
return unicode(self.userName)
forms.py
from django import forms
from django.forms import ModelForm
from betterforms.multiform import MultiModelForm
from django.contrib.auth.forms import UserCreationForm
from .models import *
class profileForm(ModelForm):
class Meta:
model = Employee
exclude = ('userName',)
class addUserMultiForm(MultiModelForm):
form_classes = {
'user':UserCreationForm,
'profile':profileForm,
}
views.py
from django.shortcuts import redirect
from .models import *
from .forms import *
from django.views.generic import CreateView
class addUser(CreateView):
form_class = addUserMultiForm
template_name = "addUser.html"
success_url = '/your url after user created'
def form_valid(self, form):
user = form['user'].save()
profile = form['profile'].save(commit=False)
profile.userName = User.objects.get(username= user.username)
profile.save()
return redirect(self.success_url)
addUser.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Title</title>
</head>
<body>
<form action="." method="post">
{% csrf_token %}
{{ form }}
<button type="submit">Add</button>
</form>
</body>
</html>
urls.py
from django.conf.urls import url, include
from appName.views import *
urlpatterns = [
url(r'^add-user/$', addUser.as_view(), name='addDistributor'),
]
Estendendo Django Modelo de Usuário (perfil de usuário) como um Pro
Eu achei isso muito útil: link
Um excerto:
a partir de django.contrib.auth.importação de modelos do Usuário
class Employee(models.Model):
user = models.OneToOneField(User)
department = models.CharField(max_length=100)
>>> u = User.objects.get(username='fsmith')
>>> freds_department = u.employee.department
Novo no Django 1.5, agora você pode criar seu próprio Modelo de Usuário (o que parece ser boa coisa a se fazer no caso acima).Consulte 'Personalização de autenticação do Django'
Provavelmente, o mais legal de novo recurso na versão 1.5.
Isso é o que eu faço, e é na minha opinião a maneira mais simples para fazer isso.defina um objeto gerenciador para o seu novo modelo personalizado, em seguida, definir o seu modelo.
from django.db import models
from django.contrib.auth.models import PermissionsMixin, AbstractBaseUser, BaseUserManager
class User_manager(BaseUserManager):
def create_user(self, username, email, gender, nickname, password):
email = self.normalize_email(email)
user = self.model(username=username, email=email, gender=gender, nickname=nickname)
user.set_password(password)
user.save(using=self.db)
return user
def create_superuser(self, username, email, gender, password, nickname=None):
user = self.create_user(username=username, email=email, gender=gender, nickname=nickname, password=password)
user.is_superuser = True
user.is_staff = True
user.save()
return user
class User(PermissionsMixin, AbstractBaseUser):
username = models.CharField(max_length=32, unique=True, )
email = models.EmailField(max_length=32)
gender_choices = [("M", "Male"), ("F", "Female"), ("O", "Others")]
gender = models.CharField(choices=gender_choices, default="M", max_length=1)
nickname = models.CharField(max_length=32, blank=True, null=True)
is_active = models.BooleanField(default=True)
is_staff = models.BooleanField(default=False)
REQUIRED_FIELDS = ["email", "gender"]
USERNAME_FIELD = "username"
objects = User_manager()
def __str__(self):
return self.username
Não se esqueça de adicionar esta linha de código em sua settings.py
:
AUTH_USER_MODEL = 'YourApp.User'
Isso é o que eu faço e sempre funciona.