web/lib/django/core/management/commands/dumpdata.py
author ymh <ymh.work@gmail.com>
Wed, 02 Jun 2010 18:57:35 +0200
changeset 38 77b6da96e6f1
permissions -rw-r--r--
update django
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
38
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
     1
from django.core.exceptions import ImproperlyConfigured
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
     2
from django.core.management.base import BaseCommand, CommandError
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
     3
from django.core import serializers
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
     4
from django.db import connections, router, DEFAULT_DB_ALIAS
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
     5
from django.utils.datastructures import SortedDict
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
     6
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
     7
from optparse import make_option
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
     8
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
     9
class Command(BaseCommand):
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    10
    option_list = BaseCommand.option_list + (
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    11
        make_option('--format', default='json', dest='format',
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    12
            help='Specifies the output serialization format for fixtures.'),
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    13
        make_option('--indent', default=None, dest='indent', type='int',
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    14
            help='Specifies the indent level to use when pretty-printing output'),
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    15
        make_option('--database', action='store', dest='database',
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    16
            default=DEFAULT_DB_ALIAS, help='Nominates a specific database to load '
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    17
                'fixtures into. Defaults to the "default" database.'),
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    18
        make_option('-e', '--exclude', dest='exclude',action='append', default=[],
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    19
            help='App to exclude (use multiple --exclude to exclude multiple apps).'),
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    20
        make_option('-n', '--natural', action='store_true', dest='use_natural_keys', default=False,
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    21
            help='Use natural keys if they are available.'),
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    22
    )
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    23
    help = 'Output the contents of the database as a fixture of the given format.'
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    24
    args = '[appname appname.ModelName ...]'
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    25
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    26
    def handle(self, *app_labels, **options):
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    27
        from django.db.models import get_app, get_apps, get_models, get_model
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    28
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    29
        format = options.get('format','json')
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    30
        indent = options.get('indent',None)
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    31
        using = options.get('database', DEFAULT_DB_ALIAS)
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    32
        connection = connections[using]
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    33
        exclude = options.get('exclude',[])
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    34
        show_traceback = options.get('traceback', False)
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    35
        use_natural_keys = options.get('use_natural_keys', False)
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    36
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    37
        excluded_apps = set(get_app(app_label) for app_label in exclude)
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    38
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    39
        if len(app_labels) == 0:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    40
            app_list = SortedDict((app, None) for app in get_apps() if app not in excluded_apps)
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    41
        else:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    42
            app_list = SortedDict()
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    43
            for label in app_labels:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    44
                try:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    45
                    app_label, model_label = label.split('.')
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    46
                    try:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    47
                        app = get_app(app_label)
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    48
                    except ImproperlyConfigured:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    49
                        raise CommandError("Unknown application: %s" % app_label)
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    50
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    51
                    model = get_model(app_label, model_label)
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    52
                    if model is None:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    53
                        raise CommandError("Unknown model: %s.%s" % (app_label, model_label))
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    54
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    55
                    if app in app_list.keys():
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    56
                        if app_list[app] and model not in app_list[app]:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    57
                            app_list[app].append(model)
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    58
                    else:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    59
                        app_list[app] = [model]
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    60
                except ValueError:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    61
                    # This is just an app - no model qualifier
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    62
                    app_label = label
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    63
                    try:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    64
                        app = get_app(app_label)
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    65
                    except ImproperlyConfigured:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    66
                        raise CommandError("Unknown application: %s" % app_label)
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    67
                    app_list[app] = None
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    68
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    69
        # Check that the serialization format exists; this is a shortcut to
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    70
        # avoid collating all the objects and _then_ failing.
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    71
        if format not in serializers.get_public_serializer_formats():
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    72
            raise CommandError("Unknown serialization format: %s" % format)
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    73
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    74
        try:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    75
            serializers.get_serializer(format)
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    76
        except KeyError:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    77
            raise CommandError("Unknown serialization format: %s" % format)
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    78
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    79
        # Now collate the objects to be serialized.
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    80
        objects = []
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    81
        for model in sort_dependencies(app_list.items()):
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    82
            if not model._meta.proxy and router.allow_syncdb(using, model):
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    83
                objects.extend(model._default_manager.using(using).all())
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    84
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    85
        try:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    86
            return serializers.serialize(format, objects, indent=indent,
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    87
                        use_natural_keys=use_natural_keys)
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    88
        except Exception, e:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    89
            if show_traceback:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    90
                raise
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    91
            raise CommandError("Unable to serialize database: %s" % e)
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    92
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    93
def sort_dependencies(app_list):
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    94
    """Sort a list of app,modellist pairs into a single list of models.
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    95
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    96
    The single list of models is sorted so that any model with a natural key
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    97
    is serialized before a normal model, and any model with a natural key
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    98
    dependency has it's dependencies serialized first.
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    99
    """
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   100
    from django.db.models import get_model, get_models
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   101
    # Process the list of models, and get the list of dependencies
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   102
    model_dependencies = []
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   103
    models = set()
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   104
    for app, model_list in app_list:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   105
        if model_list is None:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   106
            model_list = get_models(app)
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   107
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   108
        for model in model_list:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   109
            models.add(model)
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   110
            # Add any explicitly defined dependencies
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   111
            if hasattr(model, 'natural_key'):
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   112
                deps = getattr(model.natural_key, 'dependencies', [])
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   113
                if deps:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   114
                    deps = [get_model(*d.split('.')) for d in deps]
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   115
            else:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   116
                deps = []
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   117
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   118
            # Now add a dependency for any FK or M2M relation with
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   119
            # a model that defines a natural key
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   120
            for field in model._meta.fields:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   121
                if hasattr(field.rel, 'to'):
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   122
                    rel_model = field.rel.to
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   123
                    if hasattr(rel_model, 'natural_key'):
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   124
                        deps.append(rel_model)
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   125
            for field in model._meta.many_to_many:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   126
                rel_model = field.rel.to
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   127
                if hasattr(rel_model, 'natural_key'):
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   128
                    deps.append(rel_model)
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   129
            model_dependencies.append((model, deps))
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   130
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   131
    model_dependencies.reverse()
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   132
    # Now sort the models to ensure that dependencies are met. This
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   133
    # is done by repeatedly iterating over the input list of models.
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   134
    # If all the dependencies of a given model are in the final list,
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   135
    # that model is promoted to the end of the final list. This process
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   136
    # continues until the input list is empty, or we do a full iteration
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   137
    # over the input models without promoting a model to the final list.
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   138
    # If we do a full iteration without a promotion, that means there are
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   139
    # circular dependencies in the list.
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   140
    model_list = []
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   141
    while model_dependencies:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   142
        skipped = []
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   143
        changed = False
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   144
        while model_dependencies:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   145
            model, deps = model_dependencies.pop()
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   146
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   147
            # If all of the models in the dependency list are either already
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   148
            # on the final model list, or not on the original serialization list,
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   149
            # then we've found another model with all it's dependencies satisfied.
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   150
            found = True
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   151
            for candidate in ((d not in models or d in model_list) for d in deps):
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   152
                if not candidate:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   153
                    found = False
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   154
            if found:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   155
                model_list.append(model)
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   156
                changed = True
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   157
            else:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   158
                skipped.append((model, deps))
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   159
        if not changed:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   160
            raise CommandError("Can't resolve dependencies for %s in serialized app list." %
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   161
                ', '.join('%s.%s' % (model._meta.app_label, model._meta.object_name)
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   162
                for model, deps in sorted(skipped, key=lambda obj: obj[0].__name__))
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   163
            )
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   164
        model_dependencies = skipped
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   165
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   166
    return model_list