Python 漂亮地打印XML

在Python中处理XML数据时，确保其中可读性和结构可以极大地增强代码理解和可维护性。漂亮地打印XML，即使用适当的缩进和换行格式化XML，是实现这些目标的一种宝贵技术。

在本文中，我们将探讨两种使用Python漂亮地打印XML的方法：xml.dom.minidom和xml.etree.ElementTree。通过了解这些方法，开发人员可以有效地以有组织和视觉上吸引人的方式呈现XML数据，便于更轻松地分析和操作。

如何在Python中漂亮地打印XML

以下是我们可以使用的两种方法进行Python漂亮地打印的方法：

方法1：使用xml.dom.minidom

以下是使用xml.dom.minidom执行漂亮打印的步骤：

导入所需的模块：我们首先导入’xml.dom.minidom’模块，该模块提供了一种轻量级的XML解析的文档对象模型（DOM）API的实现。
定义’pretty_print_xml_minidom’函数：该函数以XML字符串作为输入，并负责使用’xml.dom.minidom’解析和漂亮地打印XML。
解析XML字符串：在’pretty_print_xml_minidom’函数内部，我们使用’xml.dom.minidom.parseString()’方法解析XML字符串并创建DOM对象。
漂亮地打印XML：接下来，我们在DOM对象上使用’toprettyxml()’方法生成漂亮打印的XML字符串。我们传递’indent’参数，并将值设为" "以指定所需的缩进级别（在此情况下为两个空格）。
删除空行：默认情况下，’toprettyxml()’会在输出中添加空行。为了删除这些空行，我们通过换行符（\n）拆分漂亮的XML字符串，从每行中删除任何前导或尾随空白，然后将非空行重新组合起来。
打印漂亮的XML：最后，我们打印得到的漂亮的XML字符串。

方法2：使用xml.etree.ElementTree

以下是使用xml.etree.ElementTree执行漂亮打印的步骤：

导入所需的模块：我们首先导入 xml.etree.ElementTree 模块，它提供了一个快速高效的API，用于解析和操作XML。
定义 indent 函数：这是一个自定义函数，递归地给XML元素添加缩进。它接受一个 elem 参数（XML元素）和一个可选的 level 参数，用于指定当前缩进级别（默认为0）。
缩进XML：在 indent 函数内部，我们通过修改XML元素的 text 和 tail 属性来添加缩进。其中 text 属性表示在开始标签之后的文本，而 tail 属性表示在结束标签之前的文本。通过向这些属性添加缩进，我们实现了漂亮的打印效果。
定义 pretty_print_xml_elementtree 函数：该函数接受一个XML字符串作为输入，负责使用 xml.etree.ElementTree 解析和漂亮打印XML。
解析XML字符串：在 pretty_print_xml_elementtree 函数内部，我们使用 ET.fromstring() 方法解析XML字符串并创建一个ElementTree对象。
缩进XML：我们在XML的根元素上调用 indent() 函数，以递归方式将缩进添加到所有元素中。
将XML元素转换回字符串：我们使用 ET.tostring() 方法将XML元素转换回字符串表示。我们通过将encoding参数值设置为 "unicode" 来确保正确编码生成的字符串。
打印漂亮的XML：最后，我们打印结果漂亮的XML字符串。

这两个程序提供了不同的方法来实现XML的漂亮打印。第一个程序利用了 xml.dom.minidom 提供的DOM API来解析和漂亮打印XML，而第二个程序使用 xml.etree.ElementTree 模块，并定义了一个自定义函数来递归地为XML元素添加缩进。

下面是使用上述两种方法的程序示例−

方法1：使用xml.dom.minidom

import xml.dom.minidom

def pretty_print_xml_minidom(xml_string):
   # Parse the XML string
   dom = xml.dom.minidom.parseString(xml_string)

   # Pretty print the XML
   pretty_xml = dom.toprettyxml(indent="  ")

   # Remove empty lines
   pretty_xml = "\n".join(line for line in pretty_xml.split("\n") if line.strip())

   # Print the pretty XML
   print(pretty_xml)

# Example usage
xml_string = '''
<root>
  <element attribute="value">
   <subelement>Text</subelement>
  </element>
</root>
'''

pretty_print_xml_minidom(xml_string)

输出

<?xml version="1.0" ?>
<root>
  <element attribute="value">
   <subelement>Text</subelement>
  </element>
</root>

方法2：使用xml.etree.ElementTree

import xml.etree.ElementTree as ET

def indent(elem, level=0):
   # Add indentation
   indent_size = "  "
   i = "\n" + level * indent_size
   if len(elem):
      if not elem.text or not elem.text.strip():
         elem.text = i + indent_size
      if not elem.tail or not elem.tail.strip():
         elem.tail = i
      for elem in elem:
         indent(elem, level + 1)
      if not elem.tail or not elem.tail.strip():
         elem.tail = i
   else:
      if level and (not elem.tail or not elem.tail.strip()):
         elem.tail = i

def pretty_print_xml_elementtree(xml_string):
   # Parse the XML string
   root = ET.fromstring(xml_string)

   # Indent the XML
   indent(root)

   # Convert the XML element back to a string
   pretty_xml = ET.tostring(root, encoding="unicode")

   # Print the pretty XML
   print(pretty_xml)

# Example usage
xml_string = '''
<root>
  <element attribute="value">
   <subelement>Text</subelement>
  </element>
</root>
'''

pretty_print_xml_elementtree(xml_string)

输出

<root>
  <element attribute="value">
   <subelement>Text</subelement>
  </element>
</root>

结论

总之，Python中的XML美化对于提高XML数据的可读性和结构是必不可少的。无论是使用xml.dom.minidom还是xml.etree.ElementTree库，开发人员都可以轻松地以适当的缩进格式化XML。通过采用这些技术，程序员可以增强代码理解能力，简化调试过程，并在处理Python项目中的XML数据时促进更好的协作。