p15693087
/
django
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Made Operation.references_model/references_field require app_label. 

This will allow them to drop a ton of logic to deal with null
app_label.
This commit is contained in:
Simon Charette 2020-04-03 23:05:16 -04:00 committed by Mariusz Felisiak
parent 25bf15c0da
commit 8069526ce3
4 changed files with 35 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
django/db/migrations/operations/base.py
View File

@ -80,10 +80,10 @@ class Operation:
""" """
return "%s: %s" % (self.__class__.__name__, self._constructor_args) return "%s: %s" % (self.__class__.__name__, self._constructor_args)
def references_model(self, name, app_label=None): def references_model(self, name, app_label):
""" """
Return True if there is a chance this operation references the given Return True if there is a chance this operation references the given
model name (as a string), with an optional app label for accuracy. model name (as a string), with an app label for accuracy.
Used for optimization. If in doubt, return True; Used for optimization. If in doubt, return True;
returning a false positive will merely make the optimizer a little returning a false positive will merely make the optimizer a little
@ -92,10 +92,10 @@ class Operation:
""" """
return True return True
def references_field(self, model_name, name, app_label=None): def references_field(self, model_name, name, app_label):
""" """
Return True if there is a chance this operation references the given Return True if there is a chance this operation references the given
field name, with an optional app label for accuracy. field name, with an app label for accuracy.
Used for optimization. If in doubt, return True. Used for optimization. If in doubt, return True.
""" """

8
django/db/migrations/operations/fields.py
View File

@ -28,7 +28,7 @@ class FieldOperation(Operation):
def is_same_field_operation(self, operation): def is_same_field_operation(self, operation):
return self.is_same_model_operation(operation) and self.name_lower == operation.name_lower return self.is_same_model_operation(operation) and self.name_lower == operation.name_lower
def references_model(self, name, app_label=None): def references_model(self, name, app_label):
name_lower = name.lower() name_lower = name.lower()
if name_lower == self.model_name_lower: if name_lower == self.model_name_lower:
return True return True
@ -36,7 +36,7 @@ class FieldOperation(Operation):
return field_references_model(self.field, ModelTuple(app_label, name_lower)) return field_references_model(self.field, ModelTuple(app_label, name_lower))
return False return False
def references_field(self, model_name, name, app_label=None): def references_field(self, model_name, name, app_label):
model_name_lower = model_name.lower() model_name_lower = model_name.lower()
# Check if this operation locally references the field. # Check if this operation locally references the field.
if model_name_lower == self.model_name_lower: if model_name_lower == self.model_name_lower:
@ -376,8 +376,8 @@ class RenameField(FieldOperation):
def describe(self): def describe(self):
return "Rename field %s on %s to %s" % (self.old_name, self.model_name, self.new_name) return "Rename field %s on %s to %s" % (self.old_name, self.model_name, self.new_name)
def references_field(self, model_name, name, app_label=None): def references_field(self, model_name, name, app_label):
return self.references_model(model_name) and ( return self.references_model(model_name, app_label) and (
name.lower() == self.old_name_lower or name.lower() == self.old_name_lower or
name.lower() == self.new_name_lower name.lower() == self.new_name_lower
) )

12
django/db/migrations/operations/models.py
View File

@ -28,7 +28,7 @@ class ModelOperation(Operation):
def name_lower(self): def name_lower(self):
return self.name.lower() return self.name.lower()
def references_model(self, name, app_label=None): def references_model(self, name, app_label):
return name.lower() == self.name_lower return name.lower() == self.name_lower
def reduce(self, operation, app_label): def reduce(self, operation, app_label):
@ -99,7 +99,7 @@ class CreateModel(ModelOperation):
def describe(self): def describe(self):
return "Create %smodel %s" % ("proxy " if self.options.get("proxy", False) else "", self.name) return "Create %smodel %s" % ("proxy " if self.options.get("proxy", False) else "", self.name)
def references_model(self, name, app_label=None): def references_model(self, name, app_label):
name_lower = name.lower() name_lower = name.lower()
if name_lower == self.name_lower: if name_lower == self.name_lower:
return True return True
@ -265,7 +265,7 @@ class DeleteModel(ModelOperation):
if self.allow_migrate_model(schema_editor.connection.alias, model): if self.allow_migrate_model(schema_editor.connection.alias, model):
schema_editor.create_model(model) schema_editor.create_model(model)
def references_model(self, name, app_label=None): def references_model(self, name, app_label):
# The deleted model could be referencing the specified model through # The deleted model could be referencing the specified model through
# related fields. # related fields.
return True return True
@ -402,7 +402,7 @@ class RenameModel(ModelOperation):
self.new_name_lower, self.old_name_lower = self.old_name_lower, self.new_name_lower self.new_name_lower, self.old_name_lower = self.old_name_lower, self.new_name_lower
self.new_name, self.old_name = self.old_name, self.new_name self.new_name, self.old_name = self.old_name, self.new_name
def references_model(self, name, app_label=None): def references_model(self, name, app_label):
return ( return (
name.lower() == self.old_name_lower or name.lower() == self.old_name_lower or
name.lower() == self.new_name_lower name.lower() == self.new_name_lower
@ -528,7 +528,7 @@ class AlterTogetherOptionOperation(ModelOptionOperation):
def database_backwards(self, app_label, schema_editor, from_state, to_state): def database_backwards(self, app_label, schema_editor, from_state, to_state):
return self.database_forwards(app_label, schema_editor, from_state, to_state) return self.database_forwards(app_label, schema_editor, from_state, to_state)
def references_field(self, model_name, name, app_label=None): def references_field(self, model_name, name, app_label):
return ( return (
self.references_model(model_name, app_label) and self.references_model(model_name, app_label) and
( (
@ -609,7 +609,7 @@ class AlterOrderWithRespectTo(ModelOptionOperation):
def database_backwards(self, app_label, schema_editor, from_state, to_state): def database_backwards(self, app_label, schema_editor, from_state, to_state):
self.database_forwards(app_label, schema_editor, from_state, to_state) self.database_forwards(app_label, schema_editor, from_state, to_state)
def references_field(self, model_name, name, app_label=None): def references_field(self, model_name, name, app_label):
return ( return (
self.references_model(model_name, app_label) and self.references_model(model_name, app_label) and
( (

42
tests/migrations/test_operations.py
View File

@ -2917,54 +2917,54 @@ class SwappableOperationTests(OperationTestBase):
class TestCreateModel(SimpleTestCase): class TestCreateModel(SimpleTestCase):
def test_references_model_mixin(self): def test_references_model_mixin(self):
CreateModel('name', [], bases=(Mixin, models.Model)).references_model('other_model') CreateModel('name', [], bases=(Mixin, models.Model)).references_model('other_model', 'migrations')
class FieldOperationTests(SimpleTestCase): class FieldOperationTests(SimpleTestCase):
def test_references_model(self): def test_references_model(self):
operation = FieldOperation('MoDel', 'field', models.ForeignKey('Other', models.CASCADE)) operation = FieldOperation('MoDel', 'field', models.ForeignKey('Other', models.CASCADE))
# Model name match. # Model name match.
self.assertIs(operation.references_model('mOdEl'), True) self.assertIs(operation.references_model('mOdEl', 'migrations'), True)
# Referenced field. # Referenced field.
self.assertIs(operation.references_model('oTher'), True) self.assertIs(operation.references_model('oTher', 'migrations'), True)
# Doesn't reference. # Doesn't reference.
self.assertIs(operation.references_model('Whatever'), False) self.assertIs(operation.references_model('Whatever', 'migrations'), False)
def test_references_field_by_name(self): def test_references_field_by_name(self):
operation = FieldOperation('MoDel', 'field', models.BooleanField(default=False)) operation = FieldOperation('MoDel', 'field', models.BooleanField(default=False))
self.assertIs(operation.references_field('model', 'field'), True) self.assertIs(operation.references_field('model', 'field', 'migrations'), True)
def test_references_field_by_remote_field_model(self): def test_references_field_by_remote_field_model(self):
operation = FieldOperation('Model', 'field', models.ForeignKey('Other', models.CASCADE)) operation = FieldOperation('Model', 'field', models.ForeignKey('Other', models.CASCADE))
self.assertIs(operation.references_field('Other', 'whatever'), True) self.assertIs(operation.references_field('Other', 'whatever', 'migrations'), True)
self.assertIs(operation.references_field('Missing', 'whatever'), False) self.assertIs(operation.references_field('Missing', 'whatever', 'migrations'), False)
def test_references_field_by_from_fields(self): def test_references_field_by_from_fields(self):
operation = FieldOperation( operation = FieldOperation(
'Model', 'field', models.fields.related.ForeignObject('Other', models.CASCADE, ['from'], ['to']) 'Model', 'field', models.fields.related.ForeignObject('Other', models.CASCADE, ['from'], ['to'])
) )
self.assertIs(operation.references_field('Model', 'from'), True) self.assertIs(operation.references_field('Model', 'from', 'migrations'), True)
self.assertIs(operation.references_field('Model', 'to'), False) self.assertIs(operation.references_field('Model', 'to', 'migrations'), False)
self.assertIs(operation.references_field('Other', 'from'), False) self.assertIs(operation.references_field('Other', 'from', 'migrations'), False)
self.assertIs(operation.references_field('Model', 'to'), False) self.assertIs(operation.references_field('Model', 'to', 'migrations'), False)
def test_references_field_by_to_fields(self): def test_references_field_by_to_fields(self):
operation = FieldOperation('Model', 'field', models.ForeignKey('Other', models.CASCADE, to_field='field')) operation = FieldOperation('Model', 'field', models.ForeignKey('Other', models.CASCADE, to_field='field'))
self.assertIs(operation.references_field('Other', 'field'), True) self.assertIs(operation.references_field('Other', 'field', 'migrations'), True)
self.assertIs(operation.references_field('Other', 'whatever'), False) self.assertIs(operation.references_field('Other', 'whatever', 'migrations'), False)
self.assertIs(operation.references_field('Missing', 'whatever'), False) self.assertIs(operation.references_field('Missing', 'whatever', 'migrations'), False)
def test_references_field_by_through(self): def test_references_field_by_through(self):
operation = FieldOperation('Model', 'field', models.ManyToManyField('Other', through='Through')) operation = FieldOperation('Model', 'field', models.ManyToManyField('Other', through='Through'))
self.assertIs(operation.references_field('Other', 'whatever'), True) self.assertIs(operation.references_field('Other', 'whatever', 'migrations'), True)
self.assertIs(operation.references_field('Through', 'whatever'), True) self.assertIs(operation.references_field('Through', 'whatever', 'migrations'), True)
self.assertIs(operation.references_field('Missing', 'whatever'), False) self.assertIs(operation.references_field('Missing', 'whatever', 'migrations'), False)
def test_reference_field_by_through_fields(self): def test_reference_field_by_through_fields(self):
operation = FieldOperation( operation = FieldOperation(
'Model', 'field', models.ManyToManyField('Other', through='Through', through_fields=('first', 'second')) 'Model', 'field', models.ManyToManyField('Other', through='Through', through_fields=('first', 'second'))
) )
self.assertIs(operation.references_field('Other', 'whatever'), True) self.assertIs(operation.references_field('Other', 'whatever', 'migrations'), True)
self.assertIs(operation.references_field('Through', 'whatever'), False) self.assertIs(operation.references_field('Through', 'whatever', 'migrations'), False)
self.assertIs(operation.references_field('Through', 'first'), True) self.assertIs(operation.references_field('Through', 'first', 'migrations'), True)
self.assertIs(operation.references_field('Through', 'second'), True) self.assertIs(operation.references_field('Through', 'second', 'migrations'), True)