Google App Engine modellerinin JSON serileştirmesi

Başarısız bir süredir aradım. Projem Django kullanmıyor, App Engine modellerini (google.appengine.ext.db.Model) JSON'a serileştirmenin basit bir yolu var mı yoksa kendi serileştiricimi mi yazmam gerekiyor?

Model:

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')

Basit bir özyinelemeli fonksiyon, bir varlığı (ve herhangi bir referansı) şunlara iletilebilecek iç içe bir sözlüğe dönüştürmek için kullanılabilir 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

Bulduğum en basit çözüm bu. Yalnızca 3 satır kod gerektirir.

Bir sözlük döndürmek için modelinize bir yöntem eklemeniz yeterlidir:

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

SimpleJSON artık düzgün çalışıyor:

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]))

App Engine SDK'nın en son (1.5.2) sürümünde, to_dict()model örneklerini sözlüğe dönüştüren bir işlev tanıtıldı db.py. Sürüm notlarına bakın .

Henüz dokümantasyonda bu işleve atıfta bulunulmamaktadır, ancak kendim denedim ve beklendiği gibi çalışıyor.

Modelleri serileştirmek için aşağıdaki python'da olduğu gibi özel bir json kodlayıcı ekleyin:

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)

Bu kodlayacak:

• izoformat dizesi olarak bir tarih ( bu öneriye göre ),
• özelliklerinin bir diktesi olarak bir model,
• e-postası olarak bir kullanıcı.

Tarihin kodunu çözmek için bu javascript'i kullanabilirsiniz:

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

Not: Bu kodu daha okunaklı hale getirmek için düzenleyen kullanıcı pydave'e teşekkürler . Başlangıçta python'un if / else ifadelerini jsonEncoderaşağıdaki gibi daha az satırda ifade etmek için kullanmıştım : (Bazı yorumlar ekledim google.appengine.ext.db.to_dictve orijinalinden daha açık hale getirmek için kullandım .)

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)

Kendi "ayrıştırıcınızı" yazmanıza gerek yoktur (bir ayrıştırıcı muhtemelen JSON'u bir Python nesnesine dönüştürecektir), ancak yine de Python nesnenizi kendiniz serileştirebilirsiniz.

Simplejson kullanarak :

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

Basit durumlar için, makalenin sonunda burada savunulan yaklaşımı beğendim :

  # 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())})

Makale ayrıca, spektrumun diğer ucunda, _metadjango'ları zenginleştiren (ve gerektirir - neden _meta eksikliğiyle ilgili hatalar aldığınızdan emin değilim, belki de burada açıklanan hata ) hesaplanmış serileştirme yeteneği ile karmaşık bir serileştirici sınıfı içerir. özellikler / yöntemler. Serileştirmeye ihtiyaç duyduğunuz çoğu zaman arada bir yerde yatar ve bunlar için @David Wilson gibi introspektif bir yaklaşım tercih edilebilir.

Django'yu bir çerçeve olarak kullanmasanız bile, bu kitaplıkları kullanmanız için hala mevcuttur.

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

Uygulama motoru yaması kullanırsanız , _metaözniteliği sizin için otomatik olarak bildirir ve sonra kullanabilirsinizdjango.core.serializers normalde django modellerinde yaptığınız gibi (sledge kodunda olduğu gibi) kullanabilirsiniz.

Uygulama motoru yaması, karma bir kimlik doğrulama (django + google hesapları) gibi başka harika özelliklere sahiptir ve django'nun yönetici kısmı çalışır.

Mtgred'in yukarıdaki cevabı benim için harika çalıştı - biraz değiştirdim, böylece girişin anahtarını da alabilirdim. Az sayıda kod satırı değil, ama bana benzersiz anahtarı veriyor:

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

Dpatru tarafından yazılan JSON Encoder sınıfını şunları desteklemek için genişlettim :

• Sorgu sonuçları özellikleri (ör. Car.owner_set)
• ReferenceProperty - özyinelemeli olarak JSON'a dönüştürün

• Filtreleme özellikleri - yalnızca a içeren özellikler verbose_nameJSON olarak kodlanacaktır

  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)
  

Https://stackoverflow.com/users/806432/fredva'da belirtildiği gibi , to_dict harika çalışıyor. İşte kullandığım kodum.

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

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

myJson = json.dumps(prepJson))

Tüm Model sınıfları için tanımlanmış "Model.properties ()" adlı bir yöntem vardır. Aradığınız emri verir.

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

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

Belgelerdeki Model özelliklerine bakın .

Bu API'ler (google.appengine.ext.db) artık önerilmemektedir. Bu API'leri kullanan uygulamalar yalnızca App Engine Python 2 çalışma zamanında çalışabilir ve App Engine Python 3 çalışma zamanına geçiş yapmadan önce diğer API'lere ve hizmetlere taşınmaları gerekir. Daha fazlasını öğrenmek için: buraya tıklayın

Bir Datastore Modeli örneğini serileştirmek için json.dumps kullanamazsınız (test etmedi ancak Lorenzo bunu gösterdi). Belki gelecekte aşağıdakiler işe yarayacaktır.

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)