fix: Use TypeVar for type-hinting of the user parameter

[payamnj]

Description

Using the AbstractBaseUser for type-hinting the auth user parameter to fix the problem mentioned in issue #1495

Related resources

• #...
• #...

Checklist

• I have opened this pull request against master
• I have added or modified the tests when changing logic
• I have followed the conventional commits guidelines to add meaningful information into the changelog
• I have read the contribution guidelines and I have joined #workgroup-pr-review on
  Slack to find a “pr review buddy” who is going to review my pull request.

[fsbraun]

Thank you very much for this PR!

Quick question for my understanding: Why did you not use TypeVar as you suggested in #1495 ?

[payamnj]

I wanted to know if we can be more specific, and Django recommendation for custom auth user model is to inherit from AbstractBaseUser, AbstractBaseUser so I thought it should work for the majority of the cases.

But since it's just a recommendation, maybe I should use the TypeVar and allow more flexibility? What do you think?

[fsbraun]

Maybe with a TypeVar we have the most flexibility?

[payamnj]

@fsbraun How about using models.Model instead? Any custom AUTH_USER_MODEL must be a subclass of Django Model, so this will provide more accurate type hinting and improve editor support.

[fsbraun]

@payamnj That sounds good to me! Maybe with a comment that a user model is expected but not imported...!

[fsbraun]

Thanks! Great work!

[payamnj]

@fsbraun can we merge this change and publish a new version?

[fsbraun]

@payamnj Version 3.2.3 is on its way! Have you joined the django CMS discord community yet? https://discord-main-channel.django-cms.org/ There's a #django-filer channel, too.

[payamnj]

@fsbraun No I have not yet, I will join. Thank you 🙏