mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-06-08 04:59:13 +00:00
Code Issues 32 Releases Wiki Activity

Improved wording in password validators docs and docstrings.

Browse Source
This commit is contained in:
Adam Johnson 2021-12-13 17:53:07 +00:00 committed by GitHub
parent 669dcefc04
commit 41329b9852
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
django/contrib/auth/password_validation.py
View File

@ -34,7 +34,7 @@ def get_password_validators(validator_config):
def validate_password(password, user=None, password_validators=None): def validate_password(password, user=None, password_validators=None):
""" """
Validate whether the password meets all validator requirements. Validate that the password meets all validator requirements.
If the password is valid, return ``None``. If the password is valid, return ``None``.
If the password is invalid, raise ValidationError with all error messages. If the password is invalid, raise ValidationError with all error messages.
@ -90,7 +90,7 @@ password_validators_help_text_html = lazy(_password_validators_help_text_html, s
class MinimumLengthValidator: class MinimumLengthValidator:
""" """
Validate whether the password is of a minimum length. Validate that the password is of a minimum length.
""" """
def __init__(self, min_length=8): def __init__(self, min_length=8):
self.min_length = min_length self.min_length = min_length
@ -117,7 +117,7 @@ class MinimumLengthValidator:
class UserAttributeSimilarityValidator: class UserAttributeSimilarityValidator:
""" """
Validate whether the password is sufficiently different from the user's Validate that the password is sufficiently different from the user's
attributes. attributes.
If no specific attributes are provided, look at a sensible list of If no specific attributes are provided, look at a sensible list of
@ -159,7 +159,7 @@ class UserAttributeSimilarityValidator:
class CommonPasswordValidator: class CommonPasswordValidator:
""" """
Validate whether the password is a common password. Validate that the password is not a common password.
The password is rejected if it occurs in a provided list of passwords, The password is rejected if it occurs in a provided list of passwords,
which may be gzipped. The list Django ships with contains 20000 common which may be gzipped. The list Django ships with contains 20000 common
@ -195,7 +195,7 @@ class CommonPasswordValidator:
class NumericPasswordValidator: class NumericPasswordValidator:
""" """
Validate whether the password is alphanumeric. Validate that the password is not entirely numeric.
""" """
def validate(self, password, user=None): def validate(self, password, user=None):
if password.isdigit(): if password.isdigit():

8
docs/topics/auth/passwords.txt
View File

@ -594,12 +594,12 @@ Django includes four validators:
.. class:: MinimumLengthValidator(min_length=8) .. class:: MinimumLengthValidator(min_length=8)
Validates whether the password meets a minimum length. Validates that the password is of a minimum length.
The minimum length can be customized with the ``min_length`` parameter. The minimum length can be customized with the ``min_length`` parameter.
.. class:: UserAttributeSimilarityValidator(user_attributes=DEFAULT_USER_ATTRIBUTES, max_similarity=0.7) .. class:: UserAttributeSimilarityValidator(user_attributes=DEFAULT_USER_ATTRIBUTES, max_similarity=0.7)
Validates whether the password is sufficiently different from certain Validates that the password is sufficiently different from certain
attributes of the user. attributes of the user.
The ``user_attributes`` parameter should be an iterable of names of user The ``user_attributes`` parameter should be an iterable of names of user
@ -614,7 +614,7 @@ Django includes four validators:
.. class:: CommonPasswordValidator(password_list_path=DEFAULT_PASSWORD_LIST_PATH) .. class:: CommonPasswordValidator(password_list_path=DEFAULT_PASSWORD_LIST_PATH)
Validates whether the password is not a common password. This converts the Validates that the password is not a common password. This converts the
password to lowercase (to do a case-insensitive comparison) and checks it password to lowercase (to do a case-insensitive comparison) and checks it
against a list of 20,000 common password created by `Royce Williams against a list of 20,000 common password created by `Royce Williams
<https://gist.github.com/roycewilliams/281ce539915a947a23db17137d91aeb7>`_. <https://gist.github.com/roycewilliams/281ce539915a947a23db17137d91aeb7>`_.
@ -625,7 +625,7 @@ Django includes four validators:
.. class:: NumericPasswordValidator() .. class:: NumericPasswordValidator()
Validates whether the password is not entirely numeric. Validate that the password is not entirely numeric.
Integrating validation Integrating validation
---------------------- ----------------------