Annotate builtin models' fields with explicit types #2181

flaeppe · 2024-05-24T15:09:55Z

flaeppe
May 24, 2024
Maintainer

It looks like models and their fields that are declared in django-stubs haven't been explicitly declared.

Is that perhaps something we should do?

For example, here's a diff for django.contrib.auth.models.AbstractUser

class AbstractUser(AbstractBaseUser, PermissionsMixin):
    username_validator: UnicodeUsernameValidator

-    username = models.CharField(max_length=150)
-    first_name = models.CharField(max_length=30, blank=True)
-    last_name = models.CharField(max_length=150, blank=True)
-    email = models.EmailField(blank=True)
-    is_staff = models.BooleanField()
-    is_active = models.BooleanField()
-    date_joined = models.DateTimeField()
+    username: models.CharField[str, str]
+    first_name: models.CharField[str, str]
+    last_name: models.CharField[str, str]
+    email: models.EmailField[str, str]
+    is_staff: models.BooleanField[bool, bool]
+    is_active: models.BooleanField[bool, bool]
+    date_joined: models.DateTimeField[datetime, datetime]

An additional thing to think about is if this improves QoL for someone running type checking without the mypy plugin enabled?

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Annotate builtin models' fields with explicit types #2181

Uh oh!

{{title}}

Uh oh!

Replies: 0 comments

Select a reply

Uh oh!

Uh oh!

Annotate builtin models' fields with explicit types #2181

Uh oh!

flaeppe May 24, 2024 Maintainer

Replies: 0 comments

flaeppe
May 24, 2024
Maintainer