Implement disable comment for drf serializers

Author: kalekseev

src/extra_checks/check_id.py

@@ -45,4 +45,10 @@ def find_check(cls, value: Any) -> Optional["CheckId"]:
         "no-index-together",
     )
 )
+DRF_META_CHECKS_NAMES = frozenset(
+    (
+        "drf-model-serializer-extra-kwargs",
+        "drf-model-serializer-meta-attribute",
+    )
+)
 ALL_CHECKS_NAMES = frozenset(CheckId._value2member_map_.keys())  # type: ignore

src/extra_checks/checks/drf_serializer_checks.py

@@ -2,6 +2,7 @@
 import site
 from abc import abstractmethod
 from typing import (
+    TYPE_CHECKING,
     Any,
     Iterable,
     Iterator,
@@ -17,11 +18,46 @@
 import django.core.checks
 from rest_framework.serializers import ModelSerializer, Serializer
 
-from .. import CheckId
+from ..ast.protocols import DisableCommentProtocol
+from ..ast.source_provider import SourceProvider
+from ..check_id import DRF_META_CHECKS_NAMES, CheckId
 from ..forms import AttrsForm
 from ..registry import ChecksConfig, registry
 from .base_checks import BaseCheck
 
+if TYPE_CHECKING:
+    cached_property = property
+else:
+    from django.utils.functional import cached_property
+
+
+class DisableCommentProvider(DisableCommentProtocol):
+    def __init__(self, serializer_class: Type[Serializer]):
+        self.serializer_class = serializer_class
+
+    @cached_property
+    def _source_provider(self) -> SourceProvider:
+        return SourceProvider(self.serializer_class)
+
+    def is_disabled_by_comment(self, check_id: str) -> bool:
+        check = CheckId.find_check(check_id)
+        if check in DRF_META_CHECKS_NAMES:
+            lines = (self._source_provider.source or "").splitlines()
+            # find line starting with `class Meta` and lowest indent
+            try:
+                lineno, _ = sorted(
+                    [
+                        (i, line)
+                        for i, line in enumerate(lines, 1)
+                        if line.strip().startswith(("class Meta(", "class Meta:"))
+                    ],
+                    key=lambda a: a[1].find("class Meta"),
+                )[0]
+            except StopIteration:
+                return False
+            return check in self._source_provider.get_disabled_checks_for_line(lineno)
+        return check in self._source_provider.get_disabled_checks_for_line(1)
+
 
 def _collect_serializers(
     serializers: Iterable[Type[Serializer]],
@@ -90,10 +126,10 @@ def check_drf_serializers(
     s_classes, m_classes = _get_serializers_to_check(config.include_apps)
     for s in s_classes:
         for check in serializer_checks:
-            yield from check(s, None)
+            yield from check(s, DisableCommentProvider(s))
     for s in m_classes:
         for check in model_serializer_checks:
-            yield from check(s, None)
+            yield from check(s, DisableCommentProvider(s))
 
 
 class CheckDRFSerializer(BaseCheck):

tests/example/serializers.py

@@ -23,3 +23,16 @@ class ModernAuthorSerializer(AuthorSerializer):
     class Meta:
         model = Author
         extra_kwargs = {"first_name": {"read_only": True}}
+
+
+class DisableCheckSerializer(serializers.ModelSerializer):
+    first_name = serializers.CharField()
+
+    def method_with_meta_class(self):
+        class Meta:
+            ...
+
+    # extra-checks-disable-next-line drf-model-serializer-extra-kwargs
+    class Meta:
+        model = Author
+        extra_kwargs = {"first_name": {"read_only": True}}

tests/test_drf_serializer_checks.py

@@ -15,6 +15,7 @@
 from tests.example.serializers import (
     ArticleSerializer,
     AuthorSerializer,
+    DisableCheckSerializer,
     ModernAuthorSerializer,
 )
 
@@ -88,3 +89,13 @@ def test_get_serializers_to_check_include_apps(settings):
     # include_apps so it's included too
     assert len(ss) == 1
     assert ss[0] is rest_framework.authtoken.serializers.AuthTokenSerializer
+
+
+def test_drf_ignore_meta_checks(test_case):
+    messages = (
+        test_case.settings({"checks": [CheckDRFSerializerExtraKwargs.Id.value]})
+        .check(CheckDRFSerializerExtraKwargs)
+        .serializers(DisableCheckSerializer)
+        .run()
+    )
+    assert not messages