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!

asottile-sentry · 2025-04-28T17:36:31Z

django-stubs/contrib/auth/models.pyi

+# do not use the alias `_User` so the bound remains at `AbstractUser`
+_UserType = TypeVar("_UserType", bound=AbstractUser)


this bound seems incorrect -- or at least it breaks the usage in sentry

the docs for django seem to indicate AbstractBaseUser as the bound here ?

yes, this probably is more correct. thanks for noticing!

btw, can we test compat with sentry somehow? like running mypy-primer but for django-related projects only? 🤔

it should be possible if projects that you are talking about are opensource.

yep yep -- the repo in question is fully open source https://github.com/getsentry/sentry

there's a few problems that might be showstoppers though:

we've not completely made it through our blocklist of files: https://github.com/getsentry/sentry/blob/f7c3a817a586f9e5807784e0deb2db1b634e919b/pyproject.toml#L114

we're carrying a patch which undoes abstract objects = ...: getsentry@f96ab51

we're carrying a set of patches because we (ab)use cache versions as strings: getsentry@28d1e15 getsentry@3c73550

so I guess as long as it doesn't have to typecheck completely cleanly it should be fine?

created #2645 for the fix

andersk · 2025-05-05T05:52:15Z

django-stubs/contrib/auth/forms.pyi

@@ -114,28 +112,26 @@ class PasswordResetForm(forms.Form):
        extra_email_context: dict[str, str] | None = ...,
    ) -> None: ...

-class SetPasswordForm(forms.Form):
-    error_messages: _ErrorMessagesDict
+class SetPasswordForm(Generic[_UserType], SetPasswordMixin, forms.Form):


This is not generic at runtime, which prevents this from being subclassed.

class MySetPasswordForm(SetPasswordForm): pass

mypy complains: error: Missing type parameters for generic type "SetPasswordForm" [type-arg]

class MySetPasswordForm(SetPasswordForm[User]): pass

Fails at runtime: TypeError: 'DeclarativeFieldsMetaclass' object is not subscriptable

@andersk can you please send a PR to ext/? So we can monkeypatch this object in runtime.

Maybe we should add a small test to ensure that ? Something parsing pyi file for ``generic` calls and ensuring they match the one declared in the ext ? I can try something like that

Sure, this would be a great addition. I have no idea on how to actually do that :)
Maybe a stubtest extra check? 🤔

I can open an issue in mypy.

Would be nice if stubtest can catch that indeed

python/mypy#19032

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

terencehonles deleted the update-user-aliases branch April 20, 2025 09:20

asottile-sentry reviewed Apr 28, 2025

View reviewed changes

asottile mentioned this pull request Apr 28, 2025

correct bound for _UserType #2645

Merged

andersk reviewed May 5, 2025

View reviewed changes

sobolevn mentioned this pull request May 5, 2025

Add a new option for stubtest: --ensure-runtime-generic python/mypy#19032

Open

UnknownPlatypus mentioned this pull request May 6, 2025

Add a test for missing generics in stubs #2659

Merged

adnathanail mentioned this pull request May 31, 2025

TypeError: type 'SetPasswordForm' is not subscriptable #2697

Closed

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

		# do not use the alias `_User` so the bound remains at `AbstractUser`
		_UserType = TypeVar("_UserType", bound=AbstractUser)

Uh oh!

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

Uh oh!

Conversation

terencehonles commented Sep 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

I have made things!

Uh oh!

Uh oh!

sobolevn left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

flaeppe left a comment

Choose a reason for hiding this comment

Uh oh!

sobolevn commented Sep 27, 2024

Uh oh!

terencehonles commented Sep 27, 2024

Uh oh!

terencehonles commented Oct 1, 2024

Uh oh!

terencehonles commented Apr 17, 2025

Uh oh!

sobolevn left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

terencehonles left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

sobolevn commented Apr 17, 2025

Uh oh!

sobolevn commented Apr 17, 2025

Uh oh!

terencehonles commented Apr 17, 2025

Uh oh!

Uh oh!

terencehonles commented Apr 17, 2025

Uh oh!

sobolevn left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sobolevn May 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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 May 5, 2025 •

edited

Loading