Merge pull request #183 from mapswipe/fix/type-ignore-comments

Author: tnagorra

apps/common/admin.py

@@ -4,17 +4,17 @@
 from django.contrib import admin
 from django.db import models
 from django.http import HttpRequest
-from djangoql.admin import DjangoQLSearchMixin
+from djangoql.admin import DjangoQLSearchMixin  # type: ignore[reportMissingTypeStubs]
 
 from apps.common.firebase.push import FirebaseAnnouncementPush
 from apps.common.models import Announcement, GlobalExportAsset, UserResource
 
 DjangoModel = typing.TypeVar("DjangoModel", bound=models.Model)
 
 
-class UserResourceAdmin(admin.ModelAdmin):
+class UserResourceAdmin(admin.ModelAdmin):  # type: ignore[reportMissingTypeArgument]
     @typing.override
-    def get_autocomplete_fields(self, *args, **kwargs):
+    def get_autocomplete_fields(self, *args, **kwargs):  # type: ignore[reportMissingParameterType]
         autocomplete_fields = super().get_autocomplete_fields(*args, **kwargs)
         return [
             *dict.fromkeys(
@@ -27,7 +27,7 @@ def get_autocomplete_fields(self, *args, **kwargs):
         ]
 
     @typing.override
-    def get_readonly_fields(self, *args, **kwargs):
+    def get_readonly_fields(self, *args, **kwargs):  # type: ignore[reportMissingParameterType]
         readonly_fields = super().get_readonly_fields(*args, **kwargs)
         return [
             # To maintain order
@@ -43,14 +43,14 @@ def get_readonly_fields(self, *args, **kwargs):
         ]
 
     @typing.override
-    def save_model(self, request, obj, form, change):
+    def save_model(self, request, obj, form, change):  # type: ignore[reportMissingParameterType]
         if not change:
             obj.created_by = request.user
         obj.modified_by = request.user
         super().save_model(request, obj, form, change)
 
     @typing.override
-    def save_formset(self, request, form, formset, change) -> None:
+    def save_formset(self, request, form, formset, change) -> None:  # type: ignore[reportMissingParameterType]
         if not issubclass(formset.model, UserResource):
             return super().save_formset(request, form, formset, change)
         # https://docs.djangoproject.com/en/4.2/ref/contrib/admin/#django.contrib.admin.ModelAdmin.save_formset
@@ -66,13 +66,13 @@ def save_formset(self, request, form, formset, change) -> None:
         return None
 
     @typing.override
-    def get_queryset(self, request: HttpRequest) -> models.QuerySet[DjangoModel]:
+    def get_queryset(self, request: HttpRequest) -> models.QuerySet[DjangoModel]:  # type: ignore[reportInvalidTypeVarUse]
         return super().get_queryset(request).select_related("created_by", "modified_by")
 
 
-class ArchivableResourceAdmin(admin.ModelAdmin):
+class ArchivableResourceAdmin(admin.ModelAdmin):  # type: ignore[reportMissingTypeArgument]
     @typing.override
-    def get_list_display(self, *args, **kwargs):
+    def get_list_display(self, *args, **kwargs):  # type: ignore[reportMissingParameterType]
         list_display = super().get_list_display(*args, **kwargs)
         return [
             *dict.fromkeys(
@@ -84,7 +84,7 @@ def get_list_display(self, *args, **kwargs):
         ]
 
     @typing.override
-    def get_list_filter(self, *args, **kwargs):
+    def get_list_filter(self, *args, **kwargs):  # type: ignore[reportMissingParameterType]
         list_filter = super().get_list_filter(*args, **kwargs)
         return [
             *dict.fromkeys(
@@ -96,7 +96,7 @@ def get_list_filter(self, *args, **kwargs):
         ]
 
     @typing.override
-    def get_autocomplete_fields(self, *args, **kwargs):
+    def get_autocomplete_fields(self, *args, **kwargs):  # type: ignore[reportMissingParameterType]
         autocomplete_fields = super().get_autocomplete_fields(*args, **kwargs)
         return [
             *dict.fromkeys(
@@ -108,7 +108,7 @@ def get_autocomplete_fields(self, *args, **kwargs):
         ]
 
     @typing.override
-    def get_readonly_fields(self, *args, **kwargs):
+    def get_readonly_fields(self, *args, **kwargs):  # type: ignore[reportMissingParameterType]
         readonly_fields = super().get_readonly_fields(*args, **kwargs)
         return [
             *dict.fromkeys(
@@ -121,7 +121,7 @@ def get_readonly_fields(self, *args, **kwargs):
         ]
 
     @typing.override
-    def save_model(self, request, obj, form, change):
+    def save_model(self, request, obj, form, change):  # type: ignore[reportMissingParameterType]
         if not change:
             obj.created_by = request.user
         obj.modified_by = request.user
@@ -134,11 +134,11 @@ def save_model(self, request, obj, form, change):
         super().save_model(request, obj, form, change)
 
 
-class FirebaseResourceAdmin(admin.ModelAdmin):
+class FirebaseResourceAdmin(admin.ModelAdmin):  # type: ignore[reportMissingTypeArgument]
     # FIXME(tnagorra): Add ordering for firebase_last_pushed
 
     @typing.override
-    def get_list_display(self, *args, **kwargs):
+    def get_list_display(self, *args, **kwargs):  # type: ignore[reportMissingParameterType]
         list_display = super().get_list_display(*args, **kwargs)
         return [
             *dict.fromkeys(
@@ -152,7 +152,7 @@ def get_list_display(self, *args, **kwargs):
         ]
 
     @typing.override
-    def get_list_filter(self, *args, **kwargs):
+    def get_list_filter(self, *args, **kwargs):  # type: ignore[reportMissingParameterType]
         list_filter = super().get_list_filter(*args, **kwargs)
         return [
             *dict.fromkeys(
@@ -164,7 +164,7 @@ def get_list_filter(self, *args, **kwargs):
         ]
 
     @typing.override
-    def get_readonly_fields(self, *args, **kwargs):
+    def get_readonly_fields(self, *args, **kwargs):  # type: ignore[reportMissingParameterType]
         readonly_fields = super().get_readonly_fields(*args, **kwargs)
         return [
             *dict.fromkeys(
@@ -184,11 +184,11 @@ class GlobalExportAssetAdmin(DjangoQLSearchMixin, admin.ModelAdmin[GlobalExportA
 
 
 @admin.register(Announcement)
-class AnnouncementAdmin(DjangoQLSearchMixin, FirebaseResourceAdmin, UserResourceAdmin, admin.ModelAdmin):
+class AnnouncementAdmin(DjangoQLSearchMixin, FirebaseResourceAdmin, UserResourceAdmin, admin.ModelAdmin):  # type: ignore[reportMissingTypeArgument]
     list_display = ("text", "is_active", "url")
 
     @typing.override
-    def save_model(self, request, obj, form, change):
+    def save_model(self, request, obj, form, change):  # type: ignore[reportMissingParameterType]
         super().save_model(request, obj, form, change)
 
         if obj.is_active:

apps/common/firebase/base.py

@@ -2,7 +2,7 @@
 import logging
 import typing
 
-from firebase_admin.db import Reference as FbReference
+from firebase_admin.db import Reference as FbReference  # type: ignore[reportMissingTypeStubs]
 from pydantic import BaseModel, ConfigDict
 
 from apps.common.models import FirebasePushResource, FirebasePushStatusEnum
@@ -42,7 +42,7 @@ def _inheritance_checks(cls):
         if missing_fields:
             raise NotImplementedError(f"Please define {','.join(missing_fields)} for {cls}")
 
-    def __init_subclass__(cls, **kwargs):
+    def __init_subclass__(cls, **kwargs):  # type: ignore[reportMissingParameterType]
         super().__init_subclass__(**kwargs)
         cls._inheritance_checks()
 

apps/common/firebase/push.py

@@ -1,7 +1,7 @@
 import logging
 import typing
 
-from firebase_admin.db import Reference as FbReference
+from firebase_admin.db import Reference as FbReference  # type: ignore[reportMissingTypeStubs]
 from pyfirebase_mapswipe import models as firebase_models
 from pyfirebase_mapswipe import utils as firebase_utils
 
@@ -47,5 +47,5 @@ def handle_object_update_on_firebase(
         )
 
     @typing.override
-    def get_firebase_path(self, firebase_id: str, model=Announcement):
+    def get_firebase_path(self, firebase_id: str, model=Announcement):  # type: ignore[reportMissingParameterType]
         return Config.FirebaseKeys.announcement()

apps/common/serializers.py

@@ -7,7 +7,7 @@
 from django.template.defaultfilters import filesizeformat
 from django.utils import timezone
 from django.utils.translation import gettext
-from firebase_admin import auth
+from firebase_admin import auth  # type: ignore[reportMissingTypeStubs]
 from rest_framework import serializers
 
 from apps.common.models import ArchivableResource, UserResource

apps/common/tests/firebase_auth_test.py

@@ -2,7 +2,7 @@
 from unittest import mock
 
 from django.urls import reverse
-from firebase_admin import auth
+from firebase_admin import auth  # type: ignore[reportMissingTypeStubs]
 
 from apps.contributor.factories import ContributorUserFactory
 from apps.user.factories import UserFactory

apps/common/views.py

@@ -9,7 +9,7 @@
 from django.http import JsonResponse
 from django.utils.translation import gettext
 from drf_spectacular.utils import extend_schema
-from health_check.views import MainView
+from health_check.views import MainView  # type: ignore[reportMissingTypeStubs]
 from rest_framework.response import Response
 from rest_framework.views import APIView
 

apps/community_dashboard/graphql/types.py

@@ -8,7 +8,7 @@
 import strawberry_django
 from django.db import models
 from django.utils import timezone
-from django_cte import With
+from django_cte import With  # type: ignore[reportMissingTypeStubs]
 
 from apps.community_dashboard.models import AggregatedUserGroupStatData, AggregatedUserStatData
 from apps.contributor.models import ContributorUser

apps/contributor/admin.py

@@ -3,7 +3,7 @@
 from django.contrib import admin
 from django.urls import reverse
 from django.utils.html import format_html
-from djangoql.admin import DjangoQLSearchMixin
+from djangoql.admin import DjangoQLSearchMixin  # type: ignore[reportMissingTypeStubs]
 
 from apps.common.admin import ArchivableResourceAdmin, FirebaseResourceAdmin, UserResourceAdmin
 
@@ -12,7 +12,7 @@
 
 
 @admin.register(ContributorUser)
-class ContributorUserAdmin(DjangoQLSearchMixin, admin.ModelAdmin):
+class ContributorUserAdmin(DjangoQLSearchMixin, admin.ModelAdmin):  # type: ignore[reportMissingTypeArgument]
     readonly_fields = (
         "firebase_id",
         "old_id",
@@ -30,15 +30,15 @@ class ContributorUserAdmin(DjangoQLSearchMixin, admin.ModelAdmin):
     autocomplete_fields = ("team",)
 
     @typing.override
-    def has_add_permission(self, *args, **kwargs):
+    def has_add_permission(self, *args, **kwargs):  # type: ignore[reportMissingParameterType]
         return False
 
     @typing.override
-    def has_delete_permission(self, *args, **kwargs):
+    def has_delete_permission(self, *args, **kwargs):  # type: ignore[reportMissingParameterType]
         return False
 
     @typing.override
-    def save_model(self, request, obj, form, change):
+    def save_model(self, request, obj, form, change):  # type: ignore[reportMissingParameterType]
         super().save_model(request, obj, form, change)
         FirebaseContributorUser(obj).trigger()
 
@@ -49,7 +49,7 @@ class ContributorUserGroupAdmin(
     ArchivableResourceAdmin,
     FirebaseResourceAdmin,
     UserResourceAdmin,
-    admin.ModelAdmin,
+    admin.ModelAdmin,  # type: ignore[reportMissingTypeArgument]
 ):
     list_display = ("name",)
     ordering = ("name",)
@@ -63,25 +63,25 @@ class ContributorTeamAdmin(
     ArchivableResourceAdmin,
     FirebaseResourceAdmin,
     UserResourceAdmin,
-    admin.ModelAdmin,
+    admin.ModelAdmin,  # type: ignore[reportMissingTypeArgument]
 ):
     list_display = ("name", "view_team_members")
     ordering = ("name",)
     search_fields = ("name",)
     list_select_related = True
 
     @typing.override
-    def save_model(self, request, obj, form, change):
+    def save_model(self, request, obj, form, change):  # type: ignore[reportMissingParameterType]
         super().save_model(request, obj, form, change)
         FirebaseContributorTeam(obj).trigger()
 
-    def view_team_members(self, obj):
+    def view_team_members(self, obj):  # type: ignore[reportMissingParameterType]
         url = reverse("admin:contributor_contributoruser_changelist") + f"?team__id__exact={obj.id}"
         return format_html('<a href="{}">View Team Members</a>', url)
 
 
 @admin.register(ContributorUserGroupMembership)
-class ContributorUserGroupMembershipAdmin(DjangoQLSearchMixin, admin.ModelAdmin):
+class ContributorUserGroupMembershipAdmin(DjangoQLSearchMixin, admin.ModelAdmin):  # type: ignore[reportMissingTypeArgument]
     list_display = ("user", "user_group", "is_active")
     list_filter = (
         # "user",

apps/contributor/firebase/push.py

@@ -1,7 +1,7 @@
 import logging
 import typing
 
-from firebase_admin.db import Reference as FbReference
+from firebase_admin.db import Reference as FbReference  # type: ignore[reportMissingTypeStubs]
 from pyfirebase_mapswipe import extended_models as firebase_ext_models
 from pyfirebase_mapswipe import models as firebase_models
 from pyfirebase_mapswipe import utils as firebase_utils
@@ -47,7 +47,7 @@ def handle_object_update_on_firebase(
         )
 
     @typing.override
-    def get_firebase_path(self, firebase_id: str, model=ContributorTeam):
+    def get_firebase_path(self, firebase_id: str, model=ContributorTeam):  # type: ignore[reportMissingParameterType]
         return Config.FirebaseKeys.contributor_team(firebase_id)
 
 
@@ -76,7 +76,7 @@ def handle_object_update_on_firebase(
         )
 
     @typing.override
-    def get_firebase_path(self, firebase_id: str, model=ContributorUser):
+    def get_firebase_path(self, firebase_id: str, model=ContributorUser):  # type: ignore[reportMissingParameterType]
         return Config.FirebaseKeys.contributor_user(firebase_id)
 
 
@@ -124,5 +124,5 @@ def handle_object_update_on_firebase(
         )
 
     @typing.override
-    def get_firebase_path(self, firebase_id: str, model=ContributorUserGroup):
+    def get_firebase_path(self, firebase_id: str, model=ContributorUserGroup):  # type: ignore[reportMissingParameterType]
         return Config.FirebaseKeys.contributor_user_group(firebase_id)

apps/contributor/firebase/utils.py

@@ -1,7 +1,7 @@
 import logging
 import typing
 
-from firebase_admin.db import Reference
+from firebase_admin.db import Reference  # type: ignore[reportMissingTypeStubs]
 from pydantic import BaseModel, ConfigDict, ValidationError
 
 from main.config import Config