Add model-admin check

Author: kalekseev

CHANGELOG.md

@@ -2,8 +2,13 @@
 
 ### Unreleased
 
+### 0.4.0
+
 - Add infra for rest framework serializers checks
-- Add checks drf-model-serializer-extra-kwargs, drf-model-serializer-meta-attribute
+- Add checks
+    - drf-model-serializer-extra-kwargs
+    - drf-model-serializer-meta-attribute
+    - model-admin
 
 ### 0.3.0
 

README.md

@@ -49,6 +49,7 @@ class MyModel(models.Model):
 - **extra-checks-config** - settings.EXTRA_CHECKS is valid config for django-extra-checks (always enabled).
 - **model-attribute** - Each Model in the project must have all attributes from `attrs` setting specified.
 - **model-meta-attribute** - Each Model.Meta in the project must have all attributes from `attrs` setting specified.
+- **model-admin** - Each model must be registered in admin.
 - **field-file-upload-to** - FileField/ImageField must have non empty `upload_to` argument.
 - **field-verbose-name** - All model's fields must have verbose name.
 - **field-verbose-name-gettext** - verbose_name must use gettext.

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = django-extra-checks
-version = 0.3.0
+version = 0.4.0
 author = Konstantin Alekseev
 author_email = [email protected]
 description = Collection of useful checks for Django Checks Framework

src/extra_checks/__init__.py

@@ -6,6 +6,7 @@ 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"

src/extra_checks/checks/model_checks.py

@@ -4,6 +4,8 @@
 
 import django.core.checks
 from django import forms
+from django.apps import apps
+from django.contrib.admin.sites import all_sites
 from django.db import models
 from django.db.models.options import DEFAULT_NAMES as META_ATTRS
 
@@ -62,10 +64,6 @@ def check_models(
                     yield from check(field, field_ast=field_ast, model=model)
 
 
-class MetaAttrsForm(BaseCheckForm):
-    attrs = forms.MultipleChoiceField(choices=[(o, o) for o in META_ATTRS])
-
-
 class CheckModel(BaseCheck):
     @abstractmethod
     def apply(
@@ -102,6 +100,10 @@ def apply(
 @registry.register(django.core.checks.Tags.models)
 class CheckModelMetaAttribute(CheckModel):
     Id = CheckId.X011
+
+    class MetaAttrsForm(BaseCheckForm):
+        attrs = forms.MultipleChoiceField(choices=[(o, o) for o in META_ATTRS])
+
     settings_form_class = MetaAttrsForm
 
     def __init__(self, attrs: List[str], **kwargs: Any) -> None:
@@ -122,3 +124,33 @@ def apply(
                     hint=f'Set "{attr}" attribute in Meta.',
                     obj=model,
                 )
+
+
+@registry.register(django.core.checks.Tags.models)
+class CheckModelAdmin(CheckModel):
+    Id = CheckId.X012
+
+    class AdminForm(BaseCheckForm):
+        def clean(self) -> dict:
+            if not apps.is_installed("django.contrib.admin"):
+                raise forms.ValidationError(
+                    "django.contrib.admin must be in INSTALLED_APPS."
+                )
+            return super().clean()
+
+    settings_form_class = AdminForm
+
+    def __init__(self, **kwargs: Any) -> None:
+        super().__init__(**kwargs)
+        self.models_with_admin = set()
+        for admin_site in all_sites:
+            for model_cls, admin_cls in admin_site._registry.items():
+                self.models_with_admin.add(model_cls)
+                for inline in admin_cls.inlines:
+                    self.models_with_admin.add(inline.model)
+
+    def apply(
+        self, model: Type[models.Model], model_ast: ModelAST
+    ) -> Iterator[django.core.checks.CheckMessage]:
+        if model not in self.models_with_admin:
+            yield self.message("The model is not registered in admin.", obj=model)

src/extra_checks/checks/model_field_checks.py

@@ -21,11 +21,10 @@ def apply(
         raise NotImplementedError()
 
 
-class GettTextFuncForm(BaseCheckForm):
-    gettext_func = forms.CharField(required=False)
-
-
 class GetTextMixin(BaseCheckMixin):
+    class GettTextFuncForm(BaseCheckForm):
+        gettext_func = forms.CharField(required=False)
+
     settings_form_class = GettTextFuncForm
 
     def __init__(self, gettext_func: str, **kwargs: Any) -> None:
@@ -167,16 +166,16 @@ def apply(
                 )
 
 
-class CheckFieldForeignKeyIndexForm(BaseCheckForm):
-    when = forms.ChoiceField(
-        choices=[("unique_together", "unique_together"), ("always", "always")],
-        required=False,
-    )
-
-
 @registry.register(django.core.checks.Tags.models)
 class CheckFieldForeignKeyIndex(CheckModelField):
     Id = CheckId.X058
+
+    class CheckFieldForeignKeyIndexForm(BaseCheckForm):
+        when = forms.ChoiceField(
+            choices=[("unique_together", "unique_together"), ("always", "always")],
+            required=False,
+        )
+
     settings_form_class = CheckFieldForeignKeyIndexForm
 
     def __init__(self, when: str, **kwargs: Any) -> None:

tests/example/admin.py

@@ -0,0 +1,14 @@
+from django.contrib import admin
+
+from .models import Article, Author
+
+
+class ArticleInline(admin.TabularInline):
+    model = Article
+
+
+@admin.register(Author)
+class AuthorAdmin(admin.ModelAdmin):
+    inlines = [
+        ArticleInline,
+    ]

tests/example/models.py

@@ -5,22 +5,25 @@
 _ = gettext_lazy
 
 
+if True:
+    # test that indentation doesn't break ast parser
+    class Author(models.Model):
+        first_name = models.CharField(max_length=100)
+        last_name = models.CharField(max_length=100)
+
+
 class Article(models.Model):
     site = models.ForeignKey(Site, verbose_name="site", on_delete=models.CASCADE)
     title = models.CharField("article title", max_length=100)
     text = models.TextField(verbose_name="article text")
+    author = models.ForeignKey(
+        Author, related_name="articles", on_delete=models.CASCADE
+    )
 
     class Meta:
         verbose_name = "Site Article"
 
 
-if True:
-    # test that indentation doesn't break ast parser
-    class Author(models.Model):
-        first_name = models.CharField(max_length=100)
-        last_name = models.CharField(max_length=100)
-
-
 class NestedField(models.Field):
     """Resembles fields like postgres ArrayField."""
 

tests/settings.py

@@ -2,7 +2,16 @@
 
 ALLOWED_HOSTS = ["*"]
 
-INSTALLED_APPS = ["django.contrib.sites", "tests.example", "extra_checks"]
+INSTALLED_APPS = [
+    "django.contrib.sites",
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.messages",
+    "django.contrib.sessions",
+    "tests.example",
+    "extra_checks",
+]
 
 DATABASES = {"default": {"ENGINE": "django.db.backends.sqlite3"}}
 

tests/test_model_checks.py

@@ -1,7 +1,7 @@
 import pytest
 
 from extra_checks.checks import model_checks
-from tests.example.models import Article, Author
+from tests.example.models import Article, Author, ModelFieldTextNull
 
 
 @pytest.fixture
@@ -67,3 +67,16 @@ def test_check_model_meta_attrs(test_case):
     messages = test_case.models(Author).run()
     assert len(messages) == 1
     assert messages[0].id == model_checks.CheckModelMetaAttribute.Id.name
+
+
+def test_admin_models(test_case):
+    messages = (
+        test_case.models(Article, Author)
+        .settings({"checks": [model_checks.CheckModelAdmin.Id.value]})
+        .check(model_checks.CheckModelAdmin)
+        .run()
+    )
+    assert not messages
+    messages = test_case.models(ModelFieldTextNull).run()
+    assert len(messages) == 1
+    assert messages[0].id == model_checks.CheckModelAdmin.Id.name