在Python 中将类对象序列化为JSON


Posted in Python onApril 06, 2022

1. 引言

序列化是将对象转换为可以在以后保存和检索介质中的过程。比如,将对象的当前状态保存到文件中。对于一些复杂的项目,序列化是所有开发人员迟早要做的事情。
Python 语言的优点之一是它在许多常见的编程任务中易于使用,往往只需几行代码,就可以实现读取文件 IO、绘制图表等功能,序列化在 Python 中实现起来也非常容易。
在本文中,我将给大家带来将类对象序列化为 JSON 对象的一些技巧。

2. 举个栗子

为了讲述序列化的技巧,我们首先来定义一个类作为示例,

代码如下:

class LabelSimple:
def __init__(self, label, x, y, width, height):
self.label = label
self.x = x
self.y = y
self.width = width
self.height = height

如果我们想要将其序列化(比如直接打印类的对象),我们将会得到如下错误信息:

label = LabelSimple("person", 10, 10, 4, 10)
print(label)
>> __main__.LabelSimple object at 0x000002C3913EB2E0>

Python中的JSON 库提供了一个方便的方法,称为​ json.dumps()​ 。它可以将任何 Python 对象转换为 JSON。这听起来很简单,我们不妨来直接调用试试看。

import json

print(json.dumps(label))
>>...
/usr/lib/python3.7/json/encoder.py in default(self, o)
177
178 """
--> 179 raise TypeError(f'Object of type {o.__class__.__name__} '
180 f'is not JSON serializable')
181

TypeError: Object of type LabelSimple is not JSON serializable

​json.dumps()​ 为我们自定义对象调用相应的编码器,并且由于我们没有实现编码器而引发类对象错误。

3. 解决方案

3.1 使用 json.dumps() 和 __dict__

为了将上述类对象可以直接序列化后输出,我们能想到的最简单的方式就是使用内置的 __dict__ 方法来显示对象的内容.

代码如下:

label = Label("person", 10, 10, 4, 10)
print(label.__dict__)
print(json.dumps(label.__dict__))

输出如下:

{"label": "person", "x": 10, "y": 10, "width": 4, "height": 10}
{"label": "person", "x": 10, "y": 10, "width": 4, "height": 10}

可以看出使用上述方法后, ​print() 函数和 ​json.dumps() ​函数可以将类对象内容以JSON格式进行输出。

3.2 实现 __str__ 和 __repr__

上述实现虽然可以实现序列化的目的,但是我们每次都需要调用 __dict__方法,多少有点麻烦。我们还可以有更简单的方法,那就是实现类的内置函数__str__repr__

代码如下:

class Label:
def __init__(self, label, x, y, width, height):
self.label = label
self.x = x
self.y = y
self.width = width
self.height = height

def __iter__(self):
yield from {
"label": self.label,
"x": self.x,
"y": self.y,
"width": self.width,
"height": self.height
}.items()

def __str__(self):
return json.dumps(dict(self), ensure_ascii=False)

def __repr__(self):
return self.__str__()

调用代码如下:

label = Label("person", 10, 10, 4, 10)
print(label)
# print(json.dumps(label))

上述代码,print可以输出序列化后的JSON内容,但是json.dumps依旧不能正常工作,这是因为我们并没有实现encoder。

3.3 实现 JSON encoder

为了支持 json.dumps 用例,常用的方法是通过继承 JSONEncoder 来实现自定义编码器类。在上述例子中,由于我们希望对象是 JSON 字典格式,所以我们只是返回字典。

代码如下:

from json import JSONEncoder

class MyEncoder(JSONEncoder):
def default(self, obj):
return obj.__dict__

label = Label("person", 10, 10, 4, 10)
print(MyEncoder().encode(label))
print(json.dumps(label, cls=MyEncoder))
print(label)

输出如下:

# outputs of a Label class object
{"label": "person", "x": 10, "y": 10, "width": 4, "height": 10}
{"label": "person", "x": 10, "y": 10, "width": 4, "height": 10}
{"label": "person", "x": 10, "y": 10, "width": 4, "height": 10}

4. 总结

本文重点介绍了在Python中,如何来将自定义对象序列化为JSON以JOSN格式进行输出,由浅入深给出了不同的解决方案,并给出了相应的源代码。

到此这篇关于在Python 中将类对象序列化为JSON的文章就介绍到这了,更多相关Python 将类对象序列化JSON内容请搜索三水点靠木以前的文章或继续浏览下面的相关文章希望大家以后多多支持三水点靠木!

Python 相关文章推荐
python 查找文件夹下所有文件 实现代码
Jul 01 Python
Python正则表达式使用经典实例
Jun 21 Python
解析Python中的__getitem__专有方法
Jun 27 Python
Python实现视频下载功能
Mar 14 Python
Python随机读取文件实现实例
May 25 Python
Python学习入门之区块链详解
Jul 25 Python
python爬取个性签名的方法
Jun 17 Python
python使用opencv对图像mask处理的方法
Jul 05 Python
Python Pandas 箱线图的实现
Jul 23 Python
PyQt5-QDateEdit的简单使用操作
Jul 12 Python
Python如何绘制日历图和热力图
Aug 07 Python
python 利用panda 实现列联表(交叉表)
Feb 06 Python
Python中itertools库的四个函数介绍
Apr 06 #Python
如何用六步教会你使用python爬虫爬取数据
基于Python实现射击小游戏的制作
python使用opencv对图像添加噪声(高斯/椒盐/泊松/斑点)
python DataFrame中stack()方法、unstack()方法和pivot()方法浅析
浅谈Python中对象是如何被调用的
Apr 06 #Python
Python实现猜拳与猜数字游戏的方法详解
You might like
php、java、android、ios通用的3des方法(推荐)
2016/09/09 PHP
thinkPHP框架实现图像裁剪、缩放、加水印的方法
2017/03/14 PHP
js预载入和JavaScript Image()对象使用介绍
2011/08/28 Javascript
jQuery给动态添加的元素绑定事件的方法
2015/03/09 Javascript
JavaScript通过select动态更换图片的方法
2015/03/23 Javascript
JavaScript判断是否为数字的4种方法及效率比较
2015/04/01 Javascript
nodejs初步体验篇
2015/11/23 NodeJs
javascript设置和获取cookie的方法实例详解
2016/01/05 Javascript
微信小程序 倒计时组件实现代码
2016/10/24 Javascript
JS实现用户注册时获取短信验证码和倒计时功能
2016/10/27 Javascript
jQuery实现select模糊查询(反射机制)
2017/01/14 Javascript
微信小程序商品详情页规格属性选择示例代码
2017/10/30 Javascript
vue加载完成后的回调函数方法
2018/09/07 Javascript
Vue中qs插件的使用详解
2020/02/07 Javascript
[03:03]2014DOTA2西雅图国际邀请赛 Alliance战队巡礼
2014/07/07 DOTA
python中threading超线程用法实例分析
2015/05/16 Python
python最小生成树kruskal与prim算法详解
2019/01/17 Python
详解Python logging调用Logger.info方法的处理过程
2019/02/12 Python
浅谈Python3中strip()、lstrip()、rstrip()用法详解
2019/04/29 Python
详解pandas删除缺失数据(pd.dropna()方法)
2019/06/25 Python
详解如何减少python内存的消耗
2019/08/09 Python
python 用户交互输入input的4种用法详解
2019/09/24 Python
用Python实现校园通知更新提醒功能
2019/11/23 Python
python正则表达式实例代码
2020/03/03 Python
Python预测2020高考分数和录取情况
2020/07/08 Python
纯html5+css3下拉导航菜单实现代码
2013/03/18 HTML / CSS
野兽派官方旗舰店:THE BEAST 野兽派
2016/08/05 全球购物
施华洛世奇西班牙官网:SWAROVSKI西班牙
2019/06/06 全球购物
中学老师的自我评价
2013/11/07 职场文书
五型班组建设方案
2014/02/10 职场文书
境外导游求职信
2014/02/27 职场文书
淘宝活动总结范文
2014/06/26 职场文书
董事长助理工作职责范本
2014/07/01 职场文书
匿名检举信范文
2015/03/02 职场文书
离婚协议书范本(2016最新版)
2016/03/18 职场文书
Win10 最新稳定版本 21H2开始推送
2022/04/19 数码科技