1126 lines
54 KiB
Python
1126 lines
54 KiB
Python
from __future__ import unicode_literals
|
|
|
|
import datetime
|
|
import re
|
|
from itertools import chain
|
|
|
|
from django.conf import settings
|
|
from django.db import models
|
|
from django.db.migrations import operations
|
|
from django.db.migrations.migration import Migration
|
|
from django.db.migrations.operations.models import AlterModelOptions
|
|
from django.db.migrations.optimizer import MigrationOptimizer
|
|
from django.db.migrations.questioner import MigrationQuestioner
|
|
from django.utils import six
|
|
|
|
from .topological_sort import stable_topological_sort
|
|
|
|
|
|
class MigrationAutodetector(object):
|
|
"""
|
|
Takes a pair of ProjectStates, and compares them to see what the
|
|
first would need doing to make it match the second (the second
|
|
usually being the project's current state).
|
|
|
|
Note that this naturally operates on entire projects at a time,
|
|
as it's likely that changes interact (for example, you can't
|
|
add a ForeignKey without having a migration to add the table it
|
|
depends on first). A user interface may offer single-app usage
|
|
if it wishes, with the caveat that it may not always be possible.
|
|
"""
|
|
|
|
def __init__(self, from_state, to_state, questioner=None):
|
|
self.from_state = from_state
|
|
self.to_state = to_state
|
|
self.questioner = questioner or MigrationQuestioner()
|
|
|
|
def changes(self, graph, trim_to_apps=None, convert_apps=None, migration_name=None):
|
|
"""
|
|
Main entry point to produce a list of appliable changes.
|
|
Takes a graph to base names on and an optional set of apps
|
|
to try and restrict to (restriction is not guaranteed)
|
|
"""
|
|
changes = self._detect_changes(convert_apps, graph)
|
|
changes = self.arrange_for_graph(changes, graph, migration_name)
|
|
if trim_to_apps:
|
|
changes = self._trim_to_apps(changes, trim_to_apps)
|
|
return changes
|
|
|
|
def deep_deconstruct(self, obj):
|
|
"""
|
|
Recursive deconstruction for a field and its arguments.
|
|
Used for full comparison for rename/alter; sometimes a single-level
|
|
deconstruction will not compare correctly.
|
|
"""
|
|
if not hasattr(obj, 'deconstruct') or isinstance(obj, type):
|
|
return obj
|
|
deconstructed = obj.deconstruct()
|
|
if isinstance(obj, models.Field):
|
|
# we have a field which also returns a name
|
|
deconstructed = deconstructed[1:]
|
|
path, args, kwargs = deconstructed
|
|
return (
|
|
path,
|
|
[self.deep_deconstruct(value) for value in args],
|
|
{
|
|
key: self.deep_deconstruct(value)
|
|
for key, value in kwargs.items()
|
|
},
|
|
)
|
|
|
|
def only_relation_agnostic_fields(self, fields):
|
|
"""
|
|
Return a definition of the fields that ignores field names and
|
|
what related fields actually relate to.
|
|
Used for detecting renames (as, of course, the related fields
|
|
change during renames)
|
|
"""
|
|
fields_def = []
|
|
for name, field in sorted(fields):
|
|
deconstruction = self.deep_deconstruct(field)
|
|
if field.remote_field and field.remote_field.model:
|
|
del deconstruction[2]['to']
|
|
fields_def.append(deconstruction)
|
|
return fields_def
|
|
|
|
def _detect_changes(self, convert_apps=None, graph=None):
|
|
"""
|
|
Returns a dict of migration plans which will achieve the
|
|
change from from_state to to_state. The dict has app labels
|
|
as keys and a list of migrations as values.
|
|
|
|
The resulting migrations aren't specially named, but the names
|
|
do matter for dependencies inside the set.
|
|
|
|
convert_apps is the list of apps to convert to use migrations
|
|
(i.e. to make initial migrations for, in the usual case)
|
|
|
|
graph is an optional argument that, if provided, can help improve
|
|
dependency generation and avoid potential circular dependencies.
|
|
"""
|
|
|
|
# The first phase is generating all the operations for each app
|
|
# and gathering them into a big per-app list.
|
|
# We'll then go through that list later and order it and split
|
|
# into migrations to resolve dependencies caused by M2Ms and FKs.
|
|
self.generated_operations = {}
|
|
|
|
# Prepare some old/new state and model lists, separating
|
|
# proxy models and ignoring unmigrated apps.
|
|
self.old_apps = self.from_state.concrete_apps
|
|
self.new_apps = self.to_state.apps
|
|
self.old_model_keys = []
|
|
self.old_proxy_keys = []
|
|
self.old_unmanaged_keys = []
|
|
self.new_model_keys = []
|
|
self.new_proxy_keys = []
|
|
self.new_unmanaged_keys = []
|
|
for al, mn in sorted(self.from_state.models.keys()):
|
|
model = self.old_apps.get_model(al, mn)
|
|
if not model._meta.managed:
|
|
self.old_unmanaged_keys.append((al, mn))
|
|
elif al not in self.from_state.real_apps:
|
|
if model._meta.proxy:
|
|
self.old_proxy_keys.append((al, mn))
|
|
else:
|
|
self.old_model_keys.append((al, mn))
|
|
|
|
for al, mn in sorted(self.to_state.models.keys()):
|
|
model = self.new_apps.get_model(al, mn)
|
|
if not model._meta.managed:
|
|
self.new_unmanaged_keys.append((al, mn))
|
|
elif (
|
|
al not in self.from_state.real_apps or
|
|
(convert_apps and al in convert_apps)
|
|
):
|
|
if model._meta.proxy:
|
|
self.new_proxy_keys.append((al, mn))
|
|
else:
|
|
self.new_model_keys.append((al, mn))
|
|
|
|
# Renames have to come first
|
|
self.generate_renamed_models()
|
|
|
|
# Prepare field lists, and prepare a list of the fields that used
|
|
# through models in the old state so we can make dependencies
|
|
# from the through model deletion to the field that uses it.
|
|
self.kept_model_keys = set(self.old_model_keys).intersection(self.new_model_keys)
|
|
self.kept_proxy_keys = set(self.old_proxy_keys).intersection(self.new_proxy_keys)
|
|
self.kept_unmanaged_keys = set(self.old_unmanaged_keys).intersection(self.new_unmanaged_keys)
|
|
self.through_users = {}
|
|
self.old_field_keys = set()
|
|
self.new_field_keys = set()
|
|
for app_label, model_name in sorted(self.kept_model_keys):
|
|
old_model_name = self.renamed_models.get((app_label, model_name), model_name)
|
|
old_model_state = self.from_state.models[app_label, old_model_name]
|
|
new_model_state = self.to_state.models[app_label, model_name]
|
|
self.old_field_keys.update((app_label, model_name, x) for x, y in old_model_state.fields)
|
|
self.new_field_keys.update((app_label, model_name, x) for x, y in new_model_state.fields)
|
|
|
|
# Through model map generation
|
|
for app_label, model_name in sorted(self.old_model_keys):
|
|
old_model_name = self.renamed_models.get((app_label, model_name), model_name)
|
|
old_model_state = self.from_state.models[app_label, old_model_name]
|
|
for field_name, field in old_model_state.fields:
|
|
old_field = self.old_apps.get_model(app_label, old_model_name)._meta.get_field(field_name)
|
|
if (hasattr(old_field, "remote_field") and getattr(old_field.remote_field, "through", None)
|
|
and not old_field.remote_field.through._meta.auto_created):
|
|
through_key = (
|
|
old_field.remote_field.through._meta.app_label,
|
|
old_field.remote_field.through._meta.model_name,
|
|
)
|
|
self.through_users[through_key] = (app_label, old_model_name, field_name)
|
|
|
|
# Generate non-rename model operations
|
|
self.generate_deleted_models()
|
|
self.generate_created_models()
|
|
self.generate_deleted_proxies()
|
|
self.generate_created_proxies()
|
|
self.generate_altered_options()
|
|
self.generate_altered_managers()
|
|
|
|
# Generate field operations
|
|
self.generate_renamed_fields()
|
|
self.generate_removed_fields()
|
|
self.generate_added_fields()
|
|
self.generate_altered_fields()
|
|
self.generate_altered_unique_together()
|
|
self.generate_altered_index_together()
|
|
self.generate_altered_db_table()
|
|
self.generate_altered_order_with_respect_to()
|
|
|
|
# Now, reordering to make things possible. The order we have already
|
|
# isn't bad, but we need to pull a few things around so FKs work nicely
|
|
# inside the same app
|
|
for app_label, ops in sorted(self.generated_operations.items()):
|
|
|
|
# construct a dependency graph for intra-app dependencies
|
|
dependency_graph = {op: set() for op in ops}
|
|
for op in ops:
|
|
for dep in op._auto_deps:
|
|
if dep[0] == app_label:
|
|
for op2 in ops:
|
|
if self.check_dependency(op2, dep):
|
|
dependency_graph[op].add(op2)
|
|
|
|
# we use a stable sort for deterministic tests & general behavior
|
|
self.generated_operations[app_label] = stable_topological_sort(ops, dependency_graph)
|
|
|
|
# Now, we need to chop the lists of operations up into migrations with
|
|
# dependencies on each other.
|
|
# We do this by stepping up an app's list of operations until we
|
|
# find one that has an outgoing dependency that isn't in another app's
|
|
# migration yet (hasn't been chopped off its list). We then chop off the
|
|
# operations before it into a migration and move onto the next app.
|
|
# If we loop back around without doing anything, there's a circular
|
|
# dependency (which _should_ be impossible as the operations are all
|
|
# split at this point so they can't depend and be depended on)
|
|
|
|
self.migrations = {}
|
|
num_ops = sum(len(x) for x in self.generated_operations.values())
|
|
chop_mode = False
|
|
while num_ops:
|
|
# On every iteration, we step through all the apps and see if there
|
|
# is a completed set of operations.
|
|
# If we find that a subset of the operations are complete we can
|
|
# try to chop it off from the rest and continue, but we only
|
|
# do this if we've already been through the list once before
|
|
# without any chopping and nothing has changed.
|
|
for app_label in sorted(self.generated_operations.keys()):
|
|
chopped = []
|
|
dependencies = set()
|
|
for operation in list(self.generated_operations[app_label]):
|
|
deps_satisfied = True
|
|
operation_dependencies = set()
|
|
for dep in operation._auto_deps:
|
|
is_swappable_dep = False
|
|
if dep[0] == "__setting__":
|
|
# We need to temporarily resolve the swappable dependency to prevent
|
|
# circular references. While keeping the dependency checks on the
|
|
# resolved model we still add the swappable dependencies.
|
|
# See #23322
|
|
resolved_app_label, resolved_object_name = getattr(settings, dep[1]).split('.')
|
|
original_dep = dep
|
|
dep = (resolved_app_label, resolved_object_name.lower(), dep[2], dep[3])
|
|
is_swappable_dep = True
|
|
if dep[0] != app_label and dep[0] != "__setting__":
|
|
# External app dependency. See if it's not yet
|
|
# satisfied.
|
|
for other_operation in self.generated_operations.get(dep[0], []):
|
|
if self.check_dependency(other_operation, dep):
|
|
deps_satisfied = False
|
|
break
|
|
if not deps_satisfied:
|
|
break
|
|
else:
|
|
if is_swappable_dep:
|
|
operation_dependencies.add((original_dep[0], original_dep[1]))
|
|
elif dep[0] in self.migrations:
|
|
operation_dependencies.add((dep[0], self.migrations[dep[0]][-1].name))
|
|
else:
|
|
# If we can't find the other app, we add a first/last dependency,
|
|
# but only if we've already been through once and checked everything
|
|
if chop_mode:
|
|
# If the app already exists, we add a dependency on the last migration,
|
|
# as we don't know which migration contains the target field.
|
|
# If it's not yet migrated or has no migrations, we use __first__
|
|
if graph and graph.leaf_nodes(dep[0]):
|
|
operation_dependencies.add(graph.leaf_nodes(dep[0])[0])
|
|
else:
|
|
operation_dependencies.add((dep[0], "__first__"))
|
|
else:
|
|
deps_satisfied = False
|
|
if deps_satisfied:
|
|
chopped.append(operation)
|
|
dependencies.update(operation_dependencies)
|
|
self.generated_operations[app_label] = self.generated_operations[app_label][1:]
|
|
else:
|
|
break
|
|
# Make a migration! Well, only if there's stuff to put in it
|
|
if dependencies or chopped:
|
|
if not self.generated_operations[app_label] or chop_mode:
|
|
subclass = type(str("Migration"), (Migration,), {"operations": [], "dependencies": []})
|
|
instance = subclass("auto_%i" % (len(self.migrations.get(app_label, [])) + 1), app_label)
|
|
instance.dependencies = list(dependencies)
|
|
instance.operations = chopped
|
|
self.migrations.setdefault(app_label, []).append(instance)
|
|
chop_mode = False
|
|
else:
|
|
self.generated_operations[app_label] = chopped + self.generated_operations[app_label]
|
|
new_num_ops = sum(len(x) for x in self.generated_operations.values())
|
|
if new_num_ops == num_ops:
|
|
if not chop_mode:
|
|
chop_mode = True
|
|
else:
|
|
raise ValueError("Cannot resolve operation dependencies: %r" % self.generated_operations)
|
|
num_ops = new_num_ops
|
|
|
|
# OK, add in internal dependencies among the migrations
|
|
for app_label, migrations in self.migrations.items():
|
|
for m1, m2 in zip(migrations, migrations[1:]):
|
|
m2.dependencies.append((app_label, m1.name))
|
|
|
|
# De-dupe dependencies
|
|
for app_label, migrations in self.migrations.items():
|
|
for migration in migrations:
|
|
migration.dependencies = list(set(migration.dependencies))
|
|
|
|
# Optimize migrations
|
|
for app_label, migrations in self.migrations.items():
|
|
for migration in migrations:
|
|
migration.operations = MigrationOptimizer().optimize(migration.operations, app_label=app_label)
|
|
|
|
return self.migrations
|
|
|
|
def check_dependency(self, operation, dependency):
|
|
"""
|
|
Returns ``True`` if the given operation depends on the given dependency,
|
|
``False`` otherwise.
|
|
"""
|
|
# Created model
|
|
if dependency[2] is None and dependency[3] is True:
|
|
return (
|
|
isinstance(operation, operations.CreateModel) and
|
|
operation.name_lower == dependency[1].lower()
|
|
)
|
|
# Created field
|
|
elif dependency[2] is not None and dependency[3] is True:
|
|
return (
|
|
(
|
|
isinstance(operation, operations.CreateModel) and
|
|
operation.name_lower == dependency[1].lower() and
|
|
any(dependency[2] == x for x, y in operation.fields)
|
|
) or
|
|
(
|
|
isinstance(operation, operations.AddField) and
|
|
operation.model_name_lower == dependency[1].lower() and
|
|
operation.name_lower == dependency[2].lower()
|
|
)
|
|
)
|
|
# Removed field
|
|
elif dependency[2] is not None and dependency[3] is False:
|
|
return (
|
|
isinstance(operation, operations.RemoveField) and
|
|
operation.model_name_lower == dependency[1].lower() and
|
|
operation.name_lower == dependency[2].lower()
|
|
)
|
|
# Removed model
|
|
elif dependency[2] is None and dependency[3] is False:
|
|
return (
|
|
isinstance(operation, operations.DeleteModel) and
|
|
operation.name_lower == dependency[1].lower()
|
|
)
|
|
# Field being altered
|
|
elif dependency[2] is not None and dependency[3] == "alter":
|
|
return (
|
|
isinstance(operation, operations.AlterField) and
|
|
operation.model_name_lower == dependency[1].lower() and
|
|
operation.name_lower == dependency[2].lower()
|
|
)
|
|
# order_with_respect_to being unset for a field
|
|
elif dependency[2] is not None and dependency[3] == "order_wrt_unset":
|
|
return (
|
|
isinstance(operation, operations.AlterOrderWithRespectTo) and
|
|
operation.name_lower == dependency[1].lower() and
|
|
(operation.order_with_respect_to or "").lower() != dependency[2].lower()
|
|
)
|
|
# Field is removed and part of an index/unique_together
|
|
elif dependency[2] is not None and dependency[3] == "foo_together_change":
|
|
return (
|
|
isinstance(operation, (operations.AlterUniqueTogether,
|
|
operations.AlterIndexTogether)) and
|
|
operation.name_lower == dependency[1].lower()
|
|
)
|
|
# Unknown dependency. Raise an error.
|
|
else:
|
|
raise ValueError("Can't handle dependency %r" % (dependency, ))
|
|
|
|
def add_operation(self, app_label, operation, dependencies=None, beginning=False):
|
|
# Dependencies are (app_label, model_name, field_name, create/delete as True/False)
|
|
operation._auto_deps = dependencies or []
|
|
if beginning:
|
|
self.generated_operations.setdefault(app_label, []).insert(0, operation)
|
|
else:
|
|
self.generated_operations.setdefault(app_label, []).append(operation)
|
|
|
|
def swappable_first_key(self, item):
|
|
"""
|
|
Sorting key function that places potential swappable models first in
|
|
lists of created models (only real way to solve #22783)
|
|
"""
|
|
try:
|
|
model = self.new_apps.get_model(item[0], item[1])
|
|
base_names = [base.__name__ for base in model.__bases__]
|
|
string_version = "%s.%s" % (item[0], item[1])
|
|
if (
|
|
model._meta.swappable or
|
|
"AbstractUser" in base_names or
|
|
"AbstractBaseUser" in base_names or
|
|
settings.AUTH_USER_MODEL.lower() == string_version.lower()
|
|
):
|
|
return ("___" + item[0], "___" + item[1])
|
|
except LookupError:
|
|
pass
|
|
return item
|
|
|
|
def generate_renamed_models(self):
|
|
"""
|
|
Finds any renamed models, and generates the operations for them,
|
|
and removes the old entry from the model lists.
|
|
Must be run before other model-level generation.
|
|
"""
|
|
self.renamed_models = {}
|
|
self.renamed_models_rel = {}
|
|
added_models = set(self.new_model_keys) - set(self.old_model_keys)
|
|
for app_label, model_name in sorted(added_models):
|
|
model_state = self.to_state.models[app_label, model_name]
|
|
model_fields_def = self.only_relation_agnostic_fields(model_state.fields)
|
|
|
|
removed_models = set(self.old_model_keys) - set(self.new_model_keys)
|
|
for rem_app_label, rem_model_name in removed_models:
|
|
if rem_app_label == app_label:
|
|
rem_model_state = self.from_state.models[rem_app_label, rem_model_name]
|
|
rem_model_fields_def = self.only_relation_agnostic_fields(rem_model_state.fields)
|
|
if model_fields_def == rem_model_fields_def:
|
|
if self.questioner.ask_rename_model(rem_model_state, model_state):
|
|
self.add_operation(
|
|
app_label,
|
|
operations.RenameModel(
|
|
old_name=rem_model_state.name,
|
|
new_name=model_state.name,
|
|
)
|
|
)
|
|
self.renamed_models[app_label, model_name] = rem_model_name
|
|
self.renamed_models_rel['%s.%s' % (rem_model_state.app_label, rem_model_state.name)] = '%s.%s' % (model_state.app_label, model_state.name)
|
|
self.old_model_keys.remove((rem_app_label, rem_model_name))
|
|
self.old_model_keys.append((app_label, model_name))
|
|
break
|
|
|
|
def generate_created_models(self):
|
|
"""
|
|
Find all new models (both managed and unmanaged) and make create
|
|
operations for them as well as separate operations to create any
|
|
foreign key or M2M relationships (we'll optimize these back in later
|
|
if we can).
|
|
|
|
We also defer any model options that refer to collections of fields
|
|
that might be deferred (e.g. unique_together, index_together).
|
|
"""
|
|
old_keys = set(self.old_model_keys).union(self.old_unmanaged_keys)
|
|
added_models = set(self.new_model_keys) - old_keys
|
|
added_unmanaged_models = set(self.new_unmanaged_keys) - old_keys
|
|
all_added_models = chain(
|
|
sorted(added_models, key=self.swappable_first_key, reverse=True),
|
|
sorted(added_unmanaged_models, key=self.swappable_first_key, reverse=True)
|
|
)
|
|
for app_label, model_name in all_added_models:
|
|
model_state = self.to_state.models[app_label, model_name]
|
|
model_opts = self.new_apps.get_model(app_label, model_name)._meta
|
|
# Gather related fields
|
|
related_fields = {}
|
|
primary_key_rel = None
|
|
for field in model_opts.local_fields:
|
|
if field.remote_field:
|
|
if field.remote_field.model:
|
|
if field.primary_key:
|
|
primary_key_rel = field.remote_field.model
|
|
elif not field.remote_field.parent_link:
|
|
related_fields[field.name] = field
|
|
# through will be none on M2Ms on swapped-out models;
|
|
# we can treat lack of through as auto_created=True, though.
|
|
if getattr(field.remote_field, "through", None) and not field.remote_field.through._meta.auto_created:
|
|
related_fields[field.name] = field
|
|
for field in model_opts.local_many_to_many:
|
|
if field.remote_field.model:
|
|
related_fields[field.name] = field
|
|
if getattr(field.remote_field, "through", None) and not field.remote_field.through._meta.auto_created:
|
|
related_fields[field.name] = field
|
|
# Are there unique/index_together to defer?
|
|
unique_together = model_state.options.pop('unique_together', None)
|
|
index_together = model_state.options.pop('index_together', None)
|
|
order_with_respect_to = model_state.options.pop('order_with_respect_to', None)
|
|
# Depend on the deletion of any possible proxy version of us
|
|
dependencies = [
|
|
(app_label, model_name, None, False),
|
|
]
|
|
# Depend on all bases
|
|
for base in model_state.bases:
|
|
if isinstance(base, six.string_types) and "." in base:
|
|
base_app_label, base_name = base.split(".", 1)
|
|
dependencies.append((base_app_label, base_name, None, True))
|
|
# Depend on the other end of the primary key if it's a relation
|
|
if primary_key_rel:
|
|
dependencies.append((
|
|
primary_key_rel._meta.app_label,
|
|
primary_key_rel._meta.object_name,
|
|
None,
|
|
True
|
|
))
|
|
# Generate creation operation
|
|
self.add_operation(
|
|
app_label,
|
|
operations.CreateModel(
|
|
name=model_state.name,
|
|
fields=[d for d in model_state.fields if d[0] not in related_fields],
|
|
options=model_state.options,
|
|
bases=model_state.bases,
|
|
managers=model_state.managers,
|
|
),
|
|
dependencies=dependencies,
|
|
beginning=True,
|
|
)
|
|
|
|
# Don't add operations which modify the database for unmanaged models
|
|
if not model_opts.managed:
|
|
continue
|
|
|
|
# Generate operations for each related field
|
|
for name, field in sorted(related_fields.items()):
|
|
# Account for FKs to swappable models
|
|
swappable_setting = getattr(field, 'swappable_setting', None)
|
|
if swappable_setting is not None:
|
|
dep_app_label = "__setting__"
|
|
dep_object_name = swappable_setting
|
|
else:
|
|
dep_app_label = field.remote_field.model._meta.app_label
|
|
dep_object_name = field.remote_field.model._meta.object_name
|
|
dependencies = [(dep_app_label, dep_object_name, None, True)]
|
|
if getattr(field.remote_field, "through", None) and not field.remote_field.through._meta.auto_created:
|
|
dependencies.append((
|
|
field.remote_field.through._meta.app_label,
|
|
field.remote_field.through._meta.object_name,
|
|
None,
|
|
True
|
|
))
|
|
# Depend on our own model being created
|
|
dependencies.append((app_label, model_name, None, True))
|
|
# Make operation
|
|
self.add_operation(
|
|
app_label,
|
|
operations.AddField(
|
|
model_name=model_name,
|
|
name=name,
|
|
field=field,
|
|
),
|
|
dependencies=list(set(dependencies)),
|
|
)
|
|
# Generate other opns
|
|
related_dependencies = [
|
|
(app_label, model_name, name, True)
|
|
for name, field in sorted(related_fields.items())
|
|
]
|
|
related_dependencies.append((app_label, model_name, None, True))
|
|
if unique_together:
|
|
self.add_operation(
|
|
app_label,
|
|
operations.AlterUniqueTogether(
|
|
name=model_name,
|
|
unique_together=unique_together,
|
|
),
|
|
dependencies=related_dependencies
|
|
)
|
|
if index_together:
|
|
self.add_operation(
|
|
app_label,
|
|
operations.AlterIndexTogether(
|
|
name=model_name,
|
|
index_together=index_together,
|
|
),
|
|
dependencies=related_dependencies
|
|
)
|
|
if order_with_respect_to:
|
|
self.add_operation(
|
|
app_label,
|
|
operations.AlterOrderWithRespectTo(
|
|
name=model_name,
|
|
order_with_respect_to=order_with_respect_to,
|
|
),
|
|
dependencies=[
|
|
(app_label, model_name, order_with_respect_to, True),
|
|
(app_label, model_name, None, True),
|
|
]
|
|
)
|
|
|
|
def generate_created_proxies(self):
|
|
"""
|
|
Makes CreateModel statements for proxy models.
|
|
We use the same statements as that way there's less code duplication,
|
|
but of course for proxy models we can skip all that pointless field
|
|
stuff and just chuck out an operation.
|
|
"""
|
|
added = set(self.new_proxy_keys) - set(self.old_proxy_keys)
|
|
for app_label, model_name in sorted(added):
|
|
model_state = self.to_state.models[app_label, model_name]
|
|
assert model_state.options.get("proxy", False)
|
|
# Depend on the deletion of any possible non-proxy version of us
|
|
dependencies = [
|
|
(app_label, model_name, None, False),
|
|
]
|
|
# Depend on all bases
|
|
for base in model_state.bases:
|
|
if isinstance(base, six.string_types) and "." in base:
|
|
base_app_label, base_name = base.split(".", 1)
|
|
dependencies.append((base_app_label, base_name, None, True))
|
|
# Generate creation operation
|
|
self.add_operation(
|
|
app_label,
|
|
operations.CreateModel(
|
|
name=model_state.name,
|
|
fields=[],
|
|
options=model_state.options,
|
|
bases=model_state.bases,
|
|
managers=model_state.managers,
|
|
),
|
|
# Depend on the deletion of any possible non-proxy version of us
|
|
dependencies=dependencies,
|
|
)
|
|
|
|
def generate_deleted_models(self):
|
|
"""
|
|
Find all deleted models (managed and unmanaged) and make delete
|
|
operations for them as well as separate operations to delete any
|
|
foreign key or M2M relationships (we'll optimize these back in later
|
|
if we can).
|
|
|
|
We also bring forward removal of any model options that refer to
|
|
collections of fields - the inverse of generate_created_models().
|
|
"""
|
|
new_keys = set(self.new_model_keys).union(self.new_unmanaged_keys)
|
|
deleted_models = set(self.old_model_keys) - new_keys
|
|
deleted_unmanaged_models = set(self.old_unmanaged_keys) - new_keys
|
|
all_deleted_models = chain(sorted(deleted_models), sorted(deleted_unmanaged_models))
|
|
for app_label, model_name in all_deleted_models:
|
|
model_state = self.from_state.models[app_label, model_name]
|
|
model = self.old_apps.get_model(app_label, model_name)
|
|
if not model._meta.managed:
|
|
# Skip here, no need to handle fields for unmanaged models
|
|
continue
|
|
|
|
# Gather related fields
|
|
related_fields = {}
|
|
for field in model._meta.local_fields:
|
|
if field.remote_field:
|
|
if field.remote_field.model:
|
|
related_fields[field.name] = field
|
|
# through will be none on M2Ms on swapped-out models;
|
|
# we can treat lack of through as auto_created=True, though.
|
|
if getattr(field.remote_field, "through", None) and not field.remote_field.through._meta.auto_created:
|
|
related_fields[field.name] = field
|
|
for field in model._meta.local_many_to_many:
|
|
if field.remote_field.model:
|
|
related_fields[field.name] = field
|
|
if getattr(field.remote_field, "through", None) and not field.remote_field.through._meta.auto_created:
|
|
related_fields[field.name] = field
|
|
# Generate option removal first
|
|
unique_together = model_state.options.pop('unique_together', None)
|
|
index_together = model_state.options.pop('index_together', None)
|
|
if unique_together:
|
|
self.add_operation(
|
|
app_label,
|
|
operations.AlterUniqueTogether(
|
|
name=model_name,
|
|
unique_together=None,
|
|
)
|
|
)
|
|
if index_together:
|
|
self.add_operation(
|
|
app_label,
|
|
operations.AlterIndexTogether(
|
|
name=model_name,
|
|
index_together=None,
|
|
)
|
|
)
|
|
# Then remove each related field
|
|
for name, field in sorted(related_fields.items()):
|
|
self.add_operation(
|
|
app_label,
|
|
operations.RemoveField(
|
|
model_name=model_name,
|
|
name=name,
|
|
)
|
|
)
|
|
# Finally, remove the model.
|
|
# This depends on both the removal/alteration of all incoming fields
|
|
# and the removal of all its own related fields, and if it's
|
|
# a through model the field that references it.
|
|
dependencies = []
|
|
for related_object in model._meta.related_objects:
|
|
related_object_app_label = related_object.related_model._meta.app_label
|
|
object_name = related_object.related_model._meta.object_name
|
|
field_name = related_object.field.name
|
|
dependencies.append((related_object_app_label, object_name, field_name, False))
|
|
if not related_object.many_to_many:
|
|
dependencies.append((related_object_app_label, object_name, field_name, "alter"))
|
|
|
|
for name, field in sorted(related_fields.items()):
|
|
dependencies.append((app_label, model_name, name, False))
|
|
# We're referenced in another field's through=
|
|
through_user = self.through_users.get((app_label, model_state.name_lower), None)
|
|
if through_user:
|
|
dependencies.append((through_user[0], through_user[1], through_user[2], False))
|
|
# Finally, make the operation, deduping any dependencies
|
|
self.add_operation(
|
|
app_label,
|
|
operations.DeleteModel(
|
|
name=model_state.name,
|
|
),
|
|
dependencies=list(set(dependencies)),
|
|
)
|
|
|
|
def generate_deleted_proxies(self):
|
|
"""
|
|
Makes DeleteModel statements for proxy models.
|
|
"""
|
|
deleted = set(self.old_proxy_keys) - set(self.new_proxy_keys)
|
|
for app_label, model_name in sorted(deleted):
|
|
model_state = self.from_state.models[app_label, model_name]
|
|
assert model_state.options.get("proxy", False)
|
|
self.add_operation(
|
|
app_label,
|
|
operations.DeleteModel(
|
|
name=model_state.name,
|
|
),
|
|
)
|
|
|
|
def generate_renamed_fields(self):
|
|
"""
|
|
Works out renamed fields
|
|
"""
|
|
self.renamed_fields = {}
|
|
for app_label, model_name, field_name in sorted(self.new_field_keys - self.old_field_keys):
|
|
old_model_name = self.renamed_models.get((app_label, model_name), model_name)
|
|
old_model_state = self.from_state.models[app_label, old_model_name]
|
|
field = self.new_apps.get_model(app_label, model_name)._meta.get_field(field_name)
|
|
# Scan to see if this is actually a rename!
|
|
field_dec = self.deep_deconstruct(field)
|
|
for rem_app_label, rem_model_name, rem_field_name in sorted(self.old_field_keys - self.new_field_keys):
|
|
if rem_app_label == app_label and rem_model_name == model_name:
|
|
old_field_dec = self.deep_deconstruct(old_model_state.get_field_by_name(rem_field_name))
|
|
if field.remote_field and field.remote_field.model and 'to' in old_field_dec[2]:
|
|
old_rel_to = old_field_dec[2]['to']
|
|
if old_rel_to in self.renamed_models_rel:
|
|
old_field_dec[2]['to'] = self.renamed_models_rel[old_rel_to]
|
|
if old_field_dec == field_dec:
|
|
if self.questioner.ask_rename(model_name, rem_field_name, field_name, field):
|
|
self.add_operation(
|
|
app_label,
|
|
operations.RenameField(
|
|
model_name=model_name,
|
|
old_name=rem_field_name,
|
|
new_name=field_name,
|
|
)
|
|
)
|
|
self.old_field_keys.remove((rem_app_label, rem_model_name, rem_field_name))
|
|
self.old_field_keys.add((app_label, model_name, field_name))
|
|
self.renamed_fields[app_label, model_name, field_name] = rem_field_name
|
|
break
|
|
|
|
def generate_added_fields(self):
|
|
"""
|
|
Fields that have been added
|
|
"""
|
|
for app_label, model_name, field_name in sorted(self.new_field_keys - self.old_field_keys):
|
|
self._generate_added_field(app_label, model_name, field_name)
|
|
|
|
def _generate_added_field(self, app_label, model_name, field_name):
|
|
field = self.new_apps.get_model(app_label, model_name)._meta.get_field(field_name)
|
|
# Fields that are foreignkeys/m2ms depend on stuff
|
|
dependencies = []
|
|
if field.remote_field and field.remote_field.model:
|
|
# Account for FKs to swappable models
|
|
swappable_setting = getattr(field, 'swappable_setting', None)
|
|
if swappable_setting is not None:
|
|
dep_app_label = "__setting__"
|
|
dep_object_name = swappable_setting
|
|
else:
|
|
dep_app_label = field.remote_field.model._meta.app_label
|
|
dep_object_name = field.remote_field.model._meta.object_name
|
|
dependencies = [(dep_app_label, dep_object_name, None, True)]
|
|
if getattr(field.remote_field, "through", None) and not field.remote_field.through._meta.auto_created:
|
|
dependencies.append((
|
|
field.remote_field.through._meta.app_label,
|
|
field.remote_field.through._meta.object_name,
|
|
None,
|
|
True,
|
|
))
|
|
# You can't just add NOT NULL fields with no default or fields
|
|
# which don't allow empty strings as default.
|
|
preserve_default = True
|
|
if (not field.null and not field.has_default() and
|
|
not isinstance(field, models.ManyToManyField) and
|
|
not (field.blank and field.empty_strings_allowed)):
|
|
field = field.clone()
|
|
field.default = self.questioner.ask_not_null_addition(field_name, model_name)
|
|
preserve_default = False
|
|
self.add_operation(
|
|
app_label,
|
|
operations.AddField(
|
|
model_name=model_name,
|
|
name=field_name,
|
|
field=field,
|
|
preserve_default=preserve_default,
|
|
),
|
|
dependencies=dependencies,
|
|
)
|
|
|
|
def generate_removed_fields(self):
|
|
"""
|
|
Fields that have been removed.
|
|
"""
|
|
for app_label, model_name, field_name in sorted(self.old_field_keys - self.new_field_keys):
|
|
self._generate_removed_field(app_label, model_name, field_name)
|
|
|
|
def _generate_removed_field(self, app_label, model_name, field_name):
|
|
self.add_operation(
|
|
app_label,
|
|
operations.RemoveField(
|
|
model_name=model_name,
|
|
name=field_name,
|
|
),
|
|
# We might need to depend on the removal of an
|
|
# order_with_respect_to or index/unique_together operation;
|
|
# this is safely ignored if there isn't one
|
|
dependencies=[
|
|
(app_label, model_name, field_name, "order_wrt_unset"),
|
|
(app_label, model_name, field_name, "foo_together_change"),
|
|
],
|
|
)
|
|
|
|
def generate_altered_fields(self):
|
|
"""
|
|
Fields that have been altered.
|
|
"""
|
|
for app_label, model_name, field_name in sorted(self.old_field_keys.intersection(self.new_field_keys)):
|
|
# Did the field change?
|
|
old_model_name = self.renamed_models.get((app_label, model_name), model_name)
|
|
old_field_name = self.renamed_fields.get((app_label, model_name, field_name), field_name)
|
|
old_field = self.old_apps.get_model(app_label, old_model_name)._meta.get_field(old_field_name)
|
|
new_field = self.new_apps.get_model(app_label, model_name)._meta.get_field(field_name)
|
|
# Implement any model renames on relations; these are handled by RenameModel
|
|
# so we need to exclude them from the comparison
|
|
if hasattr(new_field, "remote_field") and getattr(new_field.remote_field, "model", None):
|
|
rename_key = (
|
|
new_field.remote_field.model._meta.app_label,
|
|
new_field.remote_field.model._meta.model_name,
|
|
)
|
|
if rename_key in self.renamed_models:
|
|
new_field.remote_field.model = old_field.remote_field.model
|
|
old_field_dec = self.deep_deconstruct(old_field)
|
|
new_field_dec = self.deep_deconstruct(new_field)
|
|
if old_field_dec != new_field_dec:
|
|
both_m2m = (
|
|
isinstance(old_field, models.ManyToManyField) and
|
|
isinstance(new_field, models.ManyToManyField)
|
|
)
|
|
neither_m2m = (
|
|
not isinstance(old_field, models.ManyToManyField) and
|
|
not isinstance(new_field, models.ManyToManyField)
|
|
)
|
|
if both_m2m or neither_m2m:
|
|
# Either both fields are m2m or neither is
|
|
preserve_default = True
|
|
if (old_field.null and not new_field.null and not new_field.has_default() and
|
|
not isinstance(new_field, models.ManyToManyField)):
|
|
field = new_field.clone()
|
|
new_default = self.questioner.ask_not_null_alteration(field_name, model_name)
|
|
if new_default is not models.NOT_PROVIDED:
|
|
field.default = new_default
|
|
preserve_default = False
|
|
else:
|
|
field = new_field
|
|
self.add_operation(
|
|
app_label,
|
|
operations.AlterField(
|
|
model_name=model_name,
|
|
name=field_name,
|
|
field=field,
|
|
preserve_default=preserve_default,
|
|
)
|
|
)
|
|
else:
|
|
# We cannot alter between m2m and concrete fields
|
|
self._generate_removed_field(app_label, model_name, field_name)
|
|
self._generate_added_field(app_label, model_name, field_name)
|
|
|
|
def _generate_altered_foo_together(self, operation):
|
|
option_name = operation.option_name
|
|
for app_label, model_name in sorted(self.kept_model_keys):
|
|
old_model_name = self.renamed_models.get((app_label, model_name), model_name)
|
|
old_model_state = self.from_state.models[app_label, old_model_name]
|
|
new_model_state = self.to_state.models[app_label, model_name]
|
|
|
|
# We run the old version through the field renames to account for those
|
|
old_value = old_model_state.options.get(option_name) or set()
|
|
if old_value:
|
|
old_value = {
|
|
tuple(
|
|
self.renamed_fields.get((app_label, model_name, n), n)
|
|
for n in unique
|
|
)
|
|
for unique in old_value
|
|
}
|
|
|
|
new_value = new_model_state.options.get(option_name) or set()
|
|
if new_value:
|
|
new_value = set(new_value)
|
|
|
|
if old_value != new_value:
|
|
self.add_operation(
|
|
app_label,
|
|
operation(
|
|
name=model_name,
|
|
**{option_name: new_value}
|
|
)
|
|
)
|
|
|
|
def generate_altered_unique_together(self):
|
|
self._generate_altered_foo_together(operations.AlterUniqueTogether)
|
|
|
|
def generate_altered_index_together(self):
|
|
self._generate_altered_foo_together(operations.AlterIndexTogether)
|
|
|
|
def generate_altered_db_table(self):
|
|
models_to_check = self.kept_model_keys.union(self.kept_proxy_keys).union(self.kept_unmanaged_keys)
|
|
for app_label, model_name in sorted(models_to_check):
|
|
old_model_name = self.renamed_models.get((app_label, model_name), model_name)
|
|
old_model_state = self.from_state.models[app_label, old_model_name]
|
|
new_model_state = self.to_state.models[app_label, model_name]
|
|
old_db_table_name = old_model_state.options.get('db_table')
|
|
new_db_table_name = new_model_state.options.get('db_table')
|
|
if old_db_table_name != new_db_table_name:
|
|
self.add_operation(
|
|
app_label,
|
|
operations.AlterModelTable(
|
|
name=model_name,
|
|
table=new_db_table_name,
|
|
)
|
|
)
|
|
|
|
def generate_altered_options(self):
|
|
"""
|
|
Works out if any non-schema-affecting options have changed and
|
|
makes an operation to represent them in state changes (in case Python
|
|
code in migrations needs them)
|
|
"""
|
|
models_to_check = self.kept_model_keys.union(
|
|
self.kept_proxy_keys
|
|
).union(
|
|
self.kept_unmanaged_keys
|
|
).union(
|
|
# unmanaged converted to managed
|
|
set(self.old_unmanaged_keys).intersection(self.new_model_keys)
|
|
).union(
|
|
# managed converted to unmanaged
|
|
set(self.old_model_keys).intersection(self.new_unmanaged_keys)
|
|
)
|
|
|
|
for app_label, model_name in sorted(models_to_check):
|
|
old_model_name = self.renamed_models.get((app_label, model_name), model_name)
|
|
old_model_state = self.from_state.models[app_label, old_model_name]
|
|
new_model_state = self.to_state.models[app_label, model_name]
|
|
old_options = dict(
|
|
option for option in old_model_state.options.items()
|
|
if option[0] in AlterModelOptions.ALTER_OPTION_KEYS
|
|
)
|
|
new_options = dict(
|
|
option for option in new_model_state.options.items()
|
|
if option[0] in AlterModelOptions.ALTER_OPTION_KEYS
|
|
)
|
|
if old_options != new_options:
|
|
self.add_operation(
|
|
app_label,
|
|
operations.AlterModelOptions(
|
|
name=model_name,
|
|
options=new_options,
|
|
)
|
|
)
|
|
|
|
def generate_altered_order_with_respect_to(self):
|
|
for app_label, model_name in sorted(self.kept_model_keys):
|
|
old_model_name = self.renamed_models.get((app_label, model_name), model_name)
|
|
old_model_state = self.from_state.models[app_label, old_model_name]
|
|
new_model_state = self.to_state.models[app_label, model_name]
|
|
if (old_model_state.options.get("order_with_respect_to", None) !=
|
|
new_model_state.options.get("order_with_respect_to", None)):
|
|
# Make sure it comes second if we're adding
|
|
# (removal dependency is part of RemoveField)
|
|
dependencies = []
|
|
if new_model_state.options.get("order_with_respect_to", None):
|
|
dependencies.append((
|
|
app_label,
|
|
model_name,
|
|
new_model_state.options["order_with_respect_to"],
|
|
True,
|
|
))
|
|
# Actually generate the operation
|
|
self.add_operation(
|
|
app_label,
|
|
operations.AlterOrderWithRespectTo(
|
|
name=model_name,
|
|
order_with_respect_to=new_model_state.options.get('order_with_respect_to', None),
|
|
),
|
|
dependencies=dependencies,
|
|
)
|
|
|
|
def generate_altered_managers(self):
|
|
for app_label, model_name in sorted(self.kept_model_keys):
|
|
old_model_name = self.renamed_models.get((app_label, model_name), model_name)
|
|
old_model_state = self.from_state.models[app_label, old_model_name]
|
|
new_model_state = self.to_state.models[app_label, model_name]
|
|
if old_model_state.managers != new_model_state.managers:
|
|
self.add_operation(
|
|
app_label,
|
|
operations.AlterModelManagers(
|
|
name=model_name,
|
|
managers=new_model_state.managers,
|
|
)
|
|
)
|
|
|
|
def arrange_for_graph(self, changes, graph, migration_name=None):
|
|
"""
|
|
Takes in a result from changes() and a MigrationGraph,
|
|
and fixes the names and dependencies of the changes so they
|
|
extend the graph from the leaf nodes for each app.
|
|
"""
|
|
leaves = graph.leaf_nodes()
|
|
name_map = {}
|
|
for app_label, migrations in list(changes.items()):
|
|
if not migrations:
|
|
continue
|
|
# Find the app label's current leaf node
|
|
app_leaf = None
|
|
for leaf in leaves:
|
|
if leaf[0] == app_label:
|
|
app_leaf = leaf
|
|
break
|
|
# Do they want an initial migration for this app?
|
|
if app_leaf is None and not self.questioner.ask_initial(app_label):
|
|
# They don't.
|
|
for migration in migrations:
|
|
name_map[(app_label, migration.name)] = (app_label, "__first__")
|
|
del changes[app_label]
|
|
continue
|
|
# Work out the next number in the sequence
|
|
if app_leaf is None:
|
|
next_number = 1
|
|
else:
|
|
next_number = (self.parse_number(app_leaf[1]) or 0) + 1
|
|
# Name each migration
|
|
for i, migration in enumerate(migrations):
|
|
if i == 0 and app_leaf:
|
|
migration.dependencies.append(app_leaf)
|
|
if i == 0 and not app_leaf:
|
|
new_name = "0001_%s" % migration_name if migration_name else "0001_initial"
|
|
else:
|
|
new_name = "%04i_%s" % (
|
|
next_number,
|
|
migration_name or self.suggest_name(migration.operations)[:100],
|
|
)
|
|
name_map[(app_label, migration.name)] = (app_label, new_name)
|
|
next_number += 1
|
|
migration.name = new_name
|
|
# Now fix dependencies
|
|
for app_label, migrations in changes.items():
|
|
for migration in migrations:
|
|
migration.dependencies = [name_map.get(d, d) for d in migration.dependencies]
|
|
return changes
|
|
|
|
def _trim_to_apps(self, changes, app_labels):
|
|
"""
|
|
Takes changes from arrange_for_graph and set of app labels and
|
|
returns a modified set of changes which trims out as many migrations
|
|
that are not in app_labels as possible.
|
|
Note that some other migrations may still be present, as they may be
|
|
required dependencies.
|
|
"""
|
|
# Gather other app dependencies in a first pass
|
|
app_dependencies = {}
|
|
for app_label, migrations in changes.items():
|
|
for migration in migrations:
|
|
for dep_app_label, name in migration.dependencies:
|
|
app_dependencies.setdefault(app_label, set()).add(dep_app_label)
|
|
required_apps = set(app_labels)
|
|
# Keep resolving till there's no change
|
|
old_required_apps = None
|
|
while old_required_apps != required_apps:
|
|
old_required_apps = set(required_apps)
|
|
for app_label in list(required_apps):
|
|
required_apps.update(app_dependencies.get(app_label, set()))
|
|
# Remove all migrations that aren't needed
|
|
for app_label in list(changes.keys()):
|
|
if app_label not in required_apps:
|
|
del changes[app_label]
|
|
return changes
|
|
|
|
@classmethod
|
|
def suggest_name(cls, ops):
|
|
"""
|
|
Given a set of operations, suggests a name for the migration
|
|
they might represent. Names are not guaranteed to be unique,
|
|
but we put some effort in to the fallback name to avoid VCS conflicts
|
|
if we can.
|
|
"""
|
|
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 len(ops) > 1:
|
|
if all(isinstance(o, operations.CreateModel) for o in ops):
|
|
return "_".join(sorted(o.name_lower for o in ops))
|
|
return "auto_%s" % datetime.datetime.now().strftime("%Y%m%d_%H%M")
|
|
|
|
@classmethod
|
|
def parse_number(cls, name):
|
|
"""
|
|
Given a migration name, tries to extract a number from the
|
|
beginning of it. If no number found, returns None.
|
|
"""
|
|
if re.match(r"^\d+_", name):
|
|
return int(name.split("_")[0])
|
|
return None
|