p15693087
/
django
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

[2.1.x] Consolidated docs about handling a ForeignKey in custom user model manager. 

Backport of e9ea49d274 from master
This commit is contained in:
Tim Graham 2018-08-06 09:50:18 -04:00
parent 37c0a33655
commit c2b28dfeec
1 changed files with 8 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/topics/auth/customizing.txt
View File

@ -560,13 +560,6 @@ password resets. You must then provide some key implementation details:
... ...
USERNAME_FIELD = 'identifier' USERNAME_FIELD = 'identifier'
:attr:`USERNAME_FIELD` now supports
:class:`~django.db.models.ForeignKey`\s. Since there is no way to pass
model instances during the :djadmin:`createsuperuser` prompt, expect the
user to enter the value of :attr:`~django.db.models.ForeignKey.to_field`
value (the :attr:`~django.db.models.Field.primary_key` by default) of an
existing instance.
.. attribute:: EMAIL_FIELD .. attribute:: EMAIL_FIELD
A string describing the name of the email field on the ``User`` model. A string describing the name of the email field on the ``User`` model.
@ -600,13 +593,6 @@ password resets. You must then provide some key implementation details:
model, but should *not* contain the ``USERNAME_FIELD`` or model, but should *not* contain the ``USERNAME_FIELD`` or
``password`` as these fields will always be prompted for. ``password`` as these fields will always be prompted for.
:attr:`REQUIRED_FIELDS` now supports
:class:`~django.db.models.ForeignKey`\s. Since there is no way to pass
model instances during the :djadmin:`createsuperuser` prompt, expect the
user to enter the value of :attr:`~django.db.models.ForeignKey.to_field`
value (the :attr:`~django.db.models.Field.primary_key` by default) of an
existing instance.
.. attribute:: is_active .. attribute:: is_active
A boolean attribute that indicates whether the user is considered A boolean attribute that indicates whether the user is considered
@ -735,6 +721,9 @@ The following attributes and methods are available on any subclass of
:meth:`.BaseUserManager.normalize_email`. If you override this method, :meth:`.BaseUserManager.normalize_email`. If you override this method,
be sure to call ``super()`` to retain the normalization. be sure to call ``super()`` to retain the normalization.
Writing a manager for a custom user model
-----------------------------------------
You should also define a custom manager for your user model. If your user model You should also define a custom manager for your user model. If your user model
defines ``username``, ``email``, ``is_staff``, ``is_active``, ``is_superuser``, defines ``username``, ``email``, ``is_staff``, ``is_active``, ``is_superuser``,
``last_login``, and ``date_joined`` fields the same as Django's default user, ``last_login``, and ``date_joined`` fields the same as Django's default user,
@ -770,6 +759,11 @@ providing two additional methods:
Unlike ``create_user()``, ``create_superuser()`` *must* require the Unlike ``create_user()``, ``create_superuser()`` *must* require the
caller to provide a password. caller to provide a password.
For a :class:`~.ForeignKey` in :attr:`.USERNAME_FIELD` or
:attr:`.REQUIRED_FIELDS`, these methods receive the value of the
:attr:`~.ForeignKey.to_field` (the :attr:`~django.db.models.Field.primary_key`
by default) of an existing instance.
:class:`~django.contrib.auth.models.BaseUserManager` provides the following :class:`~django.contrib.auth.models.BaseUserManager` provides the following
utility methods: utility methods: