Base authentication Backend should raise NotImplemented on needed methods

[Dre Westcook]

Hi all,

Recently I've been trying my hand at creating alternative sign on methods for a django system and I've found the whole process fairly clean.

However I did reach bit of a time waste when my "code that should work, doesn't" -- in my login view, I would authenticate() and login() properly, but with a redirect response I would be an AnonymousUser immediately after.

After two days of debugging and re-reading docs, I found that I missed out a fairly critical sentence: "Authentication backends implements two required methods". -- my authentication backend (of which I was replacing the default) - did not implement get_user() so we would use the default BaseBackend.get_user() which is to return None.

To me, it wasn't quite obvious why the authentication system needs to implement get_user ( as i'd want to just get the user by pk like any other) so this was a little bit of time wasting that I feel could be made a bit more obvious.

Some ideas:

• BaseBackend to implement a simple get_user_model().objects.get( _meta.pk=pk) - seeming this is the default for most cases (as far as I know?)
• BaseBackend to raise NotImplemented to force implementors to define these two required methods as that is what is mentioned in the docs (​https://docs.djangoproject.com/en/4.1/topics/auth/customizing/#:~:text=implements%20two%20required%20methods)
  • anyone requiring the failthrough approach so that one can auth and get_user on different backends can just pass it
• something else.

Happy for some thoughts/feedback/pushback. This was just a painpoint for me while developing.

Perhaps it needs to be highlighted in the documentation?