JSON-Serialisierung von Google App Engine-Modellen

Ich habe eine ganze Weile ohne Erfolg gesucht. Mein Projekt verwendet kein Django. Gibt es eine einfache Möglichkeit, App Engine-Modelle (google.appengine.ext.db.Model) in JSON zu serialisieren, oder muss ich meinen eigenen Serializer schreiben?

Modell:

class Photo(db.Model):
    filename = db.StringProperty()
    title = db.StringProperty()
    description = db.StringProperty(multiline=True)
    date_taken = db.DateTimeProperty()
    date_uploaded = db.DateTimeProperty(auto_now_add=True)
    album = db.ReferenceProperty(Album, collection_name='photo')

Eine einfache rekursive Funktion kann verwendet werden, um eine Entität (und alle Verweise) in ein verschachteltes Wörterbuch zu konvertieren, das übergeben werden kann an simplejson:

import datetime
import time

SIMPLE_TYPES = (int, long, float, bool, dict, basestring, list)

def to_dict(model):
    output = {}

    for key, prop in model.properties().iteritems():
        value = getattr(model, key)

        if value is None or isinstance(value, SIMPLE_TYPES):
            output[key] = value
        elif isinstance(value, datetime.date):
            # Convert date/datetime to MILLISECONDS-since-epoch (JS "new Date()").
            ms = time.mktime(value.utctimetuple()) * 1000
            ms += getattr(value, 'microseconds', 0) / 1000
            output[key] = int(ms)
        elif isinstance(value, db.GeoPt):
            output[key] = {'lat': value.lat, 'lon': value.lon}
        elif isinstance(value, db.Model):
            output[key] = to_dict(value)
        else:
            raise ValueError('cannot encode ' + repr(prop))

    return output

Dies ist die einfachste Lösung, die ich gefunden habe. Es sind nur 3 Codezeilen erforderlich.

Fügen Sie Ihrem Modell einfach eine Methode hinzu, um ein Wörterbuch zurückzugeben:

class DictModel(db.Model):
    def to_dict(self):
       return dict([(p, unicode(getattr(self, p))) for p in self.properties()])

SimpleJSON funktioniert jetzt ordnungsgemäß:

class Photo(DictModel):
   filename = db.StringProperty()
   title = db.StringProperty()
   description = db.StringProperty(multiline=True)
   date_taken = db.DateTimeProperty()
   date_uploaded = db.DateTimeProperty(auto_now_add=True)
   album = db.ReferenceProperty(Album, collection_name='photo')

from django.utils import simplejson
from google.appengine.ext import webapp

class PhotoHandler(webapp.RequestHandler):
   def get(self):
      photos = Photo.all()
      self.response.out.write(simplejson.dumps([p.to_dict() for p in photos]))

In der neuesten Version (1.5.2) des App Engine SDK wurde eine to_dict()Funktion eingeführt, mit der Modellinstanzen in Wörterbücher konvertiert werden db.py. Siehe die Versionshinweise .

Es gibt noch keinen Hinweis auf diese Funktion in der Dokumentation, aber ich habe es selbst versucht und es funktioniert wie erwartet.

Fügen Sie zum Serialisieren von Modellen einen benutzerdefinierten JSON-Encoder wie im folgenden Python hinzu:

import datetime
from google.appengine.api import users
from google.appengine.ext import db
from django.utils import simplejson

class jsonEncoder(simplejson.JSONEncoder):
    def default(self, obj):
        if isinstance(obj, datetime.datetime):
            return obj.isoformat()

        elif isinstance(obj, db.Model):
            return dict((p, getattr(obj, p)) 
                        for p in obj.properties())

        elif isinstance(obj, users.User):
            return obj.email()

        else:
            return simplejson.JSONEncoder.default(self, obj)


# use the encoder as: 
simplejson.dumps(model, cls=jsonEncoder)

Dies wird codieren:

• ein Datum als Isoformat-Zeichenfolge ( gemäß diesem Vorschlag ),
• ein Modell als Diktat seiner Eigenschaften,
• ein Benutzer als seine E-Mail.

Um das Datum zu dekodieren, können Sie dieses Javascript verwenden:

function decodeJsonDate(s){
  return new Date( s.slice(0,19).replace('T',' ') + ' GMT' );
} // Note that this function truncates milliseconds.

Hinweis: Vielen Dank an den Benutzer pydave, der diesen Code bearbeitet hat, um ihn besser lesbar zu machen. Ich hatte ursprünglich Pythons if / else-Ausdrücke verwendet, um jsonEncoderin weniger Zeilen wie folgt auszudrücken : (Ich habe einige Kommentare hinzugefügt und verwendet google.appengine.ext.db.to_dict, um es klarer als das Original zu machen.)

class jsonEncoder(simplejson.JSONEncoder):
  def default(self, obj):
    isa=lambda x: isinstance(obj, x) # isa(<type>)==True if obj is of type <type>
    return obj.isoformat() if isa(datetime.datetime) else \
           db.to_dict(obj) if isa(db.Model) else \
           obj.email()     if isa(users.User) else \
           simplejson.JSONEncoder.default(self, obj)

Sie müssen keinen eigenen "Parser" schreiben (ein Parser würde JSON vermutlich in ein Python-Objekt verwandeln), aber Sie können Ihr Python-Objekt trotzdem selbst serialisieren.

Verwenden von simplejson :

import simplejson as json
serialized = json.dumps({
    'filename': self.filename,
    'title': self.title,
    'date_taken': date_taken.isoformat(),
    # etc.
})

Für einfache Fälle gefällt mir der hier am Ende des Artikels befürwortete Ansatz :

  # after obtaining a list of entities in some way, e.g.:
  user = users.get_current_user().email().lower();
  col = models.Entity.gql('WHERE user=:1',user).fetch(300, 0)

  # ...you can make a json serialization of name/key pairs as follows:
  json = simplejson.dumps(col, default=lambda o: {o.name :str(o.key())})

Der Artikel enthält am anderen Ende des Spektrums auch eine komplexe Serializer-Klasse, die Djangos bereichert (und erfordert _meta- nicht sicher, warum Fehler über _meta fehlen, möglicherweise den hier beschriebenen Fehler ), mit der Fähigkeit, berechnete Serialisierungen durchzuführen Eigenschaften / Methoden. Die meiste Zeit, die Sie für die Serialisierung benötigen, liegt irgendwo dazwischen, und für diejenigen ist ein introspektiver Ansatz wie der von @David Wilson möglicherweise vorzuziehen.

Auch wenn Sie Django nicht als Framework verwenden, stehen Ihnen diese Bibliotheken weiterhin zur Verfügung.

from django.core import serializers
data = serializers.serialize("xml", Photo.objects.all())

Wenn Sie den App-Engine-Patch verwenden , wird das _metaAttribut automatisch für Sie deklariert , und Sie können es verwendendjango.core.serializers Sie es wie gewohnt bei Django-Modellen verwenden (wie im Code des Schlittens).

App-Engine-Patch hat einige andere coole Funktionen wie eine Hybrid-Authentifizierung (Django + Google-Konten), und der Admin-Teil von Django funktioniert.

Die Antwort von Mtgred oben hat wunderbar für mich funktioniert - ich habe sie leicht modifiziert, damit ich auch den Schlüssel für den Eintrag bekommen konnte. Nicht so wenige Codezeilen, aber es gibt mir den eindeutigen Schlüssel:

class DictModel(db.Model):
def to_dict(self):
    tempdict1 = dict([(p, unicode(getattr(self, p))) for p in self.properties()])
    tempdict2 = {'key':unicode(self.key())}
    tempdict1.update(tempdict2)
    return tempdict1

Ich habe die von dpatru geschriebene JSON Encoder-Klasse erweitert, um Folgendes zu unterstützen:

• Eigenschaften der Abfrageergebnisse (z. B. car.owner_set)
• ReferenceProperty - verwandelt es rekursiv in JSON

• Filtereigenschaften - Nur Eigenschaften mit a verbose_namewerden in JSON codiert

  class DBModelJSONEncoder(json.JSONEncoder):
      """Encodes a db.Model into JSON"""
  
      def default(self, obj):
          if (isinstance(obj, db.Query)):
              # It's a reference query (holding several model instances)
              return [self.default(item) for item in obj]
  
          elif (isinstance(obj, db.Model)):
              # Only properties with a verbose name will be displayed in the JSON output
              properties = obj.properties()
              filtered_properties = filter(lambda p: properties[p].verbose_name != None, properties)
  
              # Turn each property of the DB model into a JSON-serializeable entity
              json_dict = dict([(
                      p,
                      getattr(obj, p)
                          if (not isinstance(getattr(obj, p), db.Model))
                          else
                      self.default(getattr(obj, p)) # A referenced model property
                  ) for p in filtered_properties])
  
              json_dict['id'] = obj.key().id() # Add the model instance's ID (optional - delete this if you do not use it)
  
              return json_dict
  
          else:
              # Use original JSON encoding
              return json.JSONEncoder.default(self, obj)

Wie von https://stackoverflow.com/users/806432/fredva erwähnt , funktioniert das to_dict hervorragend. Hier ist mein Code, den ich benutze.

foos = query.fetch(10)
prepJson = []

for f in foos:
  prepJson.append(db.to_dict(f))

myJson = json.dumps(prepJson))

Es gibt eine Methode "Model.properties ()", die für alle Modellklassen definiert ist. Es gibt das Diktat zurück, das Sie suchen.

from django.utils import simplejson
class Photo(db.Model):
  # ...

my_photo = Photo(...)
simplejson.dumps(my_photo.properties())

Siehe Modelleigenschaften in den Dokumenten.

Zum Serialisieren einer Datenspeichermodellinstanz können Sie json.dumps nicht verwenden (nicht getestet, aber Lorenzo hat darauf hingewiesen). Vielleicht funktioniert in Zukunft Folgendes.

http://docs.python.org/2/library/json.html

import json
string = json.dumps(['foo', {'bar': ('baz', None, 1.0, 2)}])
object = json.loads(self.request.body)