Несоответствие порядка ключей JSON при использовании «json.dumps»

В Python преобразование JSON часто влечет за собой использование «json.dumps» для преобразования словари в объекты JSON. Однако пользователи могут столкнуться с несоответствиями в результирующем порядке ключей JSON, при этом ожидаемая последовательность (идентификатор, имя, часовой пояс) отличается от фактического результата (часовой пояс, идентификатор, имя).

Чтобы решить эту проблему и обеспечить соблюдение желаемый порядок ключей, доступны два подхода:

1. Использование параметра sort_keys:

Параметр sort_keys, если для него установлено значение True, ключи JSON сортируются в алфавитном порядке. Например, следующий фрагмент кода даст желаемый порядок ключей:

import json

countries = []
countries.append({"id": 1, "name": "Mauritius", "timezone": 4})
countries.append({"id": 2, "name": "France", "timezone": 2})
countries.append({"id": 3, "name": "England", "timezone": 1})
countries.append({"id": 4, "name": "USA", "timezone": -4})

json_data = json.dumps(countries, sort_keys=True)
print(json_data)

2. Использование OrderedDict:

В Python "collections.OrderedDict" сохраняется порядок вставки ключей. Используя OrderedDict, можно добиться ожидаемого порядка ключей:

from collections import OrderedDict

countries = OrderedDict()
countries["id"] = 1
countries["name"] = "Mauritius"
countries["timezone"] = 4

json_data = json.dumps(countries)
print(json_data)

В Python 3.6 и более поздних версиях порядок аргументов ключевого слова сохраняется по умолчанию, что позволяет использовать более краткий синтаксис:

json_data = json.dumps(OrderedDict(id=1, name="Mauritius", timezone=4))
print(json_data)

Наконец, для ввода JSON параметр «object_pair_hook» можно использовать для сохранения порядка объектов и создания OrderedDict:

import json

json_data = json.loads('{"id": 1, "name": "Mauritius", "timezone": 4}', object_pairs_hook=OrderedDict)
print(json_data)