[英]Flask jsonify a list of objects
我有一个需要 jsonify 的对象列表。 我看过烧瓶 jsonify 文档,但我只是不明白。
我的班级有几个 inst-var,每个都是一个字符串: gene_id
、 gene_symbol
、 p_value
。 我需要做什么才能将此序列化为 JSON?
我的天真代码:
jsonify(eqtls = my_list_of_eqtls)
结果是:
TypeError: <__main__.EqtlByGene object at 0x1073ff790> is not JSON serializable
大概我必须告诉 jsonify 如何序列化EqtlByGene
,但我找不到显示如何序列化类实例的示例。
我一直在尝试按照下面显示的一些建议来创建我自己的 JSONEncoder 子类。 我的代码现在是:
class EqtlByGene(Resource):
def __init__(self, gene_id, gene_symbol, p_value):
self.gene_id = gene_id
self.gene_symbol = gene_symbol
self.p_value = p_value
class EqtlJSONEncoder(JSONEncoder):
def default(self, obj):
if isinstance(obj, EqtlByGene):
return {
'gene_id' : obj.gene_id,
'gene_symbol' : obj.gene_symbol,
'p_value' : obj.p_value
}
return super(EqtlJSONEncoder, self).default(obj)
class EqtlByGeneList(Resource):
def get(self):
eqtl1 = EqtlByGene(1, 'EGFR', 0.1)
eqtl2 = EqtlByGene(2, 'PTEN', 0.2)
eqtls = [eqtl1, eqtl2]
return jsonify(eqtls_by_gene = eqtls)
api.add_resource(EqtlByGeneList, '/eqtl/eqtlsbygene')
app.json_encoder(EqtlJSONEncoder)
if __name__ == '__main__':
app.run(debug=True)
当我尝试通过 curl 到达它时,我得到:
TypeError(repr(o) + " is not JSON serializable")
为您的EqltByGene
一个返回字典的额外方法:
class EqltByGene(object):
#
def serialize(self):
return {
'gene_id': self.gene_id,
'gene_symbol': self.gene_symbol,
'p_value': self.p_value,
}
然后使用列表理解将对象列表转换为可序列化值列表:
jsonify(eqtls=[e.serialize() for e in my_list_of_eqtls])
另一种方法是为json.dumps()
函数编写一个钩子函数,但由于您的结构相当简单,列表理解和自定义方法方法更简单。
你也可以非常喜欢冒险并flask.json.JSONEncoder
; 给它一个default()
方法,将您的EqltByGene()
实例转换为可序列化的值:
from flask.json import JSONEncoder
class MyJSONEncoder(JSONEncoder):
def default(self, obj):
if isinstance(obj, EqltByGene):
return {
'gene_id': obj.gene_id,
'gene_symbol': obj.gene_symbol,
'p_value': obj.p_value,
}
return super(MyJSONEncoder, self).default(obj)
并将其分配给app.json_encoder
属性:
app = Flask(__name__)
app.json_encoder = MyJSONEncoder
并将您的列表直接传递给jsonify()
:
return jsonify(my_list_of_eqtls)
您还可以查看Marshmallow 项目以获得更成熟和灵活的项目,用于将对象序列化和反序列化为 Python 原语,可轻松适应 JSON 和其他此类格式; 例如:
from marshmallow import Schema, fields
class EqltByGeneSchema(Schema):
gene_id = fields.Integer()
gene_symbol = fields.String()
p_value = fields.Float()
然后使用
jsonify(eqlts=EqltByGeneSchema().dump(my_list_of_eqtls, many=True)
生成 JSON 输出。 相同的模式可用于验证传入的 JSON 数据和(使用适当的额外方法),用于再次生成EqltByGene
实例。
如果您查看json
模块的文档,它会提到您可以JSONEncoder
以覆盖其default
方法并在那里添加对类型的支持。 如果您要序列化可能包含您的对象的多个不同结构,那将是最通用的处理方式。
如果您想使用jsonify
,提前将您的对象转换为简单类型可能更容易(例如,通过在类上定义您自己的方法,正如 Martijn 建议的那样)。
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.