Extending the User model with custom fields in Django

Question

What s the best way to extend the User model  bundled with Django s authentication app  with custom fields  I would also possibly like to use the email as the username  for authentication purposes    I ve already seen a few ways to do it  but can t decide on which one is the best

User · Answer

Well  some time passed since 2008 and it s time for some fresh answer  Since Django 1 5 you will be able to create custom User class  Actually  at the time I m writing this  it s already merged into master  so you can try it out   There s some information about it in docs or if you want to dig deeper into it  in this commit   All you have to do is add AUTH USER MODEL to settings with path to custom user class  which extends either AbstractBaseUser  more customizable version  or AbstractUser  more or less old User class you can extend    For people that are lazy to click  here s code example  taken from 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

User · Answer

Try this  Create a model called Profile and reference the user with a OneToOneField and provide an option of related name  models py from django db import models from django contrib auth models import   from django dispatch import receiver from django db models signals import post save  class Profile models Model       user   models OneToOneField User  on delete models CASCADE  related name  user profile        def   str   self           return self user username   receiver post save  sender User  def create profile sender  instance  created    kwargs       try          if created              Profile objects create user instance  save       except Exception as err          print  Error creating user profile     Now to directly access the profile using a User object you can use the related name  views py from django http import HttpResponse  def home request       profile   f profile of  request user user profile       return HttpResponse profile

User · Answer

New in Django 1 5  now you can create your own Custom User Model  which seems to be good thing to do in above case   Refer to  Customizing authentication in Django   Probably the coolest new feature on 1 5 release

User · Answer

The least painful and indeed Django-recommended way of doing this is through a OneToOneField User  property   Extending the existing User model     If you wish to store information related to User  you can use a one-to-one relationship to a model containing the fields for additional information  This one-to-one model is often called a profile model  as it might store non-auth related information about a site user   That said  extending django contrib auth models User and supplanting it also works     Substituting a custom User model Some kinds of projects may have authentication requirements for which Django   s built-in User model is not always appropriate  For instance  on some sites it makes more sense to use an email address as your identification token instead of a username   Ed  Two warnings and a notification follow  mentioning that this is pretty drastic    I would definitely stay away from changing the actual User class in your Django source tree and or copying and altering the auth module

User · Answer

This is what i do and it s in my opinion simplest way to do this  define an object manager for your new customized model then define your model   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   Dont forget to add this line of code in your settings py   AUTH USER MODEL    YourApp User    This is what i do and it always works

User · Answer

Note  this answer is deprecated  see other answers if you are using Django 1 7 or later   This is how I do it    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    This will create a userprofile each time a user is saved if it is created   You can then use    user get profile   whatever   Here is some more info from the docs  http   docs djangoproject com en dev topics auth  storing-additional-information-about-users  Update  Please note that AUTH PROFILE MODULE is deprecated since v1 5  https   docs djangoproject com en 1 5 ref settings  auth-profile-module

User · Answer

You can Simply extend user profile by creating a new entry each time when a user is created by using Django post save signals  models py  from django db models signals import   from   future   import unicode literals  class UserProfile models Model        user name   models OneToOneField User  related name  profile       city   models CharField max length 100  null True       def   unicode   self        str           return unicode self user name   def create user profile sender  instance  created    kwargs       if created          userProfile objects create user name instance   post save connect create user profile  sender User    This will automatically create an employee instance when a new user is created   If you wish to extend user model and want to add further information while creating a user you can use django-betterforms  http   django-betterforms readthedocs io en latest multiform html   This will create a user add form with all fields defined in the UserProfile model   models py  from django db models signals import   from   future   import unicode literals  class UserProfile models Model        user name   models OneToOneField User      city   models CharField max length 100       def   unicode   self        str           return unicode self user name    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     user name      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    add-user html      success url     your-url-after-user-created       def form valid self  form           user   form  user   save           profile   form  profile   save commit False          profile user name   User objects get username  user username          profile save           return redirect self success url    addUser html   lt  DOCTYPE html gt   lt html lang  en  gt       lt head gt           lt meta charset  UTF-8  gt           lt title gt Title lt  title gt       lt  head gt       lt body gt           lt form action     method  post  gt                 csrf token                   form                      lt button type  submit  gt Add lt  button gt           lt  form gt        lt  body gt   lt  html gt    urls py  from django conf urls import url  include from appName views import   urlpatterns         url r  add-user     AddUser as view    name  add-user

User · Answer

Currently as of Django 2 2  the recommended way when starting a new project is to create a custom user model that inherits from AbstractUser  then point AUTH USER MODEL to the model   Source  https   docs djangoproject com en 2 2 topics auth customizing  using-a-custom-user-model-when-starting-a-project

User · Answer

There is an official recommendation on storing additional information about users  The Django Book also discusses this problem in section Profiles

User · Answer

Simple and effective approach is models py  from django contrib auth models import User class CustomUser User        profile pic   models ImageField upload to             other field   models CharField

User · Answer

It s too late  but my answer is for those who search for a solution with a recent version of Django  models py  from django db import models from django contrib auth models import User from django db models signals import post save from django dispatch import receiver   class Profile models Model       user   models OneToOneField User  on delete models CASCADE      extra Field 1   models CharField max length 25  blank True      extra Field 2   models CharField max length 25  blank True     receiver post save  sender User  def create user profile sender  instance  created    kwargs       if created          Profile objects create user instance    receiver post save  sender User  def save user profile sender  instance    kwargs       instance profile save    you can use it in templates like this   lt h2 gt    user get full name    lt  h2 gt   lt ul gt     lt li gt Username     user username    lt  li gt     lt li gt Location     user profile extra Field 1    lt  li gt     lt li gt Birth Date     user profile extra Field 2    lt  li gt   lt  ul gt   and in views py like this  def update profile request  user id       user   User objects get pk user id      user profile extra Field 1    Lorem ipsum dolor sit amet  consectetur adipisicing elit         user save

User · Answer

Extending Django User Model  UserProfile  like a Pro  I ve found this very useful  link  An extract   from django contrib auth models import User  class Employee models Model       user   models OneToOneField User      department   models CharField max length 100    gt  gt  gt  u   User objects get username  fsmith    gt  gt  gt  freds department   u employee department

User · Answer

Since Django 1 5 you may easily extend the user model and keep a single table on the database   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      You must also configure it as current user class in your settings file    supposing you put it in apps profiles models py AUTH USER MODEL    profiles UserProfile    If you want to add a lot of users  preferences the OneToOneField option may be a better choice thought   A note for people developing third party libraries  if you need to access the user class remember that people can change it  Use the official helper to get the right class  from django contrib auth import get user model  User   get user model

User · Answer

The below one is another approach to extend an User  I feel it is more clear easy readable  then above two approaches   http   scottbarnham com blog 2008 08 21 extending-the-django-user-model-with-inheritance   Using above approach    you don t need to use user get profile   newattribute to access the additional information related to the user you can just directly access additional new attributes via  user newattribute

[django] Extending the User model with custom fields in Django

Examples related to django

Examples related to django-models

Examples related to django-authentication

Examples related to django-users