summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Graham <timograham@gmail.com>2018-01-27 11:02:26 -0500
committerTim Graham <timograham@gmail.com>2018-01-27 11:29:57 -0500
commitc2962d8147380b00bb965c0d42b7e05ca4596868 (patch)
tree238a9010fd962720da12bfb0d62691b28e61cc9d
parented206a9b99cb528931fa23b6127fcb1cab246eb1 (diff)
[2.0.x] Expanded docs for AbstractBaseUser.has_usable_password().
Backport of 92f48680dbd2e02f2b33f6ad0e35b7d337889fb2 from master
-rw-r--r--django/contrib/auth/base_user.py5
-rw-r--r--docs/ref/contrib/auth.txt4
2 files changed, 8 insertions, 1 deletions
diff --git a/django/contrib/auth/base_user.py b/django/contrib/auth/base_user.py
index 0f8d5d87e2..357528e19e 100644
--- a/django/contrib/auth/base_user.py
+++ b/django/contrib/auth/base_user.py
@@ -115,6 +115,11 @@ class AbstractBaseUser(models.Model):
self.password = make_password(None)
def has_usable_password(self):
+ """
+ Return False if set_unusable_password() has been called for this user,
+ or if the password is None, or if the password uses a hasher that's not
+ in the PASSWORD_HASHERS setting.
+ """
return is_password_usable(self.password)
def get_session_auth_hash(self):
diff --git a/docs/ref/contrib/auth.txt b/docs/ref/contrib/auth.txt
index b4b407272a..a55ee4c675 100644
--- a/docs/ref/contrib/auth.txt
+++ b/docs/ref/contrib/auth.txt
@@ -212,7 +212,9 @@ Methods
Returns ``False`` if
:meth:`~django.contrib.auth.models.User.set_unusable_password()` has
- been called for this user.
+ been called for this user, or if the password is ``None``, or if the
+ password uses a hasher that's not in the :setting:`PASSWORD_HASHERS`
+ setting.
.. method:: get_group_permissions(obj=None)