解决xmlschema库处理含独立complexType的XML Schema插入元素报错问题

问题背景 #

需求是将任意格式的XML Schema转换为完整XML文档，重点实现元素插入。使用xmlschema库的示例代码可处理内嵌complexType的简单XSD，但遇到元素引用独立定义的complexType的目标XSD时，出现验证错误：“第一个子元素内容不完整，预期对应标签”。

原可用示例代码 #

以下代码可基于内嵌complexType的XSD生成XML：

file      = "test.xsd"
schema   = xmlschema.XMLSchema(file) 
jsondata = json.dumps({'class': {"student1": "John",  
                                 "student2": "Rachel"}})
    
nameSpace=schema.target_namespace
xml      = xmlschema.from_json(jsondata,schema=schema,preserve_root=True,namespaces={'': nameSpace})
# write to XML
ElementTree(xml).write('myxml.xml')

对应可正常工作的简单XSD #

<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="class">
    <xs:complexType>
      <xs:sequence>
        <xs:element type="xs:string" name="student1"/>
        <xs:element type="xs:string" name="student2"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
</xs:schema>

目标XSD的问题场景 #

目标XSD中，class元素的complexType是独立定义后通过type="ser:class"引用的，运行原代码时触发验证错误：

<?xml version="1.0" encoding="utf-8"?>
<xs:schema targetNamespace="http://address0.com" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:ser="http://address0.com" xmlns:ds="http://www.address1.com">
    <xs:import namespace="http://www.address2.com" schemaLocation="xmldsig-core-schema.xsd"/>
    <xs:complexType name="class">
        <xs:sequence>
            <xs:element name="student1" type="ser:String32" minOccurs="0" maxOccurs="1"/>
            <xs:element name="student2" type="ser:String32" minOccurs="0" maxOccurs="1"/>
        </xs:sequence>
    </xs:complexType>
    <xs:element name="class" type="ser:class"/>
    <xs:simpleType name="String32">
        <xs:restriction base="xs:normalizedString">
            <xs:minLength value="1"/>
            <xs:maxLength value="32"/>
        </xs:restriction>
    </xs:simpleType>
</xs:schema>

解决方法 #

问题核心 #

目标XSD的class元素和String32类型都属于http://address0.com命名空间，原代码的JSON数据未正确关联该命名空间，导致xmlschema无法匹配到对应的元素定义，进而触发验证错误。

修改后的代码 #

方式一：用命名空间URI作为JSON键前缀

import xmlschema
import json
from xml.etree import ElementTree

file = "target.xsd"
schema = xmlschema.XMLSchema(file) 
# 用命名空间URI明确标记元素归属
jsondata = json.dumps({
    '{http://address0.com}class': {
        '{http://address0.com}student1': "John",  
        '{http://address0.com}student2': "Rachel"
    }
})

xml = xmlschema.from_json(jsondata, schema=schema, preserve_root=True)
# 注册命名空间前缀，保证输出XML可读性
ElementTree.register_namespace('ser', 'http://address0.com')
ElementTree(xml).write('myxml.xml', encoding='utf-8', xml_declaration=True)

方式二：利用namespaces参数简化JSON写法

import xmlschema
import json
from xml.etree import ElementTree

file = "target.xsd"
schema = xmlschema.XMLSchema(file) 
# 定义命名空间前缀映射
ns_map = {'ser': 'http://address0.com'}
# JSON使用前缀+元素名的简洁形式
jsondata = json.dumps({
    'ser:class': {
        'ser:student1': "John",  
        'ser:student2': "Rachel"
    }
})

# from_json时传入命名空间映射，解析时自动关联URI
xml = xmlschema.from_json(jsondata, schema=schema, preserve_root=True, namespaces=ns_map)
ElementTree.register_namespace('ser', 'http://address0.com')
ElementTree(xml).write('myxml.xml', encoding='utf-8', xml_declaration=True)

关键注意事项 #

• 必须确保JSON数据中的元素明确关联目标命名空间，避免xmlschema找不到对应定义
• 验证student1和student2的值符合String32约束：长度在1-32字符之间，且为无多余空格的标准化字符串
• 写入XML时注册命名空间前缀，保证输出结构规范且可读

内容的提问来源于stack exchange，提问作者Magemathician