我正在尝试在Flask / Python中jsonify一个SQLAlchemy结果集。
Flask邮件列表提出了以下方法http://librelist.com/browser//flask/2011/2/16/jsonify-sqlalchemy-pagination-collection-result/#04a0754b63387f87e59dda564bde426e:
return jsonify(json_list = qryresult)
但是我收到了以下错误:
TypeError: <flaskext.sqlalchemy.BaseQuery object at 0x102c2df90>
is not JSON serializable
我在这里俯瞰什么?
我发现了这个问题:How to serialize SqlAlchemy result to JSON?看起来非常相似但是我不知道Flask是否有一些神奇的功能可以让邮件列表的帖子变得更容易。
编辑:为了澄清,这就是我的模型的样子
class Rating(db.Model):
__tablename__ = 'rating'
id = db.Column(db.Integer, primary_key=True)
fullurl = db.Column(db.String())
url = db.Column(db.String())
comments = db.Column(db.Text)
overall = db.Column(db.Integer)
shipping = db.Column(db.Integer)
cost = db.Column(db.Integer)
honesty = db.Column(db.Integer)
communication = db.Column(db.Integer)
name = db.Column(db.String())
ipaddr = db.Column(db.String())
date = db.Column(db.String())
def __init__(self, fullurl, url, comments, overall, shipping, cost, honesty, communication, name, ipaddr, date):
self.fullurl = fullurl
self.url = url
self.comments = comments
self.overall = overall
self.shipping = shipping
self.cost = cost
self.honesty = honesty
self.communication = communication
self.name = name
self.ipaddr = ipaddr
self.date = date
答案 0 :(得分:151)
您似乎确实没有执行过查询。请尝试以下方法:
return jsonify(json_list = qryresult.all())
[编辑] :jsonify问题是,通常对象无法自动进行jsonified。甚至Python的日期时间都失败了;)
我通常做的是在需要序列化的类中添加一个额外的属性(如serialize
):
def dump_datetime(value):
"""Deserialize datetime object into string form for JSON processing."""
if value is None:
return None
return [value.strftime("%Y-%m-%d"), value.strftime("%H:%M:%S")]
class Foo(db.Model):
# ... SQLAlchemy defs here..
def __init__(self, ...):
# self.foo = ...
pass
@property
def serialize(self):
"""Return object data in easily serializable format"""
return {
'id' : self.id,
'modified_at': dump_datetime(self.modified_at),
# This is an example how to deal with Many2Many relations
'many2many' : self.serialize_many2many
}
@property
def serialize_many2many(self):
"""
Return object's relations in easily serializable format.
NB! Calls many2many's serialize property.
"""
return [ item.serialize for item in self.many2many]
现在我可以这样做:
return jsonify(json_list=[i.serialize for i in qryresult.all()])
希望这会有所帮助;)
答案 1 :(得分:35)
我有同样的需要,序列化为json。看看this question。它显示了如何以编程方式发现列。所以,从那以后我创建了下面的代码。它适用于我,我将在我的网络应用程序中使用它。快乐的编码!
def to_json(inst, cls):
"""
Jsonify the sql alchemy query result.
"""
convert = dict()
# add your coversions for things like datetime's
# and what-not that aren't serializable.
d = dict()
for c in cls.__table__.columns:
v = getattr(inst, c.name)
if c.type in convert.keys() and v is not None:
try:
d[c.name] = convert[c.type](v)
except:
d[c.name] = "Error: Failed to covert using ", str(convert[c.type])
elif v is None:
d[c.name] = str()
else:
d[c.name] = v
return json.dumps(d)
class Person(base):
__tablename__ = 'person'
id = Column(Integer, Sequence('person_id_seq'), primary_key=True)
first_name = Column(Text)
last_name = Column(Text)
email = Column(Text)
@property
def json(self):
return to_json(self, self.__class__)
答案 2 :(得分:32)
这对我来说通常是足够的:
我创建了一个序列化mixin,我和我的模型一起使用。序列化函数基本上获取SQLAlchemy检查器公开的任何属性并将其放入dict中。
from sqlalchemy.inspection import inspect
class Serializer(object):
def serialize(self):
return {c: getattr(self, c) for c in inspect(self).attrs.keys()}
@staticmethod
def serialize_list(l):
return [m.serialize() for m in l]
现在需要的是使用Serializer
mixin类扩展SQLAlchemy模型。
如果您不想公开或需要特殊格式的字段,只需覆盖模型子类中的serialize()
函数。
class User(db.Model, Serializer):
id = db.Column(db.Integer, primary_key=True)
username = db.Column(db.String)
password = db.Column(db.String)
# ...
def serialize(self):
d = Serializer.serialize(self)
del d['password']
return d
在您的控制器中,您所要做的就是在结果上调用serialize()
函数(或serialize_list(l)
,如果查询结果列表中):
def get_user(id):
user = User.query.get(id)
return json.dumps(user.serialize())
def get_users():
users = User.query.all()
return json.dumps(User.serialize_list(users))
答案 3 :(得分:16)
这是我的方法: https://github.com/n0nSmoker/SQLAlchemy-serializer
pip install SQLAlchemy-serializer
您可以轻松地将mixin添加到模型中,而不仅仅是调用 它的实例上的.to_dict()方法
您也可以在SerializerMixin
的基础上编写自己的mixin答案 4 :(得分:4)
对于平面查询(无连接),您可以执行此操作
@app.route('/results/')
def results():
data = Table.query.all()
result = [d.__dict__ for d in data]
return jsonify(result=result)
如果您只想从数据库中返回某些列,则可以执行此操作
@app.route('/results/')
def results():
cols = ['id', 'url', 'shipping']
data = Table.query.all()
result = [{col: getattr(d, col) for col in cols} for d in data]
return jsonify(result=result)
答案 5 :(得分:4)
好的,我已经为此工作了几个小时,而且我已经开发出了我认为最狡猾的解决方案。以下代码片段是python3,但如果您需要,则不应该过于痛苦地回溯。
我们要做的第一件事就是从一个mixin开始,让你的db模型有点像dict
s:
from sqlalchemy.inspection import inspect
class ModelMixin:
"""Provide dict-like interface to db.Model subclasses."""
def __getitem__(self, key):
"""Expose object attributes like dict values."""
return getattr(self, key)
def keys(self):
"""Identify what db columns we have."""
return inspect(self).attrs.keys()
现在我们要定义我们的模型,继承mixin:
class MyModel(db.Model, ModelMixin):
id = db.Column(db.Integer, primary_key=True)
foo = db.Column(...)
bar = db.Column(...)
# etc ...
能够将MyModel()
的实例传递给dict()
并从中获取一个真实的dict
实例所需的一切,这让我们非常了解让jsonify()
了解它的漫长道路。接下来,我们需要扩展JSONEncoder
以便让我们完成其余的工作:
from flask.json import JSONEncoder
from contextlib import suppress
class MyJSONEncoder(JSONEncoder):
def default(self, obj):
# Optional: convert datetime objects to ISO format
with suppress(AttributeError):
return obj.isoformat()
return dict(obj)
app.json_encoder = MyJSONEncoder
奖励积分:如果您的模型包含计算字段(也就是说,您希望JSON输出包含实际存储在数据库中的字段),那也很容易。只需将计算字段定义为@property
s,然后像{so}那样扩展keys()
方法:
class MyModel(db.Model, ModelMixin):
id = db.Column(db.Integer, primary_key=True)
foo = db.Column(...)
bar = db.Column(...)
@property
def computed_field(self):
return 'this value did not come from the db'
def keys(self):
return super().keys() + ['computed_field']
现在,jsonify是微不足道的:
@app.route('/whatever', methods=['GET'])
def whatever():
return jsonify(dict(results=MyModel.query.all()))
答案 6 :(得分:4)
如果您使用的是flask-restful
,则可以使用marshal:
from flask.ext.restful import Resource, fields, marshal
topic_fields = {
'title': fields.String,
'content': fields.String,
'uri': fields.Url('topic'),
'creator': fields.String,
'created': fields.DateTime(dt_format='rfc822')
}
class TopicListApi(Resource):
def get(self):
return {'topics': [marshal(topic, topic_fields) for topic in DbTopic.query.all()]}
你需要明确列出你要返回的内容以及它的类型,我更喜欢api。序列化很容易处理(不需要jsonify
),日期也不是问题。请注意,uri
字段的内容是根据topic
端点和ID自动生成的。
答案 7 :(得分:2)
我一直在寻找这个问题的一天中的大部分时间,这就是我想出的结果(归功于https://stackoverflow.com/a/5249214/196358指出我朝这个方向发展)。
(注意:我正在使用flask-sqlalchemy,所以我的模型声明格式与直接sqlalchemy略有不同)。
在我的models.py
文件中:
import json
class Serializer(object):
__public__ = None
"Must be implemented by implementors"
def to_serializable_dict(self):
dict = {}
for public_key in self.__public__:
value = getattr(self, public_key)
if value:
dict[public_key] = value
return dict
class SWEncoder(json.JSONEncoder):
def default(self, obj):
if isinstance(obj, Serializer):
return obj.to_serializable_dict()
if isinstance(obj, (datetime)):
return obj.isoformat()
return json.JSONEncoder.default(self, obj)
def SWJsonify(*args, **kwargs):
return current_app.response_class(json.dumps(dict(*args, **kwargs), cls=SWEncoder, indent=None if request.is_xhr else 2), mimetype='application/json')
# stolen from https://github.com/mitsuhiko/flask/blob/master/flask/helpers.py
我的所有模型对象都是这样的:
class User(db.Model, Serializer):
__public__ = ['id','username']
... field definitions ...
在我的观点中,无论我在哪里呼叫Jsonify
,我都会调用SWJsonify,如下所示:
@app.route('/posts')
def posts():
posts = Post.query.limit(PER_PAGE).all()
return SWJsonify({'posts':posts })
似乎工作得很好。甚至在关系上。我没有得到它,所以YMMV,但到目前为止,它对我来说感觉非常“正确”。
建议欢迎。
答案 8 :(得分:1)
这是一种在每个类上添加as_dict()方法的方法,以及您希望在每个类上使用的任何其他方法。 不确定这是否是理想的方式,但它有效...
class Base(object):
def as_dict(self):
return dict((c.name,
getattr(self, c.name))
for c in self.__table__.columns)
Base = declarative_base(cls=Base)
答案 9 :(得分:1)
我正在寻找像ActiveRecord to_json中使用的rails方法之类的东西,并在对其他建议不满意之后使用此Mixin实现类似的东西。它处理嵌套模型,包括或排除顶级或嵌套模型的属性。
class Serializer(object):
def serialize(self, include={}, exclude=[], only=[]):
serialized = {}
for key in inspect(self).attrs.keys():
to_be_serialized = True
value = getattr(self, key)
if key in exclude or (only and key not in only):
to_be_serialized = False
elif isinstance(value, BaseQuery):
to_be_serialized = False
if key in include:
to_be_serialized = True
nested_params = include.get(key, {})
value = [i.serialize(**nested_params) for i in value]
if to_be_serialized:
serialized[key] = value
return serialized
然后,为了获得BaseQuery可序列化,我扩展了BaseQuery
class SerializableBaseQuery(BaseQuery):
def serialize(self, include={}, exclude=[], only=[]):
return [m.serialize(include, exclude, only) for m in self]
以下型号
class ContactInfo(db.Model, Serializer):
id = db.Column(db.Integer, primary_key=True)
user_id = db.Column(db.Integer, db.ForeignKey('user.id'))
full_name = db.Column(db.String())
source = db.Column(db.String())
source_id = db.Column(db.String())
email_addresses = db.relationship('EmailAddress', backref='contact_info', lazy='dynamic')
phone_numbers = db.relationship('PhoneNumber', backref='contact_info', lazy='dynamic')
class EmailAddress(db.Model, Serializer):
id = db.Column(db.Integer, primary_key=True)
email_address = db.Column(db.String())
type = db.Column(db.String())
contact_info_id = db.Column(db.Integer, db.ForeignKey('contact_info.id'))
class PhoneNumber(db.Model, Serializer):
id = db.Column(db.Integer, primary_key=True)
phone_number = db.Column(db.String())
type = db.Column(db.String())
contact_info_id = db.Column(db.Integer, db.ForeignKey('contact_info.id'))
phone_numbers = db.relationship('Invite', backref='phone_number', lazy='dynamic')
您可以执行类似
的操作@app.route("/contact/search", methods=['GET'])
def contact_search():
contact_name = request.args.get("name")
matching_contacts = ContactInfo.query.filter(ContactInfo.full_name.like("%{}%".format(contact_name)))
serialized_contact_info = matching_contacts.serialize(
include={
"phone_numbers" : {
"exclude" : ["contact_info", "contact_info_id"]
},
"email_addresses" : {
"exclude" : ["contact_info", "contact_info_id"]
}
}
)
return jsonify(serialized_contact_info)
答案 10 :(得分:1)
pip install asgiref==1.0.0
Flask-Restful
the Request Parsing推荐棉花糖
棉花糖是用于转换的ORM / ODM /框架无关的库 往返于本机Python的复杂数据类型,例如对象 数据类型。
下面显示了一个简单的marshmallow示例。
0.3.6
核心功能包含
声明架构
序列化对象(“转储”)
反序列化对象(“加载”)
处理对象集合
验证
指定属性名称
指定序列化/反序列化键
重构:隐式字段创建
订购输出
“只读”和“仅写”字段
指定默认的序列化/反序列化值
嵌套架构
自定义字段
答案 11 :(得分:0)
我正在使用名为jobDict的RowProxy对象列表的sql查询defaultdict 我花了一段时间才弄清楚对象的类型。
这是一种非常简单的快速方法,可以通过将行类型转换为列表并最初使用list值定义dict来解析一些干净的jsonEncoding。
jobDict = defaultdict(list)
def set_default(obj):
# trickyness needed here via import to know type
if isinstance(obj, RowProxy):
return list(obj)
raise TypeError
jsonEncoded = json.dumps(jobDict, default=set_default)
答案 12 :(得分:0)
我只是想添加我的方法来做到这一点。
只需定义一个custome json编码器来对您的数据库模型进行serilize。
class ParentEncoder(json.JSONEncoder):
def default(self, obj):
# convert object to a dict
d = {}
if isinstance(obj, Parent):
return {"id": obj.id, "name": obj.name, 'children': list(obj.child)}
if isinstance(obj, Child):
return {"id": obj.id, "name": obj.name}
d.update(obj.__dict__)
return d
然后在你的视图功能
parents = Parent.query.all()
dat = json.dumps({"data": parents}, cls=ParentEncoder)
resp = Response(response=dat, status=200, mimetype="application/json")
return (resp)
尽管父母有关系
,但效果很好答案 13 :(得分:0)
如果你正在使用声明性基础(在已发布的一些答案的帮助下),我的回答是:
# in your models definition where you define and extend declarative_base()
from sqlalchemy.ext.declarative import declarative_base
...
Base = declarative_base()
Base.query = db_session.query_property()
...
# define a new class (call "Model" or whatever) with an as_dict() method defined
class Model():
def as_dict(self):
return { c.name: getattr(self, c.name) for c in self.__table__.columns }
# and extend both the Base and Model class in your model definition, e.g.
class Rating(Base, Model):
____tablename__ = 'rating'
id = db.Column(db.Integer, primary_key=True)
fullurl = db.Column(db.String())
url = db.Column(db.String())
comments = db.Column(db.Text)
...
# then after you query and have a resultset (rs) of ratings
rs = Rating.query.all()
# you can jsonify it with
s = json.dumps([r.as_dict() for r in rs], default=alchemyencoder)
print (s)
# or if you have a single row
r = Rating.query.first()
# you can jsonify it with
s = json.dumps(r.as_dict(), default=alchemyencoder)
# you will need this alchemyencoder where your are calling json.dumps to handle datetime and decimal format
# credit to Joonas @ http://codeandlife.com/2014/12/07/sqlalchemy-results-to-json-the-easy-way/
def alchemyencoder(obj):
"""JSON encoder function for SQLAlchemy special classes."""
if isinstance(obj, datetime.date):
return obj.isoformat()
elif isinstance(obj, decimal.Decimal):
return float(obj)
答案 14 :(得分:-1)
这已经很多次并且有很多有效的答案,但以下代码块似乎有效:
my_object = SqlAlchemyModel()
my_serializable_obj = my_object.__dict__
del my_serializable_obj["_sa_instance_state"]
print(jsonify(my_serializable_object))
我知道这不是一个完美的解决方案,也不像其他人那样优雅,但对于那些想要快速修复的人来说,他们可能会尝试这个。