Relax typing of backend in django.contrib.auth (ModelBackend -> BaseBackend)
#2141
Conversation
This file contains 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
`BaseBackend` is the base interface of django backends, `ModelBackend` has more specific signatures, such as `.authenticate()` including `username` and `password`, not all authentication backends use those. For instance, since the `authenticate()` method in BaseBackend already includes request (`HttpRequest`), it can read a `Bearer` token or cookie, and already accepts `**kwargs` for additional parameters. See also: - BaseBackend: https://github.com/django/django/blob/5.0.6/django/contrib/auth/backends.py#L8-L28 - ModelBackend: https://github.com/django/django/blob/5.0.6/django/contrib/auth/backends.py#L31-L160 - django.contrib.auth.authenticate(): https://github.com/django/django/blob/5.0.6/django/contrib/auth/__init__.py#L65-L93 - Django Docs for "Writing an authentication backend": https://docs.djangoproject.com/en/5.0/topics/auth/customizing/#writing-an-authentication-backend
tony
changed the title
ModelBackend -> BaseBackendbackend in django.contrib.auth (ModelBackend -> BaseBackend)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
BaseBackendis the base interface of django backends,ModelBackendhas more specific signatures, such as.authenticate()includingusernameandpassword, which isn't true for all backends, such as custom backends.ModelBackendis simply a backend included by Django it uses by default.For instance, since the
authenticate()method in BaseBackend already includesrequest(HttpRequest), it can read aBearertoken or cookie, and already accepts**kwargsfor additional parameters.See also
Related issues
django.contrib.auth.__init__'sbackendparam: Too specific? #2140