如何在Flask中将列表转换为JSON格式？

Question

目前Flask在将列表(JSONify)时会抛出错误。

我知道这可能是出于安全原因https://github.com/mitsuhiko/flask/issues/170，但我仍然希望有一种方法可以返回以下JSON列表：

[
    {'a': 1, 'b': 2},
    {'a': 5, 'b': 10}
]

取代

{ 'results': [
    {'a': 1, 'b': 2},
    {'a': 5, 'b': 10}
]}

当响应一个application/json请求时，我该如何使用Jsonify在Flask中返回一个JSON列表？

- hllau

---

这不再是一个安全问题，但始终将返回一个字典视为最佳实践。：https://softwareengineering.stackexchange.com/a/304638/369319 - Noan Cloarec

Answer 1

你不能这样做，但你仍然可以像这样做。我需要这个功能来使用jQuery-File-Upload插件。

import json
# get this object
from flask import Response

#example data:

    js = [ { "name" : filename, "size" : st.st_size , 
        "url" : url_for('show', filename=filename)} ]
#then do this
    return Response(json.dumps(js),  mimetype='application/json')

- mianos

---

还有 flask.json.dumps，不知道这是否比 json.dumps 更好。 - Cameron White

flask.json 是 try: import simplejson as json; except ImportError: import json 的简写形式。 - Ewan

+1 对于 mimetype='application/json'，帮我省去了寻找相关标头的麻烦 :) - Shmil The Cat

有趣的是，我在完全相同的情况下（jQuery文件上传）也遇到了这个问题，而你的代码还帮助了我解决另一个问题。 - deweydb

我最喜欢这个答案。从我的经验来看，Response() 比 make_response() 更简单地公开了 mimetype，而仅仅使用 return json.dumps() 不会设置任何头信息。 - sofly

Answer 2

jsonify 在 Flask 0.10 及以下版本中被禁用，出于安全原因。

但您仍然可以使用 Python 标准库中的 json.dumps 来实现相同的功能。

http://docs.python.org/library/json.html#json.dumps

- FogleBird

---

这样做，我需要手动设置头部的 Content-Type 吗？ - hllau

是的，application/json。 - FogleBird

@FogleBird，是哪方面的安全原因？ - Jocelyn delalande

@Jocelyndelalande：http://flask.pocoo.org/docs/0.10/security/#json-security这个网页介绍了在使用Flask框架时如何安全地处理JSON数据，包括如何防止JSON劫持攻击和如何正确地限制JSON大小。为了保护应用程序的安全性，建议开发人员仔细阅读并严格遵循这些指南。 - David Röthlisberger

安全性不再是一个有效的问题，因此Flask的jsonify现在支持转储列表：https://dev59.com/wmcs5IYBdhLWcg3w-Yr4#35000418 - Jeff Widman

Answer 3

这对我有效。你使用的是哪个版本的Flask？

from flask import jsonify

...

@app.route('/test/json')
def test_json():
    list = [
            {'a': 1, 'b': 2},
            {'a': 5, 'b': 10}
           ]
    return jsonify(results = list)

- Geordee Naliyath

---

我正在使用 Flask 0.9，但似乎输出的是哈希 JSON 而不是列表 JSON。 - hllau

不建议使用list作为变量标识符。 - TMOTTM

Answer 4

Flask的jsonify()方法现在可以序列化顶层数组，自Flask 0.11版本起，可使用此提交。

为了方便起见，您可以传入一个Python列表：jsonify([1,2,3]) 或传入一系列的args: jsonify(1,2,3) 两者都将被序列化为JSON顶级数组：[1,2,3] 详情请参阅：https://flask.palletsprojects.com/en/2.2.x/api/?highlight=jsonify#flask.json.jsonify**

- Jeff Widman

Answer 5

解决了，非常简单。您可以懒一点，使用 jsonify ，只需传入 items=[your list] 即可。请查看这里的解决方案。 https://github.com/mitsuhiko/flask/issues/510

- stonefury

Answer 6

在Flask中，可以使用jsonify轻松将列表转换为JSON格式，例如：

from flask import Flask,jsonify
app = Flask(__name__)

tasks = [
    {
        'id':1,
        'task':'this is first task'
    },
    {
        'id':2,
        'task':'this is another task'
    }
]

@app.route('/app-name/api/v0.1/tasks',methods=['GET'])
def get_tasks():
    return jsonify({'tasks':tasks})  #will return the json

if(__name__ == '__main__'):
    app.run(debug = True)

- Hiro

---

jsonify({'tasks': tasks}) 工作得非常完美，这绝对为我节省了很多时间。 - A Star

Answer 7

josonify工作正常... 但是如果你只想传递一个没有'results'键的数组，你可以使用Python的JSON库。以下转换对我有效。

import json

@app.route('/test/json')
def test_json():
    mylist = [
        {'a': 1, 'b': 2},
        {'a': 5, 'b': 10}
        ]
    return json.dumps(mylist)

- Madhan Ganesh

---

我认为这应该是被接受的答案，因为它是唯一返回正确数据结构的答案。非常感谢。 - G M

Answer 8

如果您正在搜索如何在Flask中返回JSON列表，并且您完全确定您的变量是一个列表，那么简单的方法是（其中bin是一个由1和0组成的列表）：

   return jsonify({'ans':bin}), 201

最后，在您的客户端中，您将获得类似于以下内容：

{ "ans": [ 0.0, 0.0, 1.0, 1.0, 0.0 ] }

- Yor Jaggy