Google AppEngineモデルのJSONシリアル化

Question 1

私はかなり長い間探していましたが、成功しませんでした。私のプロジェクトは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')

Question 2

単純な再帰関数を使用して、エンティティ（および任意の指示対象）を次の宛先に渡すことができるネストされたディクショナリに変換できます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

Question 3

これは私が見つけた最も簡単な解決策です。必要なコードは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]))

Question 4

App Engine SDKの最新（1.5.2）リリースでは、to_dict()モデルインスタンスを辞書に変換する関数がで導入されましたdb.py。リリースノートを参照してください。

現時点では、ドキュメントにこの関数への参照はありませんが、私はそれを自分で試しましたが、期待どおりに機能します。

Question 5

モデルをシリアル化するには、次のpythonのようにカスタムjsonエンコーダーを追加します。

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)

Question 6

独自の「パーサー」を作成する必要はありませんが（パーサーはおそらくJSONをPythonオブジェクトに変換します）、Pythonオブジェクトを自分でシリアル化することはできます。

simplejsonの使用：

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

Question 7

単純なケースでは、記事の最後にあるここで提唱されているアプローチが好きです。

  # 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の欠落に関するエラーが発生する理由がわかりません、おそらくここで説明されているバグ）。プロパティ/メソッド。ほとんどの場合、シリアル化の必要性はその中間にあり、@ DavidWilsonのような内省的なアプローチが望ましい場合があります。

Question 8

フレームワークとしてdjangoを使用していない場合でも、これらのライブラリを使用できます。

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

Question 9

app-engine-patchを使用すると、_meta属性が自動的に宣言され、django.core.serializersdjangoモデルで通常行うように（sledgeのコードのように）使用できます。

App-engine-patchには、ハイブリッド認証（django + googleアカウント）などの他の優れた機能がいくつかあり、djangoの管理部分は機能します。

Question 10

上記の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

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

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

Question 13

すべてのModelクラスに対して定義されたメソッド「Model.properties（）」があります。それはあなたが求めるdictを返します。

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

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

ドキュメントのモデルプロパティを参照してください。

Question 14

これらのAPI（google.appengine.ext.db）は推奨されなくなりました。これらのAPIを使用するアプリは、App Engine Python 2ランタイムでのみ実行でき、App Engine Python3ランタイムに移行する前に他のAPIとサービスに移行する必要があります。詳細については、ここをクリックしてください

Question 15

データストアモデルインスタンスをシリアル化するには、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)