Fixed #31468 -- Allowed specifying migration filename in Operation.

adamchainz · felixxm · commit fa58450a9ab8 · 2020-05-28T11:42:53.000+02:00
This adds also suggested filename for many built-in operations.
diff --git a/django/contrib/postgres/operations.py b/django/contrib/postgres/operations.py
@@ -55,6 +55,10 @@ def extension_exists(self, schema_editor, extension):
     def describe(self):
         return "Creates extension %s" % self.name
 
+    @property
+    def migration_name_fragment(self):
+        return 'create_extension_%s' % self.name
+
 
 class BloomExtension(CreateExtension):
 
diff --git a/django/db/migrations/autodetector.py b/django/db/migrations/autodetector.py
@@ -1313,19 +1313,14 @@ def suggest_name(cls, ops):
         represent. Names are not guaranteed to be unique, but put some effort
         into the fallback name to avoid VCS conflicts if possible.
         """
+        name = None
         if len(ops) == 1:
-            if isinstance(ops[0], operations.CreateModel):
-                return ops[0].name_lower
-            elif isinstance(ops[0], operations.DeleteModel):
-                return "delete_%s" % ops[0].name_lower
-            elif isinstance(ops[0], operations.AddField):
-                return "%s_%s" % (ops[0].model_name_lower, ops[0].name_lower)
-            elif isinstance(ops[0], operations.RemoveField):
-                return "remove_%s_%s" % (ops[0].model_name_lower, ops[0].name_lower)
-        elif ops:
-            if all(isinstance(o, operations.CreateModel) for o in ops):
-                return "_".join(sorted(o.name_lower for o in ops))
-        return "auto_%s" % get_migration_name_timestamp()
+            name = ops[0].migration_name_fragment
+        elif len(ops) > 1 and all(isinstance(o, operations.CreateModel) for o in ops):
+            name = '_'.join(sorted(o.migration_name_fragment for o in ops))
+        if name is None:
+            name = 'auto_%s' % get_migration_name_timestamp()
+        return name
 
     @classmethod
     def parse_number(cls, name):
diff --git a/django/db/migrations/operations/base.py b/django/db/migrations/operations/base.py
@@ -79,6 +79,14 @@ def describe(self):
         """
         return "%s: %s" % (self.__class__.__name__, self._constructor_args)
 
+    @property
+    def migration_name_fragment(self):
+        """
+        A filename part suitable for automatically naming a migration
+        containing this operation, or None if not applicable.
+        """
+        return None
+
     def references_model(self, name, app_label):
         """
         Return True if there is a chance this operation references the given
diff --git a/django/db/migrations/operations/fields.py b/django/db/migrations/operations/fields.py
@@ -116,6 +116,10 @@ def database_backwards(self, app_label, schema_editor, from_state, to_state):
     def describe(self):
         return "Add field %s to %s" % (self.name, self.model_name)
 
+    @property
+    def migration_name_fragment(self):
+        return '%s_%s' % (self.model_name_lower, self.name_lower)
+
     def reduce(self, operation, app_label):
         if isinstance(operation, FieldOperation) and self.is_same_field_operation(operation):
             if isinstance(operation, AlterField):
@@ -174,6 +178,10 @@ def database_backwards(self, app_label, schema_editor, from_state, to_state):
     def describe(self):
         return "Remove field %s from %s" % (self.name, self.model_name)
 
+    @property
+    def migration_name_fragment(self):
+        return 'remove_%s_%s' % (self.model_name_lower, self.name_lower)
+
     def reduce(self, operation, app_label):
         from .models import DeleteModel
         if isinstance(operation, DeleteModel) and operation.name_lower == self.model_name_lower:
@@ -243,6 +251,10 @@ def database_backwards(self, app_label, schema_editor, from_state, to_state):
     def describe(self):
         return "Alter field %s on %s" % (self.name, self.model_name)
 
+    @property
+    def migration_name_fragment(self):
+        return 'alter_%s_%s' % (self.model_name_lower, self.name_lower)
+
     def reduce(self, operation, app_label):
         if isinstance(operation, RemoveField) and self.is_same_field_operation(operation):
             return [operation]
@@ -354,6 +366,14 @@ def database_backwards(self, app_label, schema_editor, from_state, to_state):
     def describe(self):
         return "Rename field %s on %s to %s" % (self.old_name, self.model_name, self.new_name)
 
+    @property
+    def migration_name_fragment(self):
+        return 'rename_%s_%s_%s' % (
+            self.old_name_lower,
+            self.model_name_lower,
+            self.new_name_lower,
+        )
+
     def references_field(self, model_name, name, app_label):
         return self.references_model(model_name, app_label) and (
             name.lower() == self.old_name_lower or
diff --git a/django/db/migrations/operations/models.py b/django/db/migrations/operations/models.py
@@ -99,6 +99,10 @@ def database_backwards(self, app_label, schema_editor, from_state, to_state):
     def describe(self):
         return "Create %smodel %s" % ("proxy " if self.options.get("proxy", False) else "", self.name)
 
+    @property
+    def migration_name_fragment(self):
+        return self.name_lower
+
     def references_model(self, name, app_label):
         name_lower = name.lower()
         if name_lower == self.name_lower:
@@ -273,6 +277,10 @@ def references_model(self, name, app_label):
     def describe(self):
         return "Delete model %s" % self.name
 
+    @property
+    def migration_name_fragment(self):
+        return 'delete_%s' % self.name_lower
+
 
 class RenameModel(ModelOperation):
     """Rename a model."""
@@ -397,6 +405,10 @@ def references_model(self, name, app_label):
     def describe(self):
         return "Rename model %s to %s" % (self.old_name, self.new_name)
 
+    @property
+    def migration_name_fragment(self):
+        return 'rename_%s_%s' % (self.old_name_lower, self.new_name_lower)
+
     def reduce(self, operation, app_label):
         if (isinstance(operation, RenameModel) and
                 self.new_name_lower == operation.old_name_lower):
@@ -470,6 +482,10 @@ def describe(self):
             self.table if self.table is not None else "(default)"
         )
 
+    @property
+    def migration_name_fragment(self):
+        return 'alter_%s_table' % self.name_lower
+
 
 class AlterTogetherOptionOperation(ModelOptionOperation):
     option_name = None
@@ -526,6 +542,10 @@ def references_field(self, model_name, name, app_label):
     def describe(self):
         return "Alter %s for %s (%s constraint(s))" % (self.option_name, self.name, len(self.option_value or ''))
 
+    @property
+    def migration_name_fragment(self):
+        return 'alter_%s_%s' % (self.name_lower, self.option_name)
+
 
 class AlterUniqueTogether(AlterTogetherOptionOperation):
     """
@@ -607,6 +627,10 @@ def references_field(self, model_name, name, app_label):
     def describe(self):
         return "Set order_with_respect_to on %s to %s" % (self.name, self.order_with_respect_to)
 
+    @property
+    def migration_name_fragment(self):
+        return 'alter_%s_order_with_respect_to' % self.name_lower
+
 
 class AlterModelOptions(ModelOptionOperation):
     """
@@ -662,6 +686,10 @@ def database_backwards(self, app_label, schema_editor, from_state, to_state):
     def describe(self):
         return "Change Meta options on %s" % self.name
 
+    @property
+    def migration_name_fragment(self):
+        return 'alter_%s_options' % self.name_lower
+
 
 class AlterModelManagers(ModelOptionOperation):
     """Alter the model's managers."""
@@ -693,6 +721,10 @@ def database_backwards(self, app_label, schema_editor, from_state, to_state):
     def describe(self):
         return "Change managers on %s" % self.name
 
+    @property
+    def migration_name_fragment(self):
+        return 'alter_%s_managers' % self.name_lower
+
 
 class IndexOperation(Operation):
     option_name = 'indexes'
@@ -747,6 +779,10 @@ def describe(self):
             self.model_name,
         )
 
+    @property
+    def migration_name_fragment(self):
+        return '%s_%s' % (self.model_name_lower, self.index.name.lower())
+
 
 class RemoveIndex(IndexOperation):
     """Remove an index from a model."""
@@ -789,6 +825,10 @@ def deconstruct(self):
     def describe(self):
         return 'Remove index %s from %s' % (self.name, self.model_name)
 
+    @property
+    def migration_name_fragment(self):
+        return 'remove_%s_%s' % (self.model_name_lower, self.name.lower())
+
 
 class AddConstraint(IndexOperation):
     option_name = 'constraints'
@@ -821,6 +861,10 @@ def deconstruct(self):
     def describe(self):
         return 'Create constraint %s on model %s' % (self.constraint.name, self.model_name)
 
+    @property
+    def migration_name_fragment(self):
+        return '%s_%s' % (self.model_name_lower, self.constraint.name.lower())
+
 
 class RemoveConstraint(IndexOperation):
     option_name = 'constraints'
@@ -857,3 +901,7 @@ def deconstruct(self):
 
     def describe(self):
         return 'Remove constraint %s from model %s' % (self.name, self.model_name)
+
+    @property
+    def migration_name_fragment(self):
+        return 'remove_%s_%s' % (self.model_name_lower, self.name.lower())
diff --git a/docs/ref/migration-operations.txt b/docs/ref/migration-operations.txt
@@ -484,6 +484,16 @@ structure of an ``Operation`` looks like this::
             # This is used to describe what the operation does in console output.
             return "Custom Operation"
 
+        @property
+        def migration_name_fragment(self):
+            # Optional. A filename part suitable for automatically naming a
+            # migration containing this operation, or None if not applicable.
+            return "custom_operation_%s_%s" % (self.arg1, self.arg2)
+
+.. versionadded:: 3.2
+
+    The ``migration_name_fragment`` property was added.
+
 You can take this template and work from it, though we suggest looking at the
 built-in Django operations in ``django.db.migrations.operations`` - they cover
 a lot of the example usage of semi-internal aspects of the migration framework
@@ -553,3 +563,7 @@ state changes, all it does is run one command::
 
         def describe(self):
             return "Creates extension %s" % self.name
+
+        @property
+        def migration_name_fragment(self):
+            return "create_extension_%s" % self.name
diff --git a/docs/releases/3.2.txt b/docs/releases/3.2.txt
@@ -171,7 +171,9 @@ Management Commands
 Migrations
 ~~~~~~~~~~
 
-* ...
+* The new ``Operation.migration_name_fragment`` property allows providing a
+  filename fragment that will be used to name a migration containing only that
+  operation.
 
 Models
 ~~~~~~
diff --git a/tests/migrations/test_autodetector.py b/tests/migrations/test_autodetector.py
@@ -2495,6 +2495,11 @@ def test_two_create_models(self):
         ]
         self.assertEqual(MigrationAutodetector.suggest_name(ops), 'animal_person')
 
+    def test_none_name(self):
+        ops = [migrations.RunSQL('SELECT 1 FROM person;')]
+        suggest_name = MigrationAutodetector.suggest_name(ops)
+        self.assertIs(suggest_name.startswith('auto_'), True)
+
     def test_auto(self):
         suggest_name = MigrationAutodetector.suggest_name([])
         self.assertIs(suggest_name.startswith('auto_'), True)
diff --git a/tests/migrations/test_operations.py b/tests/migrations/test_operations.py
diff --git a/tests/postgres_tests/test_operations.py b/tests/postgres_tests/test_operations.py
