MongoAlchemy Documento Codifica in JSON tramite Flask-MongoAlchemy

Question

Penso che mi manca qualcosa di piccolo qui. Sto verificando fuori Python quadro Flask e Flask-MongoAlchemy, e si desidera convertire un'entità in uscita JSON. Qui è il mio codice (astratta):

from flask import Flask
from flaskext.mongoalchemy import MongoAlchemy

try:
    from bson.objectid import ObjectId
except:
    pass

#a bunch of code to open the mongoDB

class ClassA(db.Document):
    title = db.StringField()
    field1 = db.StringField()
    field2 = db.BoolField()

@app.route('/api/classA', methods=['GET'])
def api_list_all
    a = ClassA.query.all()
    result = []
    for b in a:
        result.append(b.wrap())
    print result
    return json.dumps(result)

Senza la linea di json.dumps, l'istruzione di stampa pronta il risultato giusto. Ma solo se mi imbatto le json.dumps sul risultato, se ne ricava:

TypeError: ObjectId ( '...') non è JSON serializzabile

Che cosa mi manca?

Answer 1

Il risultato è un documento Mongo di qualche tipo che contiene il contenuto ObjectId-tipo, che si dovrà dire a JSON come deserializzare. Avrete lo stesso problema con altri tipi di Mongo-specifici, come ReferenceField (), EmbeddedDocumentField (), etc. Devi scrivere una funzione di deserializzazione che è possibile passare a JSON. Quello che uso è:

def encode_model(obj, recursive=False):
    if obj is None:
        return obj
    if isinstance(obj, (mongoengine.Document, mongoengine.EmbeddedDocument)):
        out = dict(obj._data)
        for k,v in out.items():
            if isinstance(v, ObjectId):
                if k is None:
                    out['_id'] = str(v)
                    del(out[k])
                else:
                    # Unlikely that we'll hit this since ObjectId is always NULL key
                    out[k] = str(v)
            else:
                out[k] = encode_model(v)
    elif isinstance(obj, mongoengine.queryset.QuerySet):
        out = encode_model(list(obj))
    elif isinstance(obj, ModuleType):
        out = None
    elif isinstance(obj, groupby):
        out = [ (g,list(l)) for g,l in obj ]
    elif isinstance(obj, (list)):
        out = [encode_model(item) for item in obj]
    elif isinstance(obj, (dict)):
        out = dict([(k,encode_model(v)) for (k,v) in obj.items()])
    elif isinstance(obj, datetime.datetime):
        out = str(obj)
    elif isinstance(obj, ObjectId):
        out = {'ObjectId':str(obj)}
    elif isinstance(obj, (str, unicode)):
        out = obj
    elif isinstance(obj, float):
        out = str(obj)
    else:
        raise TypeError, "Could not JSON-encode type '%s': %s" % (type(obj), str(obj))
    return out

Poi si sarebbe elaborare il risultato come:

return json.dumps(result, default=encode_model)

o qualcosa in tal senso.

Answer 2

Si può anche utilizzare il metodo query.raw_output() avere quella di ritorno esempio di query prime dizionari Python invece di un oggetto Python. Con un dizionario diventa facile codificare a JSON utilizzando json.dumps():

import json
q=db.query(MyObject)
q.raw_output()
json.dumps(q.first())

http://www.mongoalchemy.org /api/expressions/query.html#mongoalchemy.query.Query.raw_output

Answer 3

La combinazione dei due precedenti risposte, si dovrebbe essere in grado di fare qualcosa di simile:

from bson import json_util

# ... 

@app.route('/api/classA', methods=['GET'])
def api_list_all
    a = ClassA.query.all()
    result = []
    for b in a:
        result.append(b.wrap())
    print result
    return json_utils.dumps(result) # Change here.