近期项目需要对接TCP协议,其负载采用XML格式,尝试用xml.etree.ElementTree解析,感觉获取相应字段内容的过程较为繁琐,且再将字段的内容赋值到对象中也需要大量的手工。考虑到对象映射的易用性和Pydantic比较强的校验器等功能,因此查了下XML->Pydantic的解决方案。研究了pydantic-xml这个库,感觉使用文档不够详细。后来又参看这篇文章发现通过xmltodict是一个很好的中转方案,再结合Pydantic类的model_validate函数,可以比较完美的实现有XML文本到Pydantic对象的转化。示例代码如下:
# codeing: utf-8
# author: jsnjhhy@126.com
import xmltodict
from pydantic import BaseModel, Field
from datetime import datetime
payload="""
<PatrolDevice>
<Type>1002</Type>
<Command>1</Command>
<Time>2023-01-01 00:00:01</Time>
<Items>
<MotionState>0</MotionState>
<PosX>0.0</PosX>
<PosY>0.0</PosY>
<PosZ>0.0</PosZ>
</Items>
</PatrolDevice>
"""
class Items(BaseModel):
motionState: int = Field(alias="MotionState")
posX: float = Field(alias="PosX")
posY: float = Field(alias="PosY")
posZ: float = Field(alias="PosZ")
class PatrolDevice(BaseModel):
type: int= Field(alias="Type")
command: int= Field(alias="Command")
time: datetime= Field(alias="Time")
items: Items= Field(alias="Items")
payload_dict = xmltodict.parse(payload)
payload_pydantic =PatrolDevice.model_validate(payload_dict ['PatrolDevice'])
运行结果如下:
Trouble Shooting:
<?xml version="1.0" encoding="UTF-8" ?> |
xmltodict只能处理纯粹XML负载,对于上面XML描述头似乎无法处理,转化成dict时,需要将描述头所在的一行去掉。