Browse Source

Expanded docs for AbstractBaseUser.has_usable_password().

Tim Graham 7 years ago
parent
commit
92f48680db
2 changed files with 8 additions and 1 deletions
  1. 5 0
      django/contrib/auth/base_user.py
  2. 3 1
      docs/ref/contrib/auth.txt

+ 5 - 0
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):

+ 3 - 1
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)