有沒有一種優雅的方法可以使用 django 序列化程序來展平嵌套的 JSON？

Question

我從 API 收到嵌套的 JSON（我無法影響結構）。 我想在反序列化對象時展平嵌套字段，使用 django rest framework serializer 。 我該如何優雅地做到這一點？

這是我目前的方法，它通過使用嵌套序列化程序並在.create()中進行.create()平來工作：

from dataclasses import dataclass

from rest_framework import serializers

input_data = {
    "objectName": "Johnny",
    "geoInfo": {
        "latitude": 1.2,
        "longitude": 3.4,
    },
}

flattened_output = {
    "name": "Johnny",
    "lat": 1.2,
    "lon": 3.4,
}


@dataclass
class Thing:
    name: str
    lat: float
    lon: float


class TheFlattener(serializers.Serializer):
    class GeoInfoSerializer(serializers.Serializer):
        latitude = serializers.FloatField()
        longitude = serializers.FloatField()

    objectName = serializers.CharField(max_length=50, source="name")
    geoInfo = GeoInfoSerializer()

    def create(self, validated_data):
        geo_info = validated_data.pop("geoInfo")
        validated_data["lat"] = geo_info["latitude"]
        validated_data["lon"] = geo_info["longitude"]
        return Thing(**validated_data)


serializer = TheFlattener(data=input_data)
serializer.is_valid(raise_exception=True)
assert serializer.save() == Thing(**flattened_output)

我知道在將對象序列化為 JSON 時，您可以在source參數中引用嵌套/相關對象，例如

first_name = CharField(source="user.first_name")

這真的很好，但我一直沒能找到類似的反序列化的東西。

Answer 1

對於您的情況，我認為您的解決方案非常優雅，因為您想更改字段名稱，而不僅僅是將其展平。

但是，對於較大的嵌套 Json，您可以定義一個扁平化函數（遞歸/迭代），或者使用 Pandas 庫中的一些有用工具，例如：

pandas.json_normalize和 pandas.DataFrame。 to_dict/to_json

https://pandas.pydata.org/pandas-docs/version/1.2.0/reference/api/pandas.json_normalize.html

https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.to_dict.html

選項1

from pandas import json_normalize

input_data = {
    "objectName": "Johnny",
    "geoInfo": {
        "latitude": 1.2,
        "longitude": 3.4,
    },
}

d = json_normalize(input_data).to_dict(into=OrderedDict)
print(type(d))
print(d)

輸出 1：

<class 'collections.OrderedDict'>
OrderedDict([('objectName', OrderedDict([(0, 'Johnny')])), ('geoInfo.latitude', OrderedDict([(0, 1.2)])), ('geoInfo.longitude', OrderedDict([(0, 3.4)]))])

選項 2

d = json_normalize(input_data).to_dict(into=OrderedDict, 'list')

輸出 2

<class 'collections.OrderedDict'>
OrderedDict([('objectName', ['Johnny']), ('geoInfo.latitude', [1.2]), ('geoInfo.longitude', [3.4])])

選項 3

d = json_normalize(input_data).to_dict(into=OrderedDict, orient='records')

輸出 3

<class 'list'>
[OrderedDict([('objectName', 'Johnny'), ('geoInfo.latitude', 1.2), ('geoInfo.longitude', 3.4)])]

選項 4

d = json_normalize(input_data).to_dict('index', into=OrderedDict)

輸出 4

<class 'collections.OrderedDict'>
OrderedDict([(0, {'objectName': 'Johnny', 'geoInfo.latitude': 1.2, 'geoInfo.longitude': 3.4})])

對於這種情況，選項 3是最好的。 但由於它返回長度為 1 的列表，因此添加 [0] 。

解決方案：

d = json_normalize(input_data).to_dict(orient='records')[0]

輸出：

<class 'dict'>
{'objectName': 'Johnny', 'geoInfo.latitude': 1.2, 'geoInfo.longitude': 3.4}

對於重命名字段，需要更多的額外步驟。

from pandas import json_normalize
from collections import OrderedDict

input_data = {
    "objectName": "Johnny",
    "geoInfo": {
        "latitude": 1.2,
        "longitude": 3.4,
    },
}

d = json_normalize(input_data).to_dict(orient='records', into=OrderedDict)[0]
N = len(d)
key_map = {"objectName": "name", "geoInfo.latitude": "lat", "geoInfo.longitude":"lon"}
# or use list ["name", "lat", "lon"] and access by index.
# I used dict key_map for cases when normal dict is used, instead of ordereddict
# (when into=OrderedDict argument is not given to pandas to_dict function)
for _ in range(N):
    k, v = d.popitem(last=False)
d[key_map[k]] = v

print(d)

輸出：

OrderedDict([('name', 'Johnny'), ('lat', 1.2), ('lon', 3.4)])

Answer 2

我建議使用遞歸，類似這樣的：

def make_it_flat(inp):
    out = dict()
    
    def flatten(piece, name=''):
        if isinstance(piece, dict):
            for k,v in piece.items():
                flatten(v, f'{name}{k}_')
        elif isinstance(piece, list):
            for i, a in enumerate(piece):
                flatten(a, f'{name}{i}_')
        else:
            out[name[:-1]] = piece
    flatten(inp)
    return out

例子：

>>> make_it_flat({22222: 'y', 1: {2: {3: ['a','b','c']}}})
{'22222': 'y', '1_2_3_0': 'a', '1_2_3_1': 'b', '1_2_3_2': 'c'}

Answer 3

感謝此線程提供了答案： source="*"嵌套字段展平到validated_data 。

在這種情況下，解決方案如下所示：

class TheFlattener(serializers.Serializer):
    class GeoInfoSerializer(serializers.Serializer):
        latitude = serializers.FloatField(source="lat")  # rename here
        longitude = serializers.FloatField(source="lon")

    objectName = serializers.CharField(max_length=50, source="name")
    geoInfo = GeoInfoSerializer(source="*")  # unpack nested fields here

    def create(self, validated_data):  
        return Thing(**validated_data)