ref: type custom managers as ClassVars (#59138)

this is needed to upgrade django-stubs / mypy




<!-- Describe your PR here. -->

Author: asottile-sentry

src/sentry/db/models/base.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import Any, Callable, Iterable, Mapping, TypeVar
+from typing import Any, Callable, ClassVar, Iterable, Mapping, TypeVar
 
 from django.apps.config import AppConfig
 from django.db import models
@@ -50,7 +50,7 @@ class Meta:
     __relocation_scope__: RelocationScope | set[RelocationScope]
     __relocation_dependencies__: set[str]
 
-    objects: BaseManager[Self] = BaseManager()
+    objects: ClassVar[BaseManager[Self]] = BaseManager()
 
     update = update
 

src/sentry/discover/models.py

@@ -1,3 +1,5 @@
+from typing import ClassVar
+
 from django.db import models, router, transaction
 from django.db.models import Q, UniqueConstraint
 from django.utils import timezone
@@ -87,7 +89,7 @@ def set_projects(self, project_ids):
             )
 
 
-class TeamKeyTransactionModelManager(BaseManager):
+class TeamKeyTransactionModelManager(BaseManager["TeamKeyTransaction"]):
     @staticmethod
     def __schedule_invalidate_project_config_transaction_commit(instance, trigger):
         try:
@@ -144,7 +146,7 @@ class TeamKeyTransaction(Model):
     organization = FlexibleForeignKey("sentry.Organization")
 
     # Custom Model Manager required to override post_save/post_delete method
-    objects = TeamKeyTransactionModelManager()
+    objects: ClassVar[TeamKeyTransactionModelManager] = TeamKeyTransactionModelManager()
 
     class Meta:
         app_label = "sentry"

src/sentry/event_manager.py

@@ -423,7 +423,12 @@ def save(
 
         projects = {project.id: project}
 
-        job = {"data": self._data, "project_id": project.id, "raw": raw, "start_time": start_time}
+        job: dict[str, Any] = {
+            "data": self._data,
+            "project_id": project.id,
+            "raw": raw,
+            "start_time": start_time,
+        }
 
         # After calling _pull_out_data we get some keys in the job like the platform
         with sentry_sdk.start_span(op="event_manager.save.pull_out_data"):

src/sentry/models/activity.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from enum import Enum
-from typing import TYPE_CHECKING, Any, Mapping, Optional, Sequence
+from typing import TYPE_CHECKING, Any, ClassVar, Mapping, Optional, Sequence
 
 from django.conf import settings
 from django.db import models
@@ -100,7 +100,7 @@ class Activity(Model):
     datetime = models.DateTimeField(default=timezone.now)
     data: models.Field[dict[str, Any], dict[str, Any]] = GzippedDictField(null=True)
 
-    objects: ActivityManager = ActivityManager()
+    objects: ClassVar[ActivityManager] = ActivityManager()
 
     class Meta:
         app_label = "sentry"

src/sentry/models/apiapplication.py

@@ -1,11 +1,12 @@
 import secrets
-from typing import List
+from typing import ClassVar, List
 from urllib.parse import urlparse
 
 import petname
 from django.db import models, router, transaction
 from django.utils import timezone
 from django.utils.translation import gettext_lazy as _
+from typing_extensions import Self
 
 from sentry.backup.scopes import RelocationScope
 from sentry.db.models import (
@@ -62,7 +63,7 @@ class ApiApplication(Model):
 
     date_added = models.DateTimeField(default=timezone.now)
 
-    objects = BaseManager(cache_fields=("client_id",))
+    objects: ClassVar[BaseManager[Self]] = BaseManager(cache_fields=("client_id",))
 
     class Meta:
         app_label = "sentry"

src/sentry/models/apikey.py

@@ -1,8 +1,10 @@
 import secrets
+from typing import ClassVar
 
 from django.db import models
 from django.utils import timezone
 from django.utils.translation import gettext_lazy as _
+from typing_extensions import Self
 
 from sentry.backup.scopes import RelocationScope
 from sentry.db.models import (
@@ -41,7 +43,7 @@ class ApiKey(ReplicatedControlModel, HasApiScopes):
     date_added = models.DateTimeField(default=timezone.now)
     allowed_origins = models.TextField(blank=True, null=True)
 
-    objects = BaseManager(cache_fields=("key",))
+    objects: ClassVar[BaseManager[Self]] = BaseManager(cache_fields=("key",))
 
     class Meta:
         app_label = "sentry"

src/sentry/models/apitoken.py

@@ -2,7 +2,7 @@
 
 import secrets
 from datetime import timedelta
-from typing import Collection, Optional, Tuple
+from typing import ClassVar, Collection, Optional, Tuple
 
 from django.db import models, router, transaction
 from django.utils import timezone
@@ -42,7 +42,9 @@ class ApiToken(ReplicatedControlModel, HasApiScopes):
     expires_at = models.DateTimeField(null=True, default=default_expiration)
     date_added = models.DateTimeField(default=timezone.now)
 
-    objects = ControlOutboxProducingManager["ApiToken"](cache_fields=("token",))
+    objects: ClassVar[ControlOutboxProducingManager[ApiToken]] = ControlOutboxProducingManager(
+        cache_fields=("token",)
+    )
 
     class Meta:
         app_label = "sentry"

src/sentry/models/authenticator.py

@@ -2,7 +2,7 @@
 
 import base64
 import copy
-from typing import Any, List
+from typing import Any, ClassVar, List
 
 from django.db import models
 from django.utils import timezone
@@ -31,7 +31,7 @@
 from sentry.types.region import find_regions_for_user
 
 
-class AuthenticatorManager(BaseManager):
+class AuthenticatorManager(BaseManager["Authenticator"]):
     def all_interfaces_for_user(self, user, return_missing=False, ignore_backup=False):
         """Returns a correctly sorted list of all interfaces the user
         has enabled.  If `return_missing` is set to `True` then all
@@ -154,7 +154,7 @@ class Authenticator(ControlOutboxProducingModel):
 
     config = AuthenticatorConfig()
 
-    objects = AuthenticatorManager()
+    objects: ClassVar[AuthenticatorManager] = AuthenticatorManager()
 
     class AlreadyEnrolled(Exception):
         pass

src/sentry/models/avatars/sentry_app_avatar.py

@@ -2,7 +2,7 @@
 
 from collections import defaultdict
 from enum import Enum
-from typing import TYPE_CHECKING, List
+from typing import TYPE_CHECKING, ClassVar, List
 
 from django.db import models
 
@@ -24,7 +24,7 @@ def get_choices(cls):
         return tuple((_.value, _.name.lower()) for _ in SentryAppAvatarTypes)
 
 
-class SentryAppAvatarManager(BaseManager):
+class SentryAppAvatarManager(BaseManager["SentryAppAvatar"]):
     def get_by_apps_as_dict(self, sentry_apps: List[SentryApp]):
         """
         Returns a dict mapping sentry_app_id (key) to List[SentryAppAvatar] (value)
@@ -43,7 +43,7 @@ class SentryAppAvatar(ControlAvatarBase):
     and specifies which type of logo it is.
     """
 
-    objects = SentryAppAvatarManager()
+    objects: ClassVar[SentryAppAvatarManager] = SentryAppAvatarManager()
 
     AVATAR_TYPES = SentryAppAvatarTypes.get_choices()
 

src/sentry/models/avatars/user_avatar.py

@@ -2,9 +2,10 @@
 
 import contextlib
 from enum import IntEnum
-from typing import Any, List, Tuple
+from typing import Any, ClassVar, List, Tuple
 
 from django.db import models, router, transaction
+from typing_extensions import Self
 
 from sentry.db.models import BaseManager, FlexibleForeignKey, control_silo_only_model
 
@@ -44,7 +45,7 @@ class UserAvatar(ControlAvatarBase):
     user = FlexibleForeignKey("sentry.User", unique=True, related_name="avatar")
     avatar_type = models.PositiveSmallIntegerField(default=0, choices=UserAvatarType.as_choices())
 
-    objects = BaseManager(cache_fields=["user"])
+    objects: ClassVar[BaseManager[Self]] = BaseManager(cache_fields=["user"])
 
     class Meta:
         app_label = "sentry"