1. Luke Plant
  2. south


south / south / creator / changes.py

Contains things to detect changes - either using options passed in on the
commandline, or by using autodetection, etc.

from django.db import models

from south.creator.freezer import remove_useless_attributes, freeze_apps, model_key

class BaseChanges(object):
    Base changes class.
    def split_model_def(self, model, model_def):
        Given a model and its model def (a dict of field: triple), returns three
        items: the real fields dict, the Meta dict, and the M2M fields dict.
        real_fields = {}
        meta = {}
        m2m_fields = {}
        for name, triple in model_def.items():
            if name == "Meta":
                meta = triple
            elif isinstance(model._meta.get_field_by_name(name)[0], models.ManyToManyField):
                m2m_fields[name] = triple
                real_fields[name] = triple
        return real_fields, meta, m2m_fields

class AutoChanges(BaseChanges):
    Detects changes by 'diffing' two sets of frozen model definitions.
    def __init__(self, migrations, old_defs, old_orm, new_defs):
        self.migrations = migrations
        self.old_defs = old_defs
        self.old_orm = old_orm
        self.new_defs = new_defs
    def current_model_from_key(self, key):
        app_label, model_name = key.split(".")
        return models.get_model(app_label, model_name)
    def current_field_from_key(self, key, fieldname):
        app_label, model_name = key.split(".")
        return models.get_model(app_label, model_name)._meta.get_field_by_name(fieldname)[0]
    def get_changes(self):
        Returns the difference between the old and new sets of models as a 5-tuple:
        added_models, deleted_models, added_fields, deleted_fields, changed_fields
        deleted_models = set()
        # See if anything's vanished
        for key in self.old_defs:
            if key not in self.new_defs:
                # We shouldn't delete it if it was managed=False
                if self.old_defs[key].get("Meta", {}).get("managed", "True") != "False":
                    # Alright, delete it.
                    yield ("DeleteModel", {
                        "model": self.old_orm[key], 
                        "model_def": self.split_model_def(self.old_orm[key], self.old_defs[key])[0],
                # We always add it in here so we ignore it later
        # Or appeared
        for key in self.new_defs:
            if key not in self.old_defs:
                # We shouldn't add it if it's managed=False
                if self.new_defs[key].get("Meta", {}).get("managed", "True") != "False":
                    yield ("AddModel", {
                        "model": self.current_model_from_key(key), 
                        "model_def": self.split_model_def(self.current_model_from_key(key), self.new_defs[key])[0],
        # Now, for every model that's stayed the same, check its fields.
        for key in self.old_defs:
            if key not in deleted_models:
                still_there = set()
                old_fields, old_meta, old_m2ms = self.split_model_def(self.old_orm[key], self.old_defs[key])
                new_fields, new_meta, new_m2ms = self.split_model_def(self.current_model_from_key(key), self.new_defs[key])
                # Find fields that have vanished.
                for fieldname in old_fields:
                    if fieldname not in new_fields:
                        if isinstance(self.old_orm[key + ":" + fieldname], models.ManyToManyField):
                            yield ("DeleteM2M", {"model": self.old_orm[key], "field": self.old_orm[key + ":" + fieldname]})
                            yield ("DeleteField", {"model": self.old_orm[key], "field": self.old_orm[key + ":" + fieldname], "field_def": old_fields[fieldname]})
                # And ones that have appeared
                for fieldname in new_fields:
                    if fieldname not in old_fields:
                        if isinstance(self.current_model_from_key(key)._meta.get_field_by_name(fieldname)[0], models.ManyToManyField):
                            yield ("AddM2M", {"model": self.current_model_from_key[key], "field": self.current_field_from_key(key, fieldname)})
                            yield ("AddField", {"model": self.current_model_from_key(key), "field": self.current_field_from_key(key, fieldname), "field_def": new_fields[fieldname]})
                # For the ones that exist in both models, see if they were changed
                for fieldname in set(old_fields).intersection(set(new_fields)):
                    if self.different_attributes(
                     remove_useless_attributes(old_fields[fieldname], True),
                     remove_useless_attributes(new_fields[fieldname], True)):
                        yield ("ChangeField", {
                            "old_model": self.old_orm[key],
                            "new_model": self.current_model_from_key(key),
                            "field": fieldname,
                            "old_def": old_fields[fieldname],
                            "new_def": new_fields[fieldname],
                    # See if their uniques have changed
                    old_triple = old_fields[fieldname]
                    new_triple = new_fields[fieldname]
                    if self.is_triple(old_triple) and self.is_triple(new_triple):
                        if old_triple[2].get("unique", "False") != new_triple[2].get("unique", "False"):
                            # Make sure we look at the one explicitly given to see what happened
                            if "unique" in old_triple[2]:
                                if old_triple[2]['unique'] == "False":
                                    yield ("AddUnique", {
                                        "model": self.current_model_from_key(key),
                                        "fields": [self.current_field_from_key(key, fieldname)],
                                    yield ("DeleteUnique", {
                                        "model": self.old_orm[key],
                                        "fields": [self.old_orm[key + ":" + fieldname]],
                                if new_triple[2]['unique'] == "False":
                                    yield ("DeleteUnique", {
                                        "model": self.old_orm[key],
                                        "fields": [self.old_orm[key + ":" + fieldname]],
                                    yield ("AddUnique", {
                                        "model": self.current_model_from_key(key),
                                        "fields": [self.current_field_from_key(key, fieldname)],
                ## See if the unique_togethers have changed
                # First, normalise them into lists of sets.
                old_unique_together = eval(old_meta.get("unique_together", "[]"))
                new_unique_together = eval(new_meta.get("unique_together", "[]"))
                if old_unique_together and isinstance(old_unique_together[0], basestring):
                    old_unique_together = [old_unique_together]
                if new_unique_together and isinstance(new_unique_together[0], basestring):
                    new_unique_together = [new_unique_together]
                old_unique_together = map(set, old_unique_together)
                new_unique_together = map(set, new_unique_together)
                # See if any appeared or disappeared
                for item in old_unique_together:
                    if item not in new_unique_together:
                        yield ("DeleteUnique", {
                            "model": self.old_orm[key],
                            "fields": [self.old_orm[key + ":" + x] for x in item],
                for item in new_unique_together:
                    if item not in old_unique_together:
                        yield ("AddUnique", {
                            "model": self.current_model_from_key(key),
                            "fields": [self.current_field_from_key(key, x) for x in item],

    def is_triple(cls, triple):
        "Returns whether the argument is a triple."
        return isinstance(triple, (list, tuple)) and len(triple) == 3 and \
            isinstance(triple[0], (str, unicode)) and \
            isinstance(triple[1], (list, tuple)) and \
            isinstance(triple[2], dict)

    def different_attributes(cls, old, new):
        Backwards-compat comparison that ignores orm. on the RHS and not the left
        and which knows django.db.models.fields.CharField = models.CharField.
        Has a whole load of tests in tests/autodetection.py.
        # If they're not triples, just do normal comparison
        if not cls.is_triple(old) or not cls.is_triple(new):
            return old != new
        # Expand them out into parts
        old_field, old_pos, old_kwd = old
        new_field, new_pos, new_kwd = new
        # Copy the positional and keyword arguments so we can compare them and pop off things
        old_pos, new_pos = old_pos[:], new_pos[:]
        old_kwd = dict(old_kwd.items())
        new_kwd = dict(new_kwd.items())
        # Remove comparison of the existence of 'unique', that's done elsewhere.
        # TODO: Make this work for custom fields where unique= means something else?
        if "unique" in old_kwd:
            del old_kwd['unique']
        if "unique" in new_kwd:
            del new_kwd['unique']
        # If the first bit is different, check it's not by dj.db.models...
        if old_field != new_field:
            if old_field.startswith("models.") and (new_field.startswith("django.db.models") \
             or new_field.startswith("django.contrib.gis")):
                if old_field.split(".")[-1] != new_field.split(".")[-1]:
                    return True
                    # Remove those fields from the final comparison
                    old_field = new_field = ""
        # If there's a positional argument in the first, and a 'to' in the second,
        # see if they're actually comparable.
        if (old_pos and "to" in new_kwd) and ("orm" in new_kwd['to'] and "orm" not in old_pos[0]):
            # Do special comparison to fix #153
                if old_pos[0] != new_kwd['to'].split("'")[1].split(".")[1]:
                    return True
            except IndexError:
                pass # Fall back to next comparison
            # Remove those attrs from the final comparison
            old_pos = old_pos[1:]
            del new_kwd['to']
        return old_field != new_field or old_pos != new_pos or old_kwd != new_kwd

class ManualChanges(object):
    Detects changes by reading the command line.
    def __init__(self):
    def get_changes(self):
        return [
            ("AddModel", {"model": self.current_orm['books.Book']}),
class InitialChanges(BaseChanges):
    Creates all models; handles --initial.
    def __init__(self, migrations):
        self.migrations = migrations
    def get_changes(self):
        # Get the frozen models for this app
        model_defs = freeze_apps([self.migrations.app_label()])
        for model in models.get_models(models.get_app(self.migrations.app_label())):
            real_fields, meta, m2m_fields = self.split_model_def(model, model_defs[model_key(model)])
            # Firstly, add the main table and fields
            yield ("AddModel", {
                "model": model,
                "model_def": real_fields,
            # Then, add any uniqueness that's around
            if meta:
                unique_together = eval(meta.get("unique_together", "[]"))
                if unique_together:
                    # If it's only a single tuple, make it into the longer one
                    if isinstance(unique_together[0], basestring):
                        unique_together = [unique_together]
                    # For each combination, make an action for it
                    for fields in unique_together:
                        yield ("AddUnique", {
                            "model": model,
                            "fields": list(fields),
            # Finally, see if there's some M2M action
            for name, triple in m2m_fields.items():
                field = model._meta.get_field_by_name(name)[0]
                # But only if it's not through=foo (#120)
                if (not field.rel.through) or getattr(field.rel.through._meta, "auto_created", False):
                    yield ("AddM2M", {
                        "model": model,
                        "field": name,