Author: adrian
Date: 2010-01-10 13:05:39 -0600 (Sun, 10 Jan 2010)
New Revision: 12193
Modified:
django/trunk/docs/topics/auth.txt
Log:
Fixed #12113 -- Clarified is_active documentation. Thanks, ejucovy and isagalaev
Modified: django/trunk/docs/topics/auth.txt
===================================================================
--- django/trunk/docs/topics/auth.txt 2010-01-10 18:56:53 UTC (rev 12192)
+++ django/trunk/docs/topics/auth.txt 2010-01-10 19:05:39 UTC (rev 12193)
@@ -97,14 +97,20 @@
.. attribute:: models.User.is_active
Boolean. Designates whether this user account should be considered
- active. Set this flag to ``False`` instead of deleting accounts.
+ active. We recommend that you set this flag to ``False`` instead of
+ deleting accounts; that way, if your applications have any foreign keys
+ to users, the foreign keys won't break.
- This doesn't control whether or not the user can log in. Nothing in the
- authentication path checks the ``is_active`` flag, so if you want to
- reject a login based on ``is_active`` being ``False``, it is up to you
- to check that in your own login view. However, permission checking
- using the methods like :meth:`~models.User.has_perm` does check this
- flag and will always return ``False`` for inactive users.
+ This doesn't necessarily control whether or not the user can log in.
+ Authentication backends aren't required to check for the ``is_active``
+ flag, so if you want to reject a login based on ``is_active`` being
+ ``False``, it's up to you to check that in your own login view.
+ However, the :class:`~django.contrib.auth.forms.AuthenticationForm`
+ used by the :func:`~django.contrib.auth.views.login` view *does*
+ perform this check, as do the permission-checking methods such as
+ :meth:`~models.User.has_perm` and the authentication in the Django
+ admin. All of those functions/methods will return ``False`` for
+ inactive users.
.. attribute:: models.User.is_superuser
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To post to this group, send email to django-upda...@googlegroups.com.
To unsubscribe from this group, send email to
django-updates+unsubscr...@googlegroups.com.
For more options, visit this group at
http://groups.google.com/group/django-updates?hl=en.
