如何在不移动命名空间的情况下使用Python的ElementTree解析和编写XML？

Question

我们的项目来自这种形式的上游XML:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <runtime>
    <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
      <dependentAssembly>
        <assemblyIdentity name="Newtonsoft.Json" publicKeyToken="30ad4fe6b2a6aeed" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-6.0.0.0" newVersion="7.0.0.0" />
      </dependentAssembly>
    </assemblyBinding>
  </runtime>
  <appSettings>
    <add key="foo" value="default">
    ...
  </appSettings>
</configuration>

然后它使用ElementTree读取/解析此XML,然后对于匹配某个键("foo")的每个app设置,它会写入一个新值,它知道上游进程没有(在这种情况下键为"foo")应该有值"bar").

使用过滤后的XML 的下游进程是aaahhhh ...... 脆弱的.它期望接收XML中正好上面的表格.

如果我在没有注册命名空间的情况下解析这个XML,那么ElementTree就会在输入上修改我的树:

<configuration xmlns:ns0="urn:schemas-microsoft-com:asm.v1">
  <runtime>
  <ns0:assemblyBinding>
    <ns0:dependentAssembly>
      <ns0:assemblyIdentity culture="neutral" name="Newtonsoft.Json" publicKeyToken="30ad4fe6b2a6aeed" />
      <ns0:bindingRedirect newVersion="7.0.0.0" oldVersion="0.0.0.0-6.0.0.0" />
    </ns0:dependentAssembly>
  </ns0:assemblyBinding>
 </runtime>
 <appSettings>
    <add key="foo" value="default">
    ...
 </appSettings>
</configuration>

下游流程无法解决这个问题,因为从语义上讲,这并不是一件容易理解的事情.所以,我决定注册我知道上游进程将提供的命名空间作为默认命名空间,以避免前缀出现在任何地方,现在我得到这个:

<configuration xmlns="urn:schemas-microsoft-com:asm.v1">
 <runtime>
  <assemblyBinding>
    <dependentAssembly>
      <assemblyIdentity culture="neutral" name="Newtonsoft.Json" publicKeyToken="30ad4fe6b2a6aeed" />
      <bindingRedirect newVersion="7.0.0.0" oldVersion="0.0.0.0-6.0.0.0" />
    </dependentAssembly>
  </assemblyBinding>
 </runtime>
 <appSettings>
    <add key="foo" value="default">
    ...
 </appSettings>
</configuration>

我对XML知之甚少,但这也是下游组件的呐喊,在我看来现在并不意味着这个默认xmlns现在适用于内部所有包含的元素<configuration>,而在它只应用于<assemblyBinding>元素之前？

无论如何,使用ElementTree来处理这个命名空间,以便我可以接受上游的XML,设置foo的值,然后在下游传递它,而不移动命名空间,并完全按照我发现的那样离开它？

• 我可以使用一个基于lxml的解决方案,它似乎处理这个问题,但是,lxml依赖于C,下游组件真的不想支持它:纯Python解决方案更可取.

• 我可以将文档读作HTML,忽略命名空间属性,让我操纵我想要的值,然后传递文档; 但是,我还没有找到一个不会包含所有元素名称的Python解析器,而我的下游组件需要保留所有元素名称的大小写.

• 我可以使用字符串解析和正则表达式.我宁愿不写我自己的解析器.

到目前为止,我在ElementTree中找到关于名称空间处理的唯一建议是建议"注册默认名称空间以避免前缀"方法,我认为这种方法是合适的,但ElementTree则坚持xmlns在转储时将声明移动到根节点.

我也可以巧妙地建立一个字符串,将树分阶段转储出来,并以完全正确的顺序将xmlns声明放回"正确的节点",但这也让我感到非常脆弱.

有没有人设法解决这样的问题？

Answer 1

据我所知，更适合您需求的解决方案是使用xml.etree.ElementTree. 这是一种可能的解决方案：

from xml.etree import ElementTree as ET
from re import findall, sub

def render(root, buffer='', namespaces=None, level=0, indent_size=2, encoding='utf-8'):
    buffer += f'<?xml version="1.0" encoding="{encoding}" ?>\n' if not level else ''
    root = root.getroot() if isinstance(root, ET.ElementTree) else root
    _, namespaces = ET._namespaces(root) if not level else (None, namespaces)
    for element in root.iter():
        indent = ' ' * indent_size * level
        tag = sub(r'({[^}]+}\s*)*', '', element.tag)
        buffer += f'{indent}<{tag}'
        for ns in findall(r'{[^}]+}', element.tag):
            ns_key = ns[1:-1]
            if ns_key not in namespaces: continue
            buffer += ' xmlns' + (f':{namespaces[ns_key]}' if namespaces[ns_key] != '' else '') + f'="{ns_key}"'
            del namespaces[ns_key]
        for k, v in element.attrib.items():
            buffer += f' {k}="{v}"'
        buffer += '>' + element.text.strip() if element.text else '>'
        children = list(element)
        for child in children:
            sep = '\n' if buffer[-1] != '\n' else ''
            buffer += sep + render(child, level=level+1, indent_size=indent_size, namespaces=namespaces)
        buffer += f'{indent}</{tag}>\n' if 0 != len(children) else f'</{tag}>\n'
    return buffer

通过将XML您提供的数据发送给上述render函数，如下所示：

data=\
'''<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <runtime>
    <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
      <dependentAssembly>
        <assemblyIdentity name="Newtonsoft.Json" publicKeyToken="30ad4fe6b2a6aeed" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-6.0.0.0" newVersion="7.0.0.0" />
      </dependentAssembly>
    </assemblyBinding>
  </runtime>
  <appSettings>
    <add key="foo" value="default" />
  </appSettings>
</configuration>'''

e = ET.fromstring(data)
ET.register_namespace('', "urn:schemas-microsoft-com:asm.v1")
r = ET.ElementTree(e)

您将得到以下结果，XML其中包含您所说的您正在寻找的属性：

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <runtime>
    <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
      <dependentAssembly>
        <assemblyIdentity name="Newtonsoft.Json" publicKeyToken="30ad4fe6b2a6aeed" culture="neutral"></assemblyIdentity>
        <bindingRedirect oldVersion="0.0.0.0-6.0.0.0" newVersion="7.0.0.0"></bindingRedirect>
      </dependentAssembly>
    </assemblyBinding>
  </runtime>
  <appSettings>
    <add key="foo" value="default"></add>
  </appSettings>
</configuration>

我知道我参加聚会迟到了。无论如何，希望这能帮助您和许多其他有同样问题的人，这是一个很好的解决方案。快乐编码！