chores: remove no-index-together

Author: kalekseev

.github/workflows/main.yml

@@ -34,6 +34,8 @@ jobs:
             python-version: 3.8
           - django-version: "Django>=5.0,<5.1"
             python-version: 3.9
+          - django-version: "Django==5.1a1"
+            python-version: 3.8
           - django-version: "Django==5.1a1"
             python-version: 3.9
           # - django-version: "https://github.com/django/django/archive/main.tar.gz"

CHANGELOG.md

@@ -2,7 +2,10 @@
 
 ### Unreleased
 
+### 0.15.0
+
 - chores: Add python3.13 and django5.1 to test matrix
+- chores: remove `no-index-together`
 
 ### 0.14.1
 

README.md

@@ -10,15 +10,13 @@ Collection of useful checks for Django Checks Frameworks
 - **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.
 - **no-unique-together** - Use `UniqueConstraint` with the `constraints` option instead.
-- **no-index-together** - [DEPRECATED] Use the `indexes` option instead.
 - **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.
 - **field-verbose-name-gettext-case** - Words in text wrapped with gettext must be in one case.
 - **field-help-text-gettext** - `help_text` must use gettext.
 - **field-text-null** - text fields shouldn't use `null=True`.
-- **field-boolean-null** - [DEPRECATED] prefer using `BooleanField(null=True)` instead of `NullBooleanField`.
 - **field-null** - don't pass `null=False` to model fields (this is django default).
 - **field-foreign-key-db-index** - ForeignKey fields must specify `db_index` explicitly (to apply only to fields in indexes: `when: indexes`).
 - **field-related-name** - Related fields must specify `related_name` explicitly.

src/extra_checks/check_id.py

@@ -8,7 +8,7 @@ class CheckId(str, enum.Enum):
     X011 = "model-meta-attribute"
     X012 = "model-admin"
     X013 = "no-unique-together"
-    X014 = "no-index-together"
+    # X014 = "no-index-together" - removed
     X050 = "field-verbose-name"
     X051 = "field-verbose-name-gettext"
     X052 = "field-verbose-name-gettext-case"

src/extra_checks/checks/model_checks.py

@@ -179,17 +179,3 @@ def apply(
                 "Use UniqueConstraint with the constraints option instead.",
                 obj=model,
             )
-
-
-@registry.register(django.core.checks.Tags.models)
-class CheckNoIndexTogether(CheckModelMeta):
-    Id = CheckId.X014
-    deprecation_warnings = [
-        "`no-index-together` check is deprecated and will be removed in a future version"
-    ]
-
-    def apply(
-        self, model: Type[models.Model], ast: ModelASTProtocol
-    ) -> Iterator[django.core.checks.CheckMessage]:
-        if ast.has_meta_var("index_together"):
-            yield self.message("Use the indexes option instead", obj=model)

src/extra_checks/checks/model_field_checks.py

@@ -1,6 +1,7 @@
 from abc import abstractmethod
 from typing import Any, Iterator, Optional, Type
 
+import django
 import django.core.checks
 from django import forms
 from django.db import models
@@ -198,8 +199,9 @@ def __init__(self, when: str, **kwargs: Any) -> None:
     def get_index_values_in_meta(cls, model: Type[models.Model]) -> Iterator[str]:
         for entry in model._meta.unique_together:
             yield from entry
-        for entry in model._meta.index_together:
-            yield from entry
+        if django.VERSION < (5, 1):
+            for entry in model._meta.index_together:
+                yield from entry
         for constraint in model._meta.constraints:
             if isinstance(constraint, models.UniqueConstraint):
                 yield from constraint.fields

tests/example/models.py

@@ -1,3 +1,4 @@
+import django
 from django.contrib.contenttypes.fields import GenericForeignKey, GenericRelation
 from django.contrib.contenttypes.models import ContentType
 from django.contrib.sites.models import Site
@@ -128,7 +129,8 @@ class ModelFieldForeignKeyIndex(models.Model):
 
     class Meta:
         unique_together = [("author", "article")]
-        index_together = ("field_one", "field_two")
+        if django.VERSION < (5, 1):
+            index_together = ("field_one", "field_two")
         constraints = [
             models.UniqueConstraint(
                 fields=("author", "field_three"), name="fi_author_field_unique"
@@ -231,4 +233,3 @@ class DisableManyChecksModel(models.Model):
     # extra-checks-disable-next-line no-unique-together
     class Meta:
         unique_together = ("text_fail", "text_fail2")
-        index_together = ("text_fail", "text_fail2")

tests/test_ignore.py

@@ -44,15 +44,13 @@ def test_ignore_many_model_check(test_case):
                     model_field_checks.CheckFieldTextNull.Id.value,
                     model_field_checks.CheckFieldVerboseName.Id.value,
                     model_checks.CheckNoUniqueTogether.Id.value,
-                    model_checks.CheckNoIndexTogether.Id.value,
                 ]
             }
         )
         .check(
             model_field_checks.CheckFieldTextNull,
             model_field_checks.CheckFieldVerboseName,
             model_checks.CheckNoUniqueTogether,
-            model_checks.CheckNoIndexTogether,
         )
         .run()
     )

tests/test_model_checks.py

@@ -96,14 +96,3 @@ def test_no_unique_together(test_case):
     )
     assert len(messages) == 1
     assert messages[0].id == model_checks.CheckNoUniqueTogether.Id.name
-
-
-def test_no_index_together(test_case):
-    messages = (
-        test_case.models(ModelFieldForeignKeyIndex)
-        .settings({"checks": [model_checks.CheckNoIndexTogether.Id.value]})
-        .check(model_checks.CheckNoIndexTogether)
-        .run()
-    )
-    assert len(messages) == 1
-    assert messages[0].id == model_checks.CheckNoIndexTogether.Id.name

tests/test_model_field_checks.py

@@ -1,3 +1,4 @@
+import django
 import pytest
 
 from extra_checks.checks import model_checks, model_field_checks
@@ -137,7 +138,7 @@ def test_check_field_foreign_key_index(test_case):
         .run()
     )
     assert {m.obj.name for m in messages} == {
-        "field_one",
+        *(["field_one"] if django.VERSION < (5, 1) else []),
         "author",
         "field_three",
         "field_in_indexes",