Fixed documentation around user_can_authenticate method for django.contrib.auth.backends #20320
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Updated the method signature for user_can_authenticate and added AllowAllUsersRemoteUserBackend class documentation.
fhightower
commented
Nov 25, 2025
| ``app_label``. | ||
|
|
||
| .. method:: user_can_authenticate() | ||
| .. method:: user_can_authenticate(user) |
fhightower
commented
Nov 25, 2025
| users because :attr:`~AllowAllUsersRemoteUserBackend.user_can_authenticate` always | ||
| returns ``True``. | ||
|
|
||
| .. method:: user_can_authenticate() |
Author
There was a problem hiding this comment.
I moved this method from the docs for RemoteUserBackend to AllowAllUsersRemoteUserBackend as that's where it's uniquely defined (RemoteUserBackend just inherits from ModelBackend).
fhightower
commented
Nov 25, 2025
docs/ref/contrib/auth.txt
Outdated
| .. class:: AllowAllUsersRemoteUserBackend | ||
|
|
||
| Same as :class:`RemoteUserBackend` except that it doesn't reject inactive | ||
| users because :attr:`~AllowAllUsersRemoteUserBackend.user_can_authenticate` always |
Author
There was a problem hiding this comment.
Note that I also changed ":attr:~RemoteUserBackend.user_can_authenticate" to ":attr:~AllowAllUsersRemoteUserBackend.user_can_authenticate" as AllowAllUsersRemoteUserBackend.user_can_authenticate is the function being discussed here that always returns True.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Trac ticket number
N/A
Branch description
Fixing method signature for
ModelBackend.user_can_authenticateand movinguser_can_authenticateto proper location underAllowAllUsersRemoteUserBackend.Thanks in advanced for your consideration of this change! I appreciate the work you do!
Checklist
mainbranch.