Doc'd that unusable passwords are defined by metadata in the password field.

This commit is contained in:
David D Lowe 2024-10-23 18:20:36 +01:00 committed by GitHub
parent 4d11ea1ef0
commit de2bb73904
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 3 deletions

View File

@ -54,7 +54,8 @@ Fields
Required. A hash of, and metadata about, the password. (Django doesn't Required. A hash of, and metadata about, the password. (Django doesn't
store the raw password.) Raw passwords can be arbitrarily long and can store the raw password.) Raw passwords can be arbitrarily long and can
contain any character. See the :doc:`password documentation contain any character. The metadata in this field may mark the password
as unusable. See the :doc:`password documentation
</topics/auth/passwords>`. </topics/auth/passwords>`.
.. attribute:: groups .. attribute:: groups
@ -175,8 +176,9 @@ Methods
.. method:: set_unusable_password() .. method:: set_unusable_password()
Marks the user as having no password set. This isn't the same as Marks the user as having no password set by updating the metadata in
having a blank string for a password. the :attr:`~django.contrib.auth.models.User.password` field. This isn't
the same as having a blank string for a password.
:meth:`~django.contrib.auth.models.User.check_password()` for this user :meth:`~django.contrib.auth.models.User.check_password()` for this user
will never return ``True``. Doesn't save the will never return ``True``. Doesn't save the
:class:`~django.contrib.auth.models.User` object. :class:`~django.contrib.auth.models.User` object.