Tuần tự hóa JSON của các mô hình Google App Engine

Tôi đã tìm kiếm khá lâu mà không thành công. Dự án của tôi không sử dụng Django, có cách nào đơn giản để tuần tự hóa các mô hình App Engine (google.appengine.ext.db.Model) thành JSON hay tôi cần viết bộ tuần tự của riêng mình?

Mô hình:

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

Một hàm đệ quy đơn giản có thể được sử dụng để chuyển đổi một thực thể (và bất kỳ tham chiếu nào) sang một từ điển lồng nhau có thể được chuyển đến 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

Đây là giải pháp đơn giản nhất mà tôi tìm thấy. Nó chỉ yêu cầu 3 dòng mã.

Chỉ cần thêm một phương thức vào mô hình của bạn để trả về một từ điển:

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

SimpleJSON hiện hoạt động bình thường:

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

Trong phiên bản mới nhất (1.5.2) của App Engine SDK, một to_dict()chức năng chuyển đổi các phiên bản mô hình thành từ điển đã được giới thiệu trong db.py. Xem ghi chú phát hành .

Không có tham chiếu đến chức năng này trong tài liệu, nhưng tôi đã tự mình thử và nó hoạt động như mong đợi.

Để tuần tự hóa các mô hình, hãy thêm bộ mã hóa json tùy chỉnh như trong python sau:

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)

Điều này sẽ mã hóa:

• một ngày dưới dạng chuỗi isoformat ( theo gợi ý này ),
• một mô hình như một chính tả các thuộc tính của nó,
• một người dùng làm email của anh ấy.

Để giải mã ngày, bạn có thể sử dụng javascript này:

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

Lưu ý: Cảm ơn người dùng pydave đã chỉnh sửa mã này để làm cho nó dễ đọc hơn. Ban đầu, tôi đã sử dụng các biểu thức if / else của python để diễn đạt jsonEncodertrong ít dòng hơn như sau: (Tôi đã thêm một số nhận xét và sử dụng google.appengine.ext.db.to_dict, để làm cho nó rõ ràng hơn so với ban đầu.)

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)

Bạn không cần phải viết "trình phân tích cú pháp" của riêng mình (trình phân tích cú pháp có lẽ sẽ biến JSON thành một đối tượng Python), nhưng bạn vẫn có thể tự tuần tự hóa đối tượng Python của mình.

Sử dụng simplejson :

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

Đối với các trường hợp đơn giản, tôi thích cách tiếp cận được đề cập ở đây ở cuối bài viết:

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

Bài báo cũng chứa, ở đầu kia của phổ, một lớp serializer phức tạp làm phong phú thêm django (và không yêu cầu _meta- không chắc tại sao bạn gặp lỗi về _meta bị thiếu, có lẽ lỗi được mô tả ở đây ) với khả năng serialize được tính thuộc tính / phương thức. Hầu hết thời gian bạn cần tuần tự hóa nằm ở đâu đó và đối với những người, cách tiếp cận nội tâm như @David Wilson có thể phù hợp hơn.

Ngay cả khi bạn không sử dụng django làm khuôn khổ, những thư viện đó vẫn có sẵn để bạn sử dụng.

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

Nếu bạn sử dụng app-engine-patch, nó sẽ tự động khai báo _metathuộc tính cho bạn và sau đó bạn có thể sử dụng django.core.serializersnhư cách bạn thường làm trên các mô hình django (như trong mã của sledge).

App-engine-patch có một số tính năng thú vị khác như xác thực kết hợp (tài khoản django + google) và phần quản trị của django hoạt động.

Câu trả lời của Mtgred ở trên có tác dụng tuyệt vời đối với tôi - tôi đã sửa đổi một chút để tôi cũng có thể lấy được chìa khóa cho mục nhập. Không phải chỉ có vài dòng mã, nhưng nó mang lại cho tôi khóa duy nhất:

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

Tôi đã mở rộng lớp Bộ mã hóa JSON do dpatru viết để hỗ trợ:

• Thuộc tính kết quả truy vấn (ví dụ: car.owner_set)
• ReferenceProperty - đệ quy biến nó thành JSON

• Lọc thuộc tính - chỉ các thuộc tính có a verbose_namemới được mã hóa thành 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)
  

Như đã đề cập bởi https://stackoverflow.com/users/806432/fredva , to_dict hoạt động rất tốt. Đây là mã của tôi tôi đang sử dụng.

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

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

myJson = json.dumps(prepJson))

Có một phương thức, "Model.properties ()", được định nghĩa cho tất cả các lớp Model. Nó trả về mệnh lệnh mà bạn tìm kiếm.

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

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

Xem thuộc tính Mô hình trong tài liệu.

Các API này (google.appengine.ext.db) không còn được khuyến nghị nữa. Các ứng dụng sử dụng các API này chỉ có thể chạy trong thời gian chạy của App Engine Python 2 và sẽ cần phải di chuyển sang các API và dịch vụ khác trước khi chuyển sang thời gian chạy của App Engine Python 3. Để biết thêm: bấm vào đây

Để tuần tự hóa một phiên bản Datastore Model, bạn không thể sử dụng json.dumps (chưa thử nghiệm nhưng Lorenzo đã chỉ ra). Có thể trong tương lai những điều sau sẽ hiệu quả.

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)