问题
日常开发中,经常会遇到一些对象是纯的数据,用于内部对象之间或者外部的网络交互。这样的数据经常被定义成json
数据格式。可能的代码如下:
import json
class Person:
def __init__(self, name:str, age:int):
self.name = name
self.age = age
def to_json():
return json.dumps( dict(name=self.name, age=self.age), indent=4)
问题是这样的数据,每次都是从头封装,比较繁琐与枯燥,如何快速构建数据类型?是值得讨论的问题。
解决方案
基础方法
Python
语言中,构建数据类型,语言层面已经提供了标准方法,用起来比较方便,可以直接使用装饰器dataclasses.dataclass
。代码如下:
import dataclasses
@dataclasses.dataclass
class Persion:
name:str
age:int
phone:list
# 定义Persion对象
p = Persion(name='chaos', age=100, phone=['139'])
print(p)
print(p.name)
print(p.age)
# 定义另外一个Person对象
p2 = Persion(name='chaos2', age=100, phone=['139'])
print(p2.name)
# 输出内容如下:
Persion(name='chaos', age=100, phone=['139'])
chaos
100
chaos2
定义数据类,使用dataclasses.dataclass
,数据类的属性看起来像是静态成员,实际上并不是。两个Person
多向的name属性并不相同。
数据类,可以定义时给缺省值。代码如下:
import dataclasses
@dataclasses.dataclass
class Persion:
name:str = ''
age:int = 100
phone:list = dataclasses.field(default_factory=list)
- 对于
str、int、float
等基础类型,可以直接赋值。 - 对于
list、dict
类型的缺省值,需要使用dataclasses.field
进行初始化。 - 有一个问题需要注意,初始化的时候,千万不要值后面加上逗号,加上逗号后数据类型就会变成元组类型,出了问题不容易定位。比如下面的代码:
@dataclasses.dataclass
class Persion3:
name:str = '',
p = Persion3()
assert isinstance(p.name, tuple)
json
转换
可惜的是,Python
标准库好像并没有提供数据类与json
进行相互转换的方法。这里我们可以使用第三方库dataclasses-json
,这样就避免繁琐的手写工作。使用命令pip3 install dataclasses-json
安装依赖的库。样例代码如下:
import dataclasses
import dataclasses_json
@dataclasses_json.dataclass_json
@dataclasses.dataclass
class Persion:
name:str
age:int
phone:list
p = Persion(name='chaos', age=100, phone=['139'])
print(p.to_json())
print(p.to_dict())
# 输出内容:
{"name": "chaos", "age": 100, "phone": ["139"]}
{'name': 'chaos', 'age': 100, 'phone': ['139']}
- 装饰器
@dataclasses_json.dataclass_json
,必须放在@dataclasses.dataclass
之上,否则会报错。 - 方法
to_json
和from_json
两个方法是数据对象与json
之间的相互转换。也可以使用to_dict
和from_dict
与字典进行相互转换。
数据类嵌套
最后一个问题,数据类能否嵌套定义,嵌套后能否像上面快速转换成json
?答案是可以的,直接上代码。
import dataclasses
import dataclasses_json
@dataclasses_json.dataclass_json
@dataclasses.dataclass
class Address:
station: str
street: str
@dataclasses_json.dataclass_json
@dataclasses.dataclass
class Person:
name: str
age: int
address: Address
p = Person(name='chaos', age=100, address=Address('china', 'street 100'))
js = p.to_json()
print(p.to_json())
p2 = Person.from_json(js)
print(p2)
# 输出
{"name": "chaos", "age": 100, "address": {"state": "china", "street": "street 100"}}
Person(name='chaos', age=100, address=Address(state='china', street='street 100'))
讨论
到目前数据类型定义、转换成json
,都是相当的方便,日常的使用似乎没什么问题。但是我对第三方库的质量始终持怀疑态度。这里要思考的问题有:
- 库
dataclasses-json
性能怎么样?能否达到标准库dataclasses
性能,标准库为何没有提供转json
的能力?性能相差多少,是否影响日常的使用? - 使用
dataclasses-json
的数据类型,与json、dict
相互转换,能否支持所有基础的类型?
以上两个问题,留给大家思考与实践。