mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-08-03 10:34:04 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

[1.10.x] Fixed #27053 -- Documented contrib.auth.get_user().

Browse source 
Backport of f7e91cac68 from master
This commit is contained in:
Berker Peksag 2016-08-24 12:21:28 +03:00 • committed by Tim Graham
parent bcdd13de93
commit a9fefd26dc
2 changed files with 43 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

23
docs/ref/contrib/auth.txt
View file

@ -645,3 +645,26 @@ The following backends are available in :mod:`django.contrib.auth.backends`:
Same as :class:`RemoteUserBackend` except that it doesn't reject inactive
users because :attr:`~RemoteUserBackend.user_can_authenticate` always
returns ``True``.
Utility functions
=================
.. currentmodule:: django.contrib.auth
.. function:: get_user(request)
Returns the user model instance associated with the given ``request``’s
session.
It checks if the authentication backend stored in the session is present in
:setting:`AUTHENTICATION_BACKENDS`. If so, it uses the backend's
``get_user()`` method to retrieve the user model instance and then verifies
the session by calling the user model's
:meth:`~django.contrib.auth.models.AbstractBaseUser.get_session_auth_hash`
method.
Returns an instance of :class:`~django.contrib.auth.models.AnonymousUser`
if the authentication backend stored in the session is no longer in
:setting:`AUTHENTICATION_BACKENDS`, if a user isn't returned by the
backend's ``get_user()`` method, or if the session auth hash doesn't
validate.