Flaskで辞書型の要素の順番が維持されない

実現したいこと

Flaskの辞書型の要素の順番を維持したい。

実行環境　

Python: 3.11.1
Flask:2.3.2

発生している問題・エラーメッセージ

Flask:app.py
1@app.get('/test')
2def test():
3    return {
4        'title': 'タイトル',
5        'content': 'コンテント'
6}

上のコードを作成し、そのURLをたたくと

{
    "content": "コンテンツ",
    "title": "タイトル222"
}

上のような戻り値が返ってきます。しかしながら、ソースコード上は戻り値を
title,contentの順番で並べているにも関わらず、APIをたたいた時のレスポンスでは
content,titleの順番になってしまいます。

試したこと

下記のようにOrderedDictを使用したものも作成してみましたが、通常の辞書を使用したものと同様に順番がくるっていました。

Flask:app.py
1from collections import OrderedDict
2
3@app.get('/test')
4def test():
5    dict = OrderedDict()
6    dict['title'] = 'タイトル222'
7    dict['content'] = 'コンテンツ'
8    return dict

以上、解決方法がお分かりになるかた、情報をご提供いただけると助かります。

melian

2023/06/08 05:37

参考情報。 how to keep order of sorted dictionary passed to jsonify() function? https://stackoverflow.com/a/60780210

行動規範の内容に同意します

回答3件

ベストアンサー

https://flask.palletsprojects.com/en/2.3.x/api/#flask.json.provider.DefaultJSONProvider.sort_keys
DefaultJSONProviderでsort_keysがTrueにしてあるからですね。データとして等価なので、順番を気にする方がおかしくて、これで問題になることはないです。（問題が起きるならどこかでJSONの仕様が無視されている）

https://flask.palletsprojects.com/en/2.3.x/changes/#version-2-3-0

The JSON_AS_ASCII, JSON_SORT_KEYS, JSONIFY_MIMETYPE, and JSONIFY_PRETTYPRINT_REGULAR config keys are removed.

https://flask.palletsprojects.com/en/2.3.x/config/?highlight=json_sort_keys#MAX_COOKIE_SIZE

Changed in version 2.3: JSON_AS_ASCII, JSON_SORT_KEYS, JSONIFY_MIMETYPE, and JSONIFY_PRETTYPRINT_REGULAR were removed. The default app.json provider has equivalent attributes instead.

なので Flask2.3以降だとappの初期化時に