JSON-сериализация моделей Google App Engine

Question

Я долго искал, но безуспешно. Мой проект не использует Django, есть ли простой способ сериализации моделей App Engine (google.appengine.ext.db.Model) в JSON или мне нужно написать свой собственный сериализатор?

Модель:

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

Answer 1

Простую рекурсивную функцию можно использовать для преобразования сущности (и любых ссылок) во вложенный словарь, который можно передать в 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

Answer 2

Это самое простое решение, которое я нашел. Требуется всего 3 строки кодов.

Просто добавьте метод к вашей модели, чтобы получить словарь:

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

SimpleJSON теперь работает правильно:

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

Answer 3

В последнем (1.5.2) выпуске App Engine SDK в db.py была представлена ​​функция to_dict(), которая преобразует экземпляры модели в словари. См. примечания к выпуску .

В документации пока нет ссылки на эту функцию, но я сам попробовал ее, и она работает как положено.

Answer 4

Чтобы сериализовать модели, добавьте пользовательский кодер json, как в следующем Python:

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)

Это закодирует:

• дата в виде изоформатной строки ( в соответствии с этим предложением ),
• модель как диктат ее свойств,
• пользователь как его электронная почта.

Для декодирования даты вы можете использовать этот javascript:

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

Примечание: Спасибо пользователю pydave , который отредактировал этот код, чтобы сделать его более читабельным. Первоначально я использовал выражения python if / else для выражения jsonEncoder в меньшем количестве строк следующим образом: (Я добавил несколько комментариев и использовал google.appengine.ext.db.to_dict, чтобы сделать его более понятным, чем оригинал.)

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)

Answer 5

Для простых случаев мне нравится подход здесь в конце статьи:

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

Статья также содержит, на другом конце спектра, сложный класс сериализатора, который обогащает django (и требует _meta - не уверен, почему вы получаете ошибки об отсутствии _meta, возможно описанная ошибка здесь ) с возможностью сериализации вычисленных свойств / методов. В большинстве случаев ваши потребности в сериализации лежат где-то посередине, и для них может оказаться предпочтительным такой интроспективный подход, как @David Wilson.

Answer 6

Вам не нужно писать свой собственный "парсер" (парсер предположительно превратит JSON в объект Python), но вы все равно можете сериализовать свой объект Python самостоятельно.

Использование simplejson :

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

Answer 7

Даже если вы не используете django в качестве фреймворка, эти библиотеки по-прежнему доступны для использования.

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

Answer 8

Как упоминалось https://stackoverflow.com/users/806432/fredva,, to_dict прекрасно работает. Вот мой код, которым я пользуюсь.

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

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

myJson = json.dumps(prepJson))

Answer 9

Я расширил класс JSON Encoder, написанный dpatru , для поддержки:

• Свойства результатов запроса (например, car.owner_set)
• ReferenceProperty - рекурсивно превратить его в JSON

• Свойства фильтрации - только свойства с verbose_name будут закодированы в JSON

  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)
  

Answer 10

Ответ Мтгреда выше работал для меня чудесно - я немного изменил его, чтобы получить ключ от записи. Не так мало строк кода, но он дает мне уникальный ключ:

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