Fixes and include_types feature

Author: kalekseev

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ### Unreleased
 
+- Fix ignore_checks
+- Skip models fields not inherited from fields.Field
+- Add ignore_types option
+
 ### 0.4.1
 
 - Fix message for *field-verbose-name-gettext-case*

conftest.py

@@ -32,9 +32,11 @@ def handler(self, handler):
         return self
 
     def run(self):
-        assert self._registry.is_healthy
         self._registry.enabled_checks = {}
         handlers = self._registry.bind()
+        assert (
+            self._registry.is_healthy
+        ), f"Settings has errors: {self._registry._config.errors.as_text()}"
         return list(handlers[self.TEST_TAG]())
 
     def models(self, *models):

src/extra_checks/__init__.py

@@ -1,40 +1,9 @@
-import enum
-from typing import Any, Callable, Union
-
-
-class CheckId(str, enum.Enum):
-    X001 = "extra-checks-config"
-    X010 = "model-attribute"
-    X011 = "model-meta-attribute"
-    X012 = "model-admin"
-    X050 = "field-verbose-name"
-    X051 = "field-verbose-name-gettext"
-    X052 = "field-verbose-name-gettext-case"
-    X053 = "field-help-text-gettext"
-    X054 = "field-file-upload-to"
-    X055 = "field-text-null"
-    X056 = "field-boolean-null"
-    X057 = "field-null"
-    X058 = "field-foreign-key-db-index"
-    X301 = "drf-model-serializer-extra-kwargs"
-    X302 = "drf-model-serializer-meta-attribute"
-
-
-_IGNORED = {}
-
-EXTRA_CHECKS_ALL_RULES = list(CheckId.__members__.keys())
-
-
-def ignore_checks(*args: Union[CheckId, str]) -> Callable[[Any], Any]:
-    def f(entity: Any) -> Any:
-        _IGNORED[entity] = set(args)
-        return entity
-
-    return f
-
+from .check_id import CheckId
+from .registry import ignore_checks
 
 default_app_config = "extra_checks.apps.ExtraChecksConfig"
 
+
 __all__ = [
     "ignore_checks",
     "CheckId",

src/extra_checks/apps.py

@@ -1,12 +1,12 @@
 from django.apps import AppConfig
 
+from . import checks  # noqa
+from .registry import registry
+
 
 class ExtraChecksConfig(AppConfig):
     name = "extra_checks"
 
     def ready(self) -> None:
         super(ExtraChecksConfig, self).ready()
-        from . import checks  # noqa
-        from .registry import registry
-
         registry.bind()

src/extra_checks/ast.py

@@ -116,20 +116,7 @@ def kwargs(self) -> Dict[str, ast.keyword]:
 
     @cached_property
     def verbose_name(self) -> Union[None, ast.Constant, ast.Call]:
-        result = getattr(self.kwargs.get("verbose_name"), "value", None)
-        if result:
-            return result
-        if (
-            self.field_class_name
-            not in ("OneToOneField", "ManyToManyField", "ForeignKey")
-            and self.args
-        ):
-            node = self.args[0]
-            if isinstance(node, ast.Call) and hasattr(node.func, "id"):
-                return node
-            elif isinstance(node, (ast.Constant, ast.Str)):
-                return node
-        return None
+        return getattr(self.kwargs.get("verbose_name"), "value", None)
 
     @cached_property
     def help_text(self) -> Optional[ast.AST]:

src/extra_checks/check_id.py

@@ -0,0 +1,19 @@
+import enum
+
+
+class CheckId(str, enum.Enum):
+    X001 = "extra-checks-config"
+    X010 = "model-attribute"
+    X011 = "model-meta-attribute"
+    X012 = "model-admin"
+    X050 = "field-verbose-name"
+    X051 = "field-verbose-name-gettext"
+    X052 = "field-verbose-name-gettext-case"
+    X053 = "field-help-text-gettext"
+    X054 = "field-file-upload-to"
+    X055 = "field-text-null"
+    X056 = "field-boolean-null"
+    X057 = "field-null"
+    X058 = "field-foreign-key-db-index"
+    X301 = "drf-model-serializer-extra-kwargs"
+    X302 = "drf-model-serializer-meta-attribute"

src/extra_checks/checks/base_checks.py

@@ -20,10 +20,14 @@ class BaseCheck(ABC):
     level = django.core.checks.WARNING
 
     def __init__(
-        self, level: Optional[int] = None, ignored_objects: Optional[Set[Any]] = None
+        self,
+        level: Optional[int] = None,
+        ignore_objects: Optional[Set[Any]] = None,
+        ignore_types: Optional[Set[str]] = None,
     ) -> None:
         self.level = level or self.level
-        self.ignored_objects = ignored_objects or set()
+        self.ignore_objects = ignore_objects or set()
+        self.ignore_types = ignore_types or set()
 
     def __call__(
         self, obj: Any, **kwargs: Any
@@ -32,7 +36,7 @@ def __call__(
             yield from self.apply(obj, **kwargs)  # type: ignore
 
     def is_ignored(self, obj: Any) -> bool:
-        return obj in self.ignored_objects
+        return obj in self.ignore_objects or type(obj) in self.ignore_types
 
     def message(
         self, message: str, hint: Optional[str] = None, obj: Any = None

src/extra_checks/checks/model_checks.py

@@ -59,9 +59,10 @@ def check_models(
             yield from check(model, model_ast=model_ast)
         if field_checks:
             for field, node in model_ast.field_nodes:
-                field_ast = FieldAST(node)
-                for check in field_checks:
-                    yield from check(field, field_ast=field_ast, model=model)
+                if isinstance(field, models.fields.Field):
+                    field_ast = FieldAST(node)
+                    for check in field_checks:
+                        yield from check(field, field_ast=field_ast, model=model)
 
 
 class CheckModel(BaseCheck):

src/extra_checks/checks/model_field_checks.py

@@ -1,6 +1,6 @@
 import ast
 from abc import abstractmethod
-from typing import Any, Iterator, Type
+from typing import Any, Iterator, Type, Union
 
 import django.core.checks
 from django import forms
@@ -16,10 +16,17 @@
 class CheckModelField(BaseCheck):
     @abstractmethod
     def apply(
-        self, field: object, *, field_ast: FieldAST, model: Type[models.Model]
+        self,
+        field: models.fields.Field,
+        *,
+        field_ast: FieldAST,
+        model: Type[models.Model],
     ) -> Iterator[django.core.checks.CheckMessage]:
         raise NotImplementedError()
 
+    def is_ignored(self, obj: Any) -> bool:
+        return obj.model in self.ignore_objects or type(obj) in self.ignore_types
+
 
 class GetTextMixin(BaseCheckMixin):
     class GettTextFuncForm(BaseCheckForm):
@@ -38,14 +45,32 @@ def _is_gettext_node(self, node: ast.AST) -> bool:
         )
 
 
+def get_verbose_name(
+    field: models.fields.Field, field_ast: FieldAST
+) -> Union[None, ast.Constant, ast.Call]:
+    result = field_ast.verbose_name
+    if result:
+        return result
+    if isinstance(field, models.fields.related.RelatedField):
+        return None
+    if field_ast.args:
+        node = field_ast.args[0]
+        if isinstance(node, ast.Call) and hasattr(node.func, "id"):
+            return node
+        elif isinstance(node, (ast.Constant, ast.Str)):
+            return node
+    return None
+
+
 @registry.register(django.core.checks.Tags.models)
 class CheckFieldVerboseName(CheckModelField):
     Id = CheckId.X050
 
     def apply(
-        self, field: object, field_ast: FieldAST, **kwargs: Any
+        self, field: models.fields.Field, field_ast: FieldAST, **kwargs: Any
     ) -> Iterator[django.core.checks.CheckMessage]:
-        if not field_ast.verbose_name:
+        verbose_name = get_verbose_name(field, field_ast)
+        if not verbose_name:
             yield self.message(
                 "Field has no verbose name.",
                 hint="Set verbose name on the field.",
@@ -58,9 +83,10 @@ class CheckFieldVerboseNameGettext(GetTextMixin, CheckModelField):
     Id = CheckId.X051
 
     def apply(
-        self, field: object, field_ast: FieldAST, **kwargs: Any
+        self, field: models.fields.Field, field_ast: FieldAST, **kwargs: Any
     ) -> Iterator[django.core.checks.CheckMessage]:
-        if field_ast.verbose_name and not self._is_gettext_node(field_ast.verbose_name):
+        verbose_name = get_verbose_name(field, field_ast)
+        if verbose_name and not self._is_gettext_node(verbose_name):
             yield self.message(
                 "Verbose name should use gettext.",
                 hint="Use gettext on the verbose name.",
@@ -73,10 +99,11 @@ class CheckFieldVerboseNameGettextCase(GetTextMixin, CheckModelField):
     Id = CheckId.X052
 
     def apply(
-        self, field: object, field_ast: FieldAST, **kwargs: Any
+        self, field: models.fields.Field, field_ast: FieldAST, **kwargs: Any
     ) -> Iterator[django.core.checks.CheckMessage]:
-        if field_ast.verbose_name and self._is_gettext_node(field_ast.verbose_name):
-            value = field_ast.verbose_name.args[0].s  # type: ignore
+        verbose_name = get_verbose_name(field, field_ast)
+        if verbose_name and self._is_gettext_node(verbose_name):
+            value = verbose_name.args[0].s  # type: ignore
             if not all(
                 w.islower() or w.isupper() or w.isdigit() for w in value.split(" ")
             ):
@@ -92,7 +119,7 @@ class CheckFieldHelpTextGettext(GetTextMixin, CheckModelField):
     Id = CheckId.X053
 
     def apply(
-        self, field: object, field_ast: FieldAST, **kwargs: Any
+        self, field: models.fields.Field, field_ast: FieldAST, **kwargs: Any
     ) -> Iterator[django.core.checks.CheckMessage]:
         if field_ast.help_text and not self._is_gettext_node(field_ast.help_text):
             yield self.message(
@@ -107,7 +134,7 @@ class CheckFieldFileUploadTo(CheckModelField):
     Id = CheckId.X054
 
     def apply(
-        self, field: object, **kwargs: Any
+        self, field: models.fields.Field, **kwargs: Any
     ) -> Iterator[django.core.checks.CheckMessage]:
         if isinstance(field, models.FileField):
             if not field.upload_to:
@@ -123,7 +150,7 @@ class CheckFieldTextNull(CheckModelField):
     Id = CheckId.X055
 
     def apply(
-        self, field: object, **kwargs: Any
+        self, field: models.fields.Field, **kwargs: Any
     ) -> Iterator[django.core.checks.CheckMessage]:
         if isinstance(field, (models.CharField, models.TextField)):
             if field.null:
@@ -140,7 +167,7 @@ class CheckFieldNullBoolean(CheckModelField):
     Id = CheckId.X056
 
     def apply(
-        self, field: object, **kwargs: Any
+        self, field: models.fields.Field, **kwargs: Any
     ) -> Iterator[django.core.checks.CheckMessage]:
         if isinstance(field, models.NullBooleanField):
             yield self.message(
@@ -155,15 +182,14 @@ class CheckFieldNullFalse(CheckModelField):
     Id = CheckId.X057
 
     def apply(
-        self, field: object, field_ast: FieldAST, **kwargs: Any
+        self, field: models.fields.Field, field_ast: FieldAST, **kwargs: Any
     ) -> Iterator[django.core.checks.CheckMessage]:
-        if isinstance(field, models.fields.Field):
-            if field.null is False and "null" in field_ast.kwargs:
-                yield self.message(
-                    "Argument `null=False` is default.",
-                    hint="Remove `null=False` from field arguments.",
-                    obj=field,
-                )
+        if field.null is False and "null" in field_ast.kwargs:
+            yield self.message(
+                "Argument `null=False` is default.",
+                hint="Remove `null=False` from field arguments.",
+                obj=field,
+            )
 
 
 @registry.register(django.core.checks.Tags.models)
@@ -183,7 +209,10 @@ def __init__(self, when: str, **kwargs: Any) -> None:
         super().__init__(**kwargs)
 
     def apply(
-        self, field: object, field_ast: FieldAST, model: Type[models.Model],
+        self,
+        field: models.fields.Field,
+        field_ast: FieldAST,
+        model: Type[models.Model],
     ) -> Iterator[django.core.checks.CheckMessage]:
         if isinstance(field, models.fields.related.RelatedField):
             if field.many_to_one and field_ast.kwargs.get("db_index") is None:

src/extra_checks/forms.py

@@ -1,3 +1,4 @@
+import importlib
 import typing
 
 import django.core.checks
@@ -165,12 +166,36 @@ class BaseCheckForm(forms.Form):
         choices=[(c, c) for c in ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"]],
         required=False,
     )
+    ignore_types = ListField(forms.CharField(), required=False)
 
     def clean_level(self) -> typing.Optional[int]:
         if self.cleaned_data["level"]:
             return getattr(django.core.checks, self.cleaned_data["level"])
         return None
 
+    def clean_ignore_types(self) -> set:
+        value = self.cleaned_data["ignore_types"]
+        if not value:
+            return value
+        result = []
+        for import_path in value:
+            try:
+                path, entry = import_path.rsplit(".", 1)
+                result.append(getattr(importlib.import_module(path), entry))
+            except (ImportError, ValueError, AttributeError):
+                raise forms.ValidationError(
+                    f"ignore_types contains entry that can't be imported: '{import_path}'."
+                )
+        return result
+
+    def clean(self) -> typing.Dict[str, typing.Any]:
+        if (
+            "ignore_types" in self.cleaned_data
+            and not self.cleaned_data["ignore_types"]
+        ):
+            del self.cleaned_data["ignore_types"]
+        return self.cleaned_data
+
 
 class AttrsForm(BaseCheckForm):
     attrs = ListField(forms.CharField())