将Pydantic对象转化为XML文本

书接上回的'XML文本转化为Pydantic对象'。XML作为Tcp协议的负载，除了接收需要解析，发送请求或响应还涉及到对象到XML的序列化工作。本文的方案和上一篇文章的方案在设计上是对称的。即Pydantic->dict->XML的转化过程。Pydantic到Python字典采用的是Pydantic对象的model_dump方法，而字典到XML文本则是用了dicttoxml这个类库。示例代码如下：

# codeing: utf-8
# author： jsnjhhy@126.com
 
import dicttoxml
from pydantic import BaseModel, Field, field_serializer
from typing import Any,Optional
from datetime import datetime
from pprint import pprint
 
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",default = 1)
    command: int= Field(alias="Command",default=0)
    time: datetime= Field(alias="Time", default=datetime.now())
    items: Optional[Any]= Field(alias="Items",default=None)

    @field_serializer('time', when_used='always')
    def serialize_courses_in_order(time: datetime):
        return time.strftime("%Y-%m-%d %H:%M:%S")

class RootXml(BaseModel):
    patrolDevice: PatrolDevice= Field(alias="PatrolDevice",default = 1)

pd=PatrolDevice()
pd.type=1
pd.command=2
items= Items(MotionState=1,PosX=0.1,PosY=0.2,PosZ=0.3)
pd.items = items
root = RootXml(PatrolDevice=pd)


payload_dict = root.model_dump(by_alias=True)
res =dicttoxml.dicttoxml(payload_dict,attr_type=False,root=False)
pprint(res)

运行结果如下：

上一篇文章接收到的负载为：

可见转换是成功的。

Trouble Shooting:

在序列化datetime对象时，由于dicttoxml会将datetime序列化为一个固定的ISO格式，这样可能会影响协议接收方对时间对象的解析。本文的解决方案是通过field_serializer注解，让Pydantic直接将datetime序列化为需要格式的字符串。