Сериализация JSON моделей Google App Engine
Я искал довольно долгое время. Мой проект не использует 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')
Ответы
Ответ 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
Ответ 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]))
Ответ 3
В последнем выпуске SDK App Engine (1.5.2) в db.py
была введена функция to_dict()
, которая преобразует экземпляры модели в словари. См. примечания к выпуску.
В документации пока нет ссылки на эту функцию, но я сам ее пробовал и работает так, как ожидалось.
Ответ 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)
Это будет кодировать:
- дата как строка isoformat (за это предложение),
- модель как элемент ее свойств,
- пользователь в качестве своего сообщения.
Чтобы декодировать дату, вы можете использовать этот 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)
Ответ 5
Вам не нужно писать собственный "парсер" (синтаксический анализатор предположительно превратит JSON в объект Python), но вы все равно можете сериализовать свой объект Python самостоятельно.
Использование simplejson:
import simplejson as json
serialized = json.dumps({
'filename': self.filename,
'title': self.title,
'date_taken': date_taken.isoformat(),
# etc.
})
Ответ 6
В простых случаях мне нравится подход здесь в конце статьи:
# 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.
Ответ 7
Даже если вы не используете django в качестве рамки, эти библиотеки по-прежнему доступны для вас.
from django.core import serializers
data = serializers.serialize("xml", Photo.objects.all())
Ответ 8
Если вы используете app-engine-patch, он автоматически объявит для вас атрибут _meta
, а затем вы можете использовать django.core.serializers
как вы обычно делаете на моделях django (как в коде sledge).
App-engine-patch имеет некоторые другие интересные функции, такие как гибридная проверка подлинности (учетные записи django + google), а также админ-часть django.
Ответ 9
Ответ Mtgred выше отлично работал у меня - я слегка изменил его, чтобы я мог получить ключ для записи. Не так мало строк кода, но он дает мне уникальный ключ:
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
Ответ 10
Я расширил класс 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 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 ID (optional - delete this if you do not use it)
return json_dict
else:
# Use original JSON encoding
return json.JSONEncoder.default(self, obj)
Ответ 11
Как упоминалось 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))
Ответ 12
Существует метод "Model.properties()", определенный для всех классов модели. Он возвращает запрос, который вы ищете.
from django.utils import simplejson
class Photo(db.Model):
# ...
my_photo = Photo(...)
simplejson.dumps(my_photo.properties())
Смотрите Свойства модели в документах.
Ответ 13
Чтобы сериализовать экземпляр модели хранилища данных, вы не можете использовать json.dumps(не тестировали, но Лоренцо указал на это). Возможно, в будущем будут работать следующие.
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)