Comment sérialiser une instance de modèle dans Django ?

Question

Il existe beaucoup de documentation sur la façon de sérialiser un Model QuerySet mais comment sérialiser en JSON les champs d'une Instance de Modèle ?

Answer 1

Vous pouvez facilement utiliser une liste pour envelopper l'objet requis et c'est tout ce dont les sérialiseurs de django ont besoin pour le sérialiser correctement, par ex :

from django.core import serializers

# assuming obj is a model instance
serialized_obj = serializers.serialize('json', [ obj, ])

Answer 2

Pour éviter le wrapper de tableau, supprimez-le avant de renvoyer la réponse :

import json
from django.core import serializers

def getObject(request, id):
    obj = MyModel.objects.get(pk=id)
    data = serializers.serialize('json', [obj,])
    struct = json.loads(data)
    data = json.dumps(struct[0])
    return HttpResponse(data, mimetype='application/json')

J'ai également trouvé ce post intéressant sur le sujet :

http://timsaylor.com/convert-django-model-instances-to-dictionaries

Il utilise django.forms.models.model_to_dict, qui semble être l'outil parfait pour ce travail.

Answer 3

Il semble que votre question porte sur la sérialisation de la structure des données d'une instance de modèle Django à des fins d'interopérabilité. Les autres posters sont corrects : si vous voulez que le formulaire sérialisé soit utilisé avec une application python qui peut interroger la base de données via l'api de Django, alors vous voudriez sérialiser un queryset avec un objet. Si, d'autre part, ce dont vous avez besoin est un moyen de regonfler l'instance du modèle quelque part ailleurs sans toucher à la base de données ou sans utiliser Django, alors vous avez un peu de travail à faire.

Voilà ce que je fais :

D'abord, j'utilise demjson pour la conversion. C'est ce que j'ai trouvé en premier, mais ce n'est peut-être pas le meilleur. Mon implémentation dépend d'une de ses caractéristiques, mais il devrait y avoir des moyens similaires avec d'autres convertisseurs.

Deuxièmement, mettez en place un json_equivalent sur tous les modèles que vous pourriez avoir besoin de sérialiser. Il s'agit d'une méthode magique pour demjson mais c'est probablement une chose à laquelle vous devez penser, quelle que soit la mise en œuvre que vous choisissez. L'idée est de retourner un objet qui est directement convertible en json (c'est-à-dire un tableau ou un dictionnaire). Si vous voulez vraiment faire cela automatiquement :

def json_equivalent(self):
    dictionary = {}
    for field in self._meta.get_all_field_names()
        dictionary[field] = self.__getattribute__(field)
    return dictionary

Cela ne vous sera utile que si vous disposez d'une structure de données complètement plate (aucune ForeignKeys uniquement des chiffres et des chaînes de caractères dans la base de données, etc.) Sinon, vous devriez sérieusement réfléchir à la bonne façon d'implémenter cette méthode.

Troisièmement, appelez demjson.JSON.encode(instance) et tu as ce que tu veux.

Answer 4

Si vous vous demandez comment sérialiser un seul objet à partir d'un modèle et que vous connaître vous n'allez obtenir qu'un seul objet dans le queryset (par exemple, en utilisant objects.get), alors utilisez quelque chose comme :

import django.core.serializers
import django.http
import models

def jsonExample(request,poll_id):
    s = django.core.serializers.serialize('json',[models.Poll.objects.get(id=poll_id)])
    # s is a string with [] around it, so strip them off
    o=s.strip("[]")
    return django.http.HttpResponse(o, mimetype="application/json")

ce qui vous permettrait d'obtenir quelque chose de cette forme :

{"pk": 1, "model": "polls.poll", "fields": {"pub_date": "2013-06-27T02:29:38.284Z", "question": "What's up?"}}

Answer 5

J'ai résolu ce problème en ajoutant une méthode de sérialisation à mon modèle :

def toJSON(self):
    import simplejson
    return simplejson.dumps(dict([(attr, getattr(self, attr)) for attr in [f.name for f in self._meta.fields]]))

Voici l'équivalent verbeux pour ceux qui n'aiment pas les phrases toutes faites :

def toJSON(self):
    fields = []
    for field in self._meta.fields:
        fields.append(field.name)

    d = {}
    for attr in fields:
        d[attr] = getattr(self, attr)

    import simplejson
    return simplejson.dumps(d)

_meta.fields est une liste ordonnée de champs du modèle auxquels on peut accéder à partir des instances et du modèle lui-même.