将Python namedtuple序列化为json

建议namedtuple使用保留的字段名称将a序列化为json的建议方式是什么？

将anamedtuple序列化为json只会导致值序列化，并且字段名称在转换中丢失。我希望在对json大小化时也保留字段，因此请执行以下操作：

class foobar(namedtuple('f', 'foo, bar')):
    __slots__ = ()
    def __iter__(self):
        yield self._asdict()

上面的代码按照我的预期序列化为json，并且namedtuple在我使用的其他地方（属性访问等）中起作用，除了在迭代过程中出现非元组之类的结果外（对于我的用例而言这很好）。

在保留字段名称的情况下转换为json的“正确方法”是什么？

这非常棘手，因为这namedtuple()是一个工厂，该工厂返回从派生的新类型tuple。一种方法是让您的类也继承自UserDict.DictMixin，但tuple.__getitem__已经定义了它，并且需要一个整数来表示元素的位置，而不是其属性的名称：

>>> f = foobar('a', 1)
>>> f[0]
'a'

从本质上讲，namedtuple非常适合JSON，因为它实际上是一个自定义类型，其键名作为类型定义的一部分固定，而字典中的键名存储在实例中。这可以防止您“往返”一个命名元组，例如，在没有其他信息的情况下，您无法将字典解码回一个命名元组，例如dict中的特定于应用程序的类型标记{'a': 1, '#_type': 'foobar'}，这有点麻烦。

这不是理想的方法，但是如果您只需要将namedtuple编码为字典，则另一种方法是将JSON编码器扩展或修改为特殊类型的这些类型。这是Python的子类化示例json.JSONEncoder。这解决了确保嵌套的命名元组正确转换为字典的问题：

from collections import namedtuple
from json import JSONEncoder

class MyEncoder(JSONEncoder):

    def _iterencode(self, obj, markers=None):
        if isinstance(obj, tuple) and hasattr(obj, '_asdict'):
            gen = self._iterencode_dict(obj._asdict(), markers)
        else:
            gen = JSONEncoder._iterencode(self, obj, markers)
        for chunk in gen:
            yield chunk

class foobar(namedtuple('f', 'foo, bar')):
    pass

enc = MyEncoder()
for obj in (foobar('a', 1), ('a', 1), {'outer': foobar('x', 'y')}):
    print enc.encode(obj)

{"foo": "a", "bar": 1}
["a", 1]
{"outer": {"foo": "x", "bar": "y"}}

如果只是一个 namedtuple您要序列化的序列，则使用它的_asdict()方法将起作用（Python> = 2.7）

>>> from collections import namedtuple
>>> import json
>>> FB = namedtuple("FB", ("foo", "bar"))
>>> fb = FB(123, 456)
>>> json.dumps(fb._asdict())
'{"foo": 123, "bar": 456}'

看起来您曾经可以simplejson.JSONEncoder继承该类以使其工作，但是使用最新的simplejson代码，情况已不再如此：您必须实际修改项目代码。我看不出为什么simplejson不支持namedtuples的原因，所以我分叉了项目，添加了namedtuple支持，并且我目前正在等待将分支拉回到主项目中。如果您现在需要修复程序，只需从我的叉子上拉出即可。

编辑：看起来simplejson现在的最新版本本身带有该namedtuple_as_object选项，默认为True。

我为此编写了一个库：https : //github.com/ltworf/typedload

它可以往返于命名元组并返回。

它支持非常复杂的嵌套结构，包括列表，集合，枚举，联合，默认值。它应涵盖最常见的情况。

编辑：该库还支持dataclass和attr类。

它以递归方式将namedTuple数据转换为json。

print(m1)
## Message(id=2, agent=Agent(id=1, first_name='asd', last_name='asd', mail='2@mai.com'), customer=Customer(id=1, first_name='asd', last_name='asd', mail='2@mai.com', phone_number=123123), type='image', content='text', media_url='h.com', la=123123, ls=4512313)

def reqursive_to_json(obj):
    _json = {}

    if isinstance(obj, tuple):
        datas = obj._asdict()
        for data in datas:
            if isinstance(datas[data], tuple):
                _json[data] = (reqursive_to_json(datas[data]))
            else:
                 print(datas[data])
                _json[data] = (datas[data])
    return _json

data = reqursive_to_json(m1)
print(data)
{'agent': {'first_name': 'asd',
'last_name': 'asd',
'mail': '2@mai.com',
'id': 1},
'content': 'text',
'customer': {'first_name': 'asd',
'last_name': 'asd',
'mail': '2@mai.com',
'phone_number': 123123,
'id': 1},
'id': 2,
'la': 123123,
'ls': 4512313,
'media_url': 'h.com',
'type': 'image'}

还有一个更方便的解决方案是使用装饰器（它使用protected字段_fields）。

Python 2.7+：

import json
from collections import namedtuple, OrderedDict

def json_serializable(cls):
    def as_dict(self):
        yield OrderedDict(
            (name, value) for name, value in zip(
                self._fields,
                iter(super(cls, self).__iter__())))
    cls.__iter__ = as_dict
    return cls

#Usage:

C = json_serializable(namedtuple('C', 'a b c'))
print json.dumps(C('abc', True, 3.14))

# or

@json_serializable
class D(namedtuple('D', 'a b c')):
    pass

print json.dumps(D('abc', True, 3.14))

Python 3.6.6+：

import json
from typing import TupleName

def json_serializable(cls):
    def as_dict(self):
        yield {name: value for name, value in zip(
            self._fields,
            iter(super(cls, self).__iter__()))}
    cls.__iter__ = as_dict
    return cls

# Usage:

@json_serializable
class C(NamedTuple):
    a: str
    b: bool
    c: float

print(json.dumps(C('abc', True, 3.14))

该jsonplus库提供了NamedTuple实例串行。如果需要，可使用其兼容模式输出简单对象，但最好使用默认值，因为它有助于回解码。

这是一个老问题。然而：

对于所有有相同问题的人员的建议，请仔细考虑使用的任何私有或内部功能，NamedTuple因为它们以前拥有并且会随着时间的流逝而再次发生变化。

例如，如果您NamedTuple是一个固定值对象，并且只对序列化感兴趣，而对嵌套在另一个对象中的情况不感兴趣，则可以避免__dict__由于删除或_as_dict()更改而带来的麻烦，只需执行以下操作（是的，这是Python 3，因为目前的答案是这样）：

from typing import NamedTuple

class ApiListRequest(NamedTuple):
  group: str="default"
  filter: str="*"

  def to_dict(self):
    return {
      'group': self.group,
      'filter': self.filter,
    }

  def to_json(self):
    return json.dumps(self.to_dict())

我尝试使用default可调用的kwarg来dumps进行to_dict()调用（如果可用），但是未调用，因为NamedTuple可以转换为列表。

这是我对这个问题的看法。它序列化NamedTuple，照顾折叠后的NamedTuples和其中的List

def recursive_to_dict(obj: Any) -> dict:
_dict = {}

if isinstance(obj, tuple):
    node = obj._asdict()
    for item in node:
        if isinstance(node[item], list): # Process as a list
            _dict[item] = [recursive_to_dict(x) for x in (node[item])]
        elif getattr(node[item], "_asdict", False): # Process as a NamedTuple
            _dict[item] = recursive_to_dict(node[item])
        else: # Process as a regular element
            _dict[item] = (node[item])
return _dict

使用本机python json库无法正确序列化namedtuple。它总是将元组视为列表，并且不可能覆盖默认的序列化程序来更改此行为。如果对象嵌套，那就更糟。

最好使用更强大的库，例如orjson：

import orjson
from typing import NamedTuple

class Rectangle(NamedTuple):
    width: int
    height: int

def default(obj):
    if hasattr(obj, '_asdict'):
        return obj._asdict()

rectangle = Rectangle(width=10, height=20)
print(orjson.dumps(rectangle, default=default))

=>

{
    "width":10,
    "height":20
}

simplejson.dump()而不是json.dump做这项工作。不过可能会慢一些。