create and re-use `TypeAlias`es and `TypeVar`s for "user" and "any user" #2384

terencehonles · 2024-09-27T00:03:23Z

I have made things!

This change also adds a few user type vars and alises to cover the common use cases of User, User | AnonymousUser, and their TypeVar forms for using in generic contexts.

django-stubs/contrib/auth/models.pyi

sobolevn

Generally - looks great! Just one note

django-stubs/contrib/auth/models.pyi

flaeppe

I don't think we should change the base class to be AbstractUser. This is a section of what the "Specifying a custom user model" says in the docs:

[...] The easiest way to construct a compliant custom user model is to inherit from AbstractBaseUser. AbstractBaseUser provides the core implementation of a user model, including hashed passwords and tokenized password resets. [...]

https://docs.djangoproject.com/en/5.1/topics/auth/customizing/#specifying-a-custom-user-model

sobolevn · 2024-09-27T06:49:56Z

I don't think we should change the base class to be AbstractUser.

As far as I understand, this is not the base class, this is the default type, unless AUTH_USER_MODEL is specified.

terencehonles · 2024-09-27T07:38:41Z

That's interesting that they suggest that... The issue is that AbstractBaseUser does not include the PermissionsMixin and if we shouldn't be requiring AbstractUser we may want to create a type checking only protocol (not sure if that's easy to do as a subtype and I can play around with that).

It does look like there's probably some complications if we move the base class up (subclasses of AbstractBaseUser will not work as subclasses of AbstractUser), so I'll look into this more, but since the plugin is patching the type based on AUTH_USER_MODEL it may only be a problem if you aren't using mypy or haven't configured the plugin.

terencehonles · 2024-10-01T07:04:50Z

I don't think we should change the base class to be AbstractUser. This is a section of what the "Specifying a custom user model" says in the docs:

I rolled back the change since it does affect a user who subclasses AbstractBaseUser based on the documentation. I can look into the permissions issue a little if I have time, but I had already fixed our custom plugin not pulling the right model so the replacement is working for us and we're not hit by AbstractBaseUser not implementing permissions.

This change still adds some helpful aliases so it can get merged in and the follow-up can be done independently.

This change also adds a few user type vars and alises to cover the common use cases of ``User``, ``User | AnonymousUser``, and their ``TypeVar`` forms for using in generic contexts.

terencehonles · 2025-04-17T07:21:11Z

@sobolevn any chance I can get a re-review? I updated this to fix the conflicts, but it was already updated to remove the concern about shifting the base user. It now only provides a few useful type aliases that can be shared across the codebase.

High level changes:

_UserModel renamed to _User since it's an instance of the model not the model (type) itself
_UserType shared TypeVar that represents a _User that should be used in generic context to capture the exact user type being passed into a function/class.
_AnyUser alias of _User | AnonymousUser and its shared TypeVar _AnyUserType for the same reason as ^^^

sobolevn

Thanks for the ping! Mostly looks good.

django-stubs/contrib/auth/forms.pyi

django-stubs/contrib/auth/models.pyi

sobolevn · 2025-04-17T07:48:31Z

django-stubs/contrib/auth/__init__.pyi

-def get_user_model() -> type[_UserModel]: ...
-def get_user(request: HttpRequest | Client) -> _UserModel | AnonymousUser: ...
-async def aget_user(request: HttpRequest | Client) -> _UserModel | AnonymousUser: ...
+def get_user_model() -> type[_User]: ...


Suggested change

def get_user_model() -> type[_User]: ...

def get_user_model() -> UserModel: ...

I'll look to see if there are any type[_User] that can be replaced with the UserModel alias

I think there was just one other that you didn't mention

django-stubs/contrib/auth/models.pyi

django-stubs/contrib/auth/views.pyi

terencehonles

The suggestion seems reasonable, but a few comments and I just want to understand what you'd prefer before continuing.

terencehonles · 2025-04-17T10:22:59Z

django-stubs/contrib/auth/__init__.pyi

-def get_user_model() -> type[_UserModel]: ...
-def get_user(request: HttpRequest | Client) -> _UserModel | AnonymousUser: ...
-async def aget_user(request: HttpRequest | Client) -> _UserModel | AnonymousUser: ...
+def get_user_model() -> type[_User]: ...


I'll look to see if there are any type[_User] that can be replaced with the UserModel alias

django-stubs/contrib/auth/forms.pyi

django-stubs/contrib/auth/models.pyi

sobolevn · 2025-04-17T11:12:23Z

Yes, I prefer re-exporting over re-definition, because definition can change at some point :)

sobolevn · 2025-04-17T11:12:35Z

(missclick, sorry)

terencehonles · 2025-04-17T11:21:00Z

Ruff really doesn't like re-exporting with a rename, but I think I finally got it to stop deleting the re-exports 😒

django-stubs/contrib/auth/backends.pyi

terencehonles · 2025-04-17T12:27:19Z

updated

sobolevn

Thanks!

terencehonles commented Sep 27, 2024

View reviewed changes

django-stubs/contrib/auth/models.pyi Outdated Show resolved Hide resolved

terencehonles force-pushed the update-user-aliases branch from 08131cc to 513df00 Compare September 27, 2024 00:09

sobolevn reviewed Sep 27, 2024

View reviewed changes

django-stubs/contrib/auth/models.pyi Outdated Show resolved Hide resolved

sobolevn requested a review from flaeppe September 27, 2024 06:00

flaeppe reviewed Sep 27, 2024

View reviewed changes

terencehonles force-pushed the update-user-aliases branch from 513df00 to 06a4f41 Compare October 1, 2024 07:00

terencehonles changed the title ~~update default AUTH_USER_MODEL to be AbstractUser and reuse aliases~~ create and re-use TypeAliases and TypeVars for User and AnyUser Oct 1, 2024

terencehonles changed the title ~~create and re-use TypeAliases and TypeVars for User and AnyUser~~ create and re-use TypeAliases and TypeVars for "user" and "any user" Oct 1, 2024

terencehonles force-pushed the update-user-aliases branch 2 times, most recently from bf15c5b to 2697324 Compare April 17, 2025 07:04

create and re-use TypeAliases and TypeVars for "user" and "any user"

e29f60b

This change also adds a few user type vars and alises to cover the common use cases of ``User``, ``User | AnonymousUser``, and their ``TypeVar`` forms for using in generic contexts.

terencehonles force-pushed the update-user-aliases branch from 2697324 to e29f60b Compare April 17, 2025 07:16

sobolevn reviewed Apr 17, 2025

View reviewed changes

terencehonles commented Apr 17, 2025

View reviewed changes

sobolevn closed this Apr 17, 2025

sobolevn reopened this Apr 17, 2025

sobolevn reviewed Apr 17, 2025

View reviewed changes

django-stubs/contrib/auth/backends.pyi Outdated Show resolved Hide resolved

add type alias _UserModel = type[_User]

fb5379a

terencehonles force-pushed the update-user-aliases branch from 202711d to fb5379a Compare April 17, 2025 12:26

sobolevn approved these changes Apr 17, 2025

View reviewed changes

sobolevn merged commit 8249ccd into typeddjango:master Apr 17, 2025
36 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

create and re-use `TypeAlias`es and `TypeVar`s for "user" and "any user" #2384

create and re-use `TypeAlias`es and `TypeVar`s for "user" and "any user" #2384

terencehonles commented Sep 27, 2024 •

edited

Loading

sobolevn left a comment

flaeppe left a comment

sobolevn commented Sep 27, 2024

terencehonles commented Sep 27, 2024

terencehonles commented Oct 1, 2024

terencehonles commented Apr 17, 2025

sobolevn left a comment

sobolevn Apr 17, 2025

terencehonles Apr 17, 2025

terencehonles Apr 17, 2025

terencehonles left a comment

terencehonles Apr 17, 2025

sobolevn commented Apr 17, 2025

sobolevn commented Apr 17, 2025

terencehonles commented Apr 17, 2025

terencehonles commented Apr 17, 2025

sobolevn left a comment

	def get_user_model() -> type[_User]: ...
	def get_user_model() -> UserModel: ...

create and re-use TypeAliases and TypeVars for "user" and "any user" #2384

create and re-use TypeAliases and TypeVars for "user" and "any user" #2384

Conversation

terencehonles commented Sep 27, 2024 • edited Loading

I have made things!

sobolevn left a comment

Choose a reason for hiding this comment

flaeppe left a comment

Choose a reason for hiding this comment

sobolevn commented Sep 27, 2024

terencehonles commented Sep 27, 2024

terencehonles commented Oct 1, 2024

terencehonles commented Apr 17, 2025

sobolevn left a comment

Choose a reason for hiding this comment

sobolevn Apr 17, 2025

Choose a reason for hiding this comment

terencehonles Apr 17, 2025

Choose a reason for hiding this comment

terencehonles Apr 17, 2025

Choose a reason for hiding this comment

terencehonles left a comment

Choose a reason for hiding this comment

terencehonles Apr 17, 2025

Choose a reason for hiding this comment

sobolevn commented Apr 17, 2025

sobolevn commented Apr 17, 2025

terencehonles commented Apr 17, 2025

terencehonles commented Apr 17, 2025

sobolevn left a comment

Choose a reason for hiding this comment

create and re-use `TypeAlias`es and `TypeVar`s for "user" and "any user" #2384

create and re-use `TypeAlias`es and `TypeVar`s for "user" and "any user" #2384

terencehonles commented Sep 27, 2024 •

edited

Loading