FEAT: Support Django 5.1 - Remove index_together usage and update CI/Test Configs (#452)

* Replaced index together with meta.indexes where ever necessary

* Updated_changes

* debug index_together

* modified the code related to the index_together

* modifed code

---------

Co-authored-by: Gaurav Sharma <sharmag@microsoft.com>

Author: NandanaRaol

azure-pipelines.yml

@@ -24,6 +24,19 @@ jobs:
 
     strategy:
       matrix:
+        Python3.13 - Django 5.1:
+          python.version: '3.13'
+          tox.env: 'py313-django51'
+        Python3.12 - Django 5.1:
+          python.version: '3.12'
+          tox.env: 'py312-django51'
+        Python3.11 - Django 5.1:
+          python.version: '3.11'
+          tox.env: 'py311-django51'
+        Python3.10 - Django 5.1:
+          python.version: '3.10'
+          tox.env: 'py310-django51'
+
         Python3.12 - Django 5.0:
           python.version: '3.12'
           tox.env: 'py312-django50'
@@ -138,6 +151,19 @@ jobs:
 
     strategy:
       matrix:
+        Python3.13 - Django 5.1:
+          python.version: '3.13'
+          tox.env: 'py313-django51'
+        Python3.12 - Django 5.1:
+          python.version: '3.12'
+          tox.env: 'py312-django51'
+        Python3.11 - Django 5.1:
+          python.version: '3.11'
+          tox.env: 'py311-django51'
+        Python3.10 - Django 5.1:
+          python.version: '3.10'
+          tox.env: 'py310-django51'
+
         Python3.12 - Django 5.0:
           python.version: '3.12'
           tox.env: 'py312-django50'

mssql/schema.py

@@ -292,17 +292,24 @@ def alter_unique_together(self, model, old_unique_together, new_unique_together)
     def _model_indexes_sql(self, model):
         """
         Return a list of all index SQL statements (field indexes,
-        index_together, Meta.indexes) for the specified model.
+        Meta.indexes) for the specified model.
         """
         if not model._meta.managed or model._meta.proxy or model._meta.swapped:
             return []
         output = []
         for field in model._meta.local_fields:
             output.extend(self._field_indexes_sql(model, field))
-
-        for field_names in model._meta.index_together:
-            fields = [model._meta.get_field(field) for field in field_names]
-            output.append(self._create_index_sql(model, fields, suffix="_idx"))
+         # meta.index_together is removed in Django 5.1, so add a version check to handle compatibility
+        if django_version < (5, 1):
+            # Iterate over each set of field names defined in index_together
+            for field_names in model._meta.index_together:
+               # Get the actual field objects for each field name
+               fields = [model._meta.get_field(field) for field in field_names]
+               # Generate the SQL statement to create the index for these fields
+               sql=self._create_index_sql(model, fields, suffix="_idx")
+               # If SQL was generated (not None), add it to the output list
+               if sql:
+                 output.append(sql)
 
         if django_version >= (4, 0):
             for field_names in model._meta.unique_together:
@@ -803,10 +810,15 @@ def _alter_field(self, model, old_field, new_field, old_type, new_type,
             if old_field.db_index and new_field.db_index:
                 index_columns.append([old_field])
             else:
-                for fields in model._meta.index_together:
-                    columns = [model._meta.get_field(field) for field in fields]
-                    if old_field.column in [c.column for c in columns]:
-                        index_columns.append(columns)
+                # Handle index_together for only django version < 5.1
+                if django_version < (5, 1):
+                   # Get the field objects for each field name in the index_together. 
+                   for fields in model._meta.index_together:
+                      # If the old field's column is among the columns for this index,
+                      # add this set of columns to index_columns for later index recreation.
+                      columns = [model._meta.get_field(field) for field in fields]
+                      if old_field.column in [c.column for c in columns]:
+                         index_columns.append(columns)
             if index_columns:
                 for columns in index_columns:
                     create_index_sql_statement = self._create_index_sql(model, columns)
@@ -935,10 +947,15 @@ def _delete_indexes(self, model, old_field, new_field):
             index_columns.append([old_field.column])
         elif old_field.null != new_field.null:
             index_columns.append([old_field.column])
-        for fields in model._meta.index_together:
-            columns = [model._meta.get_field(field).column for field in fields]
-            if old_field.column in columns:
-                index_columns.append(columns)
+        # Handle index_together for only django version < 5.1    
+        if django_version < (5, 1):  
+           # Iterate over each set of field names defined in index_together  
+           for fields in model._meta.index_together:
+              # Get the actual column names for each field in the set
+              columns = [model._meta.get_field(field).column for field in fields]
+              # If the old field's column is among these columns, add to index_columns for later index deletion
+              if old_field.column in columns:
+                 index_columns.append(columns)
 
         for index in model._meta.indexes:
             columns = [model._meta.get_field(field).column for field in index.fields]

setup.py

@@ -21,6 +21,7 @@
     'Framework :: Django :: 4.1',
     'Framework :: Django :: 4.2',
     'Framework :: Django :: 5.0',
+    'Framework :: Django :: 5.1',
 ]
 
 this_directory = path.abspath(path.dirname(__file__))
@@ -42,7 +43,7 @@
     license='BSD',
     packages=find_packages(),
     install_requires=[
-        'django>=3.2,<5.1',
+        'django>=3.2,<5.2',
         'pyodbc>=3.0',
         'pytz',
     ],

testapp/tests/test_indexes.py

@@ -116,9 +116,10 @@ def test_correct_indexes_exist(self):
                 expected_index_causes = []
                 if field.db_index:
                     expected_index_causes.append('db_index=True')
-                for field_names in model_cls._meta.index_together:
-                    if field.name in field_names:
-                        expected_index_causes.append(f'index_together[{field_names}]')
+                if VERSION < (5, 1):     
+                   for field_names in model_cls._meta.index_together:
+                      if field.name in field_names:
+                         expected_index_causes.append(f'index_together[{field_names}]')
                 if field._unique and field.null:
                     # This is implemented using a (filtered) unique index (not a constraint) to get ANSI NULL behaviour
                     expected_index_causes.append('unique=True & null=True')
@@ -363,4 +364,4 @@ def test_drop_foreignkey(self):
         )
         # Test alter fk with fk_on_delete_keep_index in db_comment
         # Index should be preserved in this case
-        self.assertIsNotNone(car_index)
+        self.assertIsNotNone(car_index)

tox.ini

@@ -23,3 +23,4 @@ deps =
     django41: django>=4.1a1,<4.2
     django42: django>=4.2,<4.3
     django50: django>=5.0,<5.1
+    django51: django>=5.1,<5.2