python - Flask:将 Python dict 转换为客户端 api 的 json 对象

Question

我需要从一个查询结果的 flask 中创建一个 json 对象。然后我需要将 json 对象传递给路由以创建 API。

在寻找一些巧妙的方法来从我的实例中创建字典时，我偶然发现了这个 post 中的一个方法。使用实例的内部字典并将 jsond 方法添加到模型类。这是带有自定义方法“jsond”的模型:

from app import db  
class Rest(db.Model):
    id = db.Column(db.Integer, primary_key = True)
    name = db.Column(db.String(100), unique = True)
    street = db.Column(db.Text)
    zipcd = db.Column(db.Integer)
    comments = db.relationship('Comment', backref='rest', lazy='dynamic')
    lat = db.Column(db.Float(6))
    lng = db.Column(db.Float(6))

    def __init__(self,name,street,zipcd):
        self.name = name
        self.street = street
        self.zipcd = zipcd

    def __repr__(self):
        return '{}'.format(self.name)

    def name_slug(self):
        return self.name

    def jsond(self):
        instDict = self.__dict__.copy()
        if instDict.has_key('_sa_instance_state'):
            del instDict['_sa_instance_state']
        return instDict

这是我的 View 函数:

from app import app, db
from flask import render_template, flash, redirect, session, url_for, request, g,      jsonify, make_response
from flask.json import dumps
from flask.ext import restful 
from flask.ext.httpauth import HTTPBasicAuth
from models import Comment, Rest, Badge
from helper import make_badges, make_inspections, loc_query
import operator
auth = HTTPBasicAuth()

@app.route('/api',methods=['GET'])
def makeApi():

    ###Query Parameters###
    lim = request.args.get('limit', 10)
    off = request.args.get('offset', 0)
    loc = request.args.get('location', "39.94106,-75.173192")
    lat, lng = loc.split(",")
    radius = request.args.get('radius',2)

    query = loc_query(lat,lng,radius,off,lim)

    results = Rest.query.from_statement(query).all()


    rest_json = []
    for rest in results:
        rest_json.append(rest.jsond())

    return make_response(jsonify({'count':len(rest_json),'rests':rest_json}))

因此，当在 python API 命令行中时，我可以成功运行查询并从查询中的特定实例创建一个包含所有字段的字典(使用自定义 jsond 方法)。但是，当我使用我的 View 转到 makeApi 路由时，我得到一个只有“id”字段的 json 对象:

rests: [
{
id: 28450
},
{
id: 28795
},
{
id: 30439
},
{
id: 29325
},
{
id: 29765
},
{
id: 29928
},
{
id: 30383
},
{
id: 29064
},
{
id: 29862
},
{
id: 28610
}
]
}

我一直在兜圈子几个小时，不知道为什么 View 行为会与 python API 不同。也许是我在 jsonify 上做错了什么，但我不这么认为。

Answer 1

一般来说，您对模型进行 jsonifying 的方法是个坏主意:

• self.__dict__ 可能包含很多未记录的键
• 列类型:您不能直接对 关系 和列类型进行 jsonify。尤其是 datetime 列。
• 安全性:有时您可能想隐藏一些字段(例如，对于使用您的 API 的不受信任的用户)

一个好的方法是创建一个方法来返回一个 json 可序列化字典:

class Foo(db.Model):
    field1 = db.Column(...)
    field2 = db.Column(...)

    def as_dict(self):
        obj_d = {
            'field1': self.field1,
            'field2': self.field2,
            ...
        }
        return obj_d

那么在你看来:

foos = Foo.query.all()
results = [ foo.as_dict() for foo in foos ]

return jsonify({count: len(results), results: results)

根据您的应用程序，您可以通过将字段(尤其是日期时间字段)转换为 javascript 友好格式或添加方便的字段(如关注关系)来使 as_dict 更智能。