Google App引擎模型的JSON序列化

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

即使你不使用Django作爲一個框架，這些庫仍然可以供您使用。

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

Answer 3

你不需要編寫自己的「語法分析器」（解析器大概會轉成JSON Python對象），但你仍然可以序列化的Python對象自己。

使用simplejson：

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

Answer 4

對於簡單的案例中，我喜歡在文章末尾提倡here的方法：

# 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缺失的錯誤，或許是描述了here的錯誤）序列化計算的屬性/方法。大多數情況下，你的序列化需求介於兩者之間，對於像@David Wilson's這樣的內省方法可能更可取。

Answer 5

如果使用app-engine-patch它會自動申報_meta屬性給你，然後你可以使用django.core.serializers，你通常會在Django模型做（如雪橇的代碼）。

應用引擎補丁還有其他一些很酷的功能，例如混合身份驗證（django + Google帳戶）以及django的管理部分。

Answer 6

這是我找到的最簡單的解決方案。它只需要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 7

有一個方法， 「Model.properties（）」，所有定義模型類。它返回你尋求的字典。

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

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

請參閱Model properties在文檔中。

Answer 8

要序列模型，添加自定義的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字符串（per this suggestion）
• 一模型作爲其屬性的字典，
• 用戶作爲他的電子郵件。

爲了解碼之日起，您可以使用此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 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 

Answer 10

在App Engine SDK，一個to_dict()函數模型實例轉換爲字典中db.py引入的最新版本（1.5.2）發佈。請參閱release notes。

到目前爲止還沒有在文檔中提到這個函數，但我自己試過了，它按預期工作。

Answer 11

我已經延長了dpatru寫的JSON編碼器類，以支持：

• 查詢結果的屬性（如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 12

正如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 13

要序列化數據存儲模型實例，您不能使用json.dumps（未經測試，但Lorenzo指出）。也許在未來，以下將起作用。

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)