Python格式化XML的三種常見(jiàn)方法詳解

更新時(shí)間：2026年04月09日 08:16:45 作者：detayun

XML是一種廣泛使用的標(biāo)記語(yǔ)言,用于存儲(chǔ)和傳輸結(jié)構(gòu)化數(shù)據(jù),本文主要介紹了Python中格式化XML的三種主要方法,并討論了不同方法的性能差異和適用場(chǎng)景,希望對(duì)大家有所幫助

XML（eXtensible Markup Language）是一種廣泛使用的標(biāo)記語(yǔ)言，用于存儲(chǔ)和傳輸結(jié)構(gòu)化數(shù)據(jù)。在Python開(kāi)發(fā)中，我們經(jīng)常需要處理XML數(shù)據(jù)，包括解析、修改和生成XML。格式化XML（即美化輸出，添加適當(dāng)?shù)目s進(jìn)和換行）能顯著提高代碼的可讀性和調(diào)試效率。本文將詳細(xì)介紹如何在Python中對(duì)XML進(jìn)行格式化處理。

1. XML基礎(chǔ)回顧

XML由標(biāo)簽（tags）、屬性和文本內(nèi)容組成，具有層級(jí)結(jié)構(gòu)。一個(gè)簡(jiǎn)單的XML示例：

<person>
    <name>Alice</name>
    <age>25</age>
    <skills>
        <skill>Python</skill>
        <skill>Data Analysis</skill>
    </skills>
</person>

Python中處理XML的主要標(biāo)準(zhǔn)庫(kù)包括：

xml.etree.ElementTree（簡(jiǎn)稱ET）：輕量級(jí)，適合基本操作
minidom：提供DOM接口，支持格式化輸出
lxml：第三方庫(kù)，功能強(qiáng)大，性能優(yōu)異

2. 使用xml.dom.minidom進(jìn)行格式化

minidom是Python標(biāo)準(zhǔn)庫(kù)的一部分，提供了簡(jiǎn)單的格式化方法：

2.1 基本格式化示例

from xml.dom import minidom

xml_str = """
<person>
<name>Alice</name><age>25</age>
<skills><skill>Python</skill><skill>Data Analysis</skill></skills>
</person>
"""

# 解析XML字符串
dom = minidom.parseString(xml_str)

# 獲取格式化后的XML字符串
formatted_xml = dom.toprettyxml(indent="  ", encoding="utf-8").decode()

print("格式化后的XML:")
print(formatted_xml)

輸出結(jié)果：

<?xml version="1.0" ?>
<person>
  <name>Alice</name>
  <age>25</age>
  <skills>
    <skill>Python</skill>
    <skill>Data Analysis</skill>
  </skills>
</person>

2.2 處理文件

# 從文件讀取并格式化
with open("input.xml", "r") as f:
    dom = minidom.parse(f)
    formatted_xml = dom.toprettyxml(indent="    ")

# 寫(xiě)入格式化后的XML到新文件
with open("output_formatted.xml", "w") as f:
    f.write(formatted_xml)

2.3 注意事項(xiàng)

toprettyxml()默認(rèn)會(huì)添加X(jué)ML聲明（<?xml version="1.0" ?>）
每次調(diào)用toprettyxml()都會(huì)在文本節(jié)點(diǎn)前后添加換行符，可能導(dǎo)致重復(fù)換行
對(duì)于大型XML文件，minidom可能不是最高效的選擇

3. 使用lxml庫(kù)進(jìn)行更專業(yè)的格式化

lxml是一個(gè)功能強(qiáng)大的第三方庫(kù)，提供了更靈活的格式化選項(xiàng)：

3.1 安裝lxml

pip install lxml

3.2 基本格式化示例

from lxml import etree

xml_str = """
<person>
<name>Alice</name><age>25</age>
<skills><skill>Python</skill><skill>Data Analysis</skill></skills>
</person>
"""

# 解析XML
root = etree.fromstring(xml_str)

# 創(chuàng)建ElementTree對(duì)象
tree = etree.ElementTree(root)

# 格式化輸出（方法1）
formatted_xml = etree.tostring(
    root, 
    pretty_print=True, 
    encoding="unicode", 
    xml_declaration=True
)

print("格式化后的XML:")
print(formatted_xml)

3.3 更精細(xì)的控制

lxml允許更精細(xì)地控制格式化：

# 更復(fù)雜的格式化選項(xiàng)
formatted_xml = etree.tostring(
    root,
    pretty_print=True,
    encoding="unicode",
    doctype='<!DOCTYPE person SYSTEM "person.dtd">',  # 可選DOCTYPE
    xml_declaration=True,
    with_tail=True  # 保留元素后的文本
)

3.4 處理文件

# 從文件讀取并格式化
parser = etree.XMLParser(remove_blank_text=True)  # 可選：移除空白文本
tree = etree.parse("input.xml", parser)

# 寫(xiě)入格式化后的XML
tree.write(
    "output_lxml.xml",
    pretty_print=True,
    encoding="utf-8",
    xml_declaration=True,
    doctype='<!DOCTYPE person SYSTEM "person.dtd">'
)

4. 使用xml.etree.ElementTree手動(dòng)格式化

雖然ElementTree本身不提供直接的格式化方法，但我們可以手動(dòng)實(shí)現(xiàn)：

import xml.etree.ElementTree as ET

def prettify(element, indent="  ", level=0):
    """遞歸格式化ElementTree元素"""
    result = []
    # 處理元素開(kāi)始標(biāo)簽
    result.append(indent * level + f"<{element.tag}")
    if element.attrib:
        for k, v in element.attrib.items():
            result.append(f' {k}="{v}"')
    result.append(">\n")
    
    # 處理子元素
    for child in element:
        result.append(prettify(child, indent, level + 1))
    
    # 處理文本內(nèi)容
    if element.text and element.text.strip():
        result.append(indent * (level + 1) + element.text.strip() + "\n")
    
    # 處理元素結(jié)束標(biāo)簽
    result.append(indent * level + f"</{element.tag}>\n")
    
    return "".join(result)

# 示例使用
xml_str = """
<person>
<name>Alice</name><age>25</age>
<skills><skill>Python</skill><skill>Data Analysis</skill></skills>
</person>
"""

root = ET.fromstring(xml_str)
formatted_xml = prettify(root)

print("手動(dòng)格式化的XML:")
print(formatted_xml)

這種方法提供了最大的靈活性，但需要自己處理所有邊緣情況。

5. 實(shí)際應(yīng)用場(chǎng)景示例

5.1 美化API返回的XML

import requests
from lxml import etree

response = requests.get('https://example.com/api/data.xml')
if response.status_code == 200:
    root = etree.fromstring(response.content)
    pretty_xml = etree.tostring(
        root, 
        pretty_print=True, 
        encoding="unicode"
    )
    print("格式化后的API響應(yīng):")
    print(pretty_xml)
else:
    print(f"請(qǐng)求失敗，狀態(tài)碼: {response.status_code}")

5.2 配置文件處理

from lxml import etree

# 原始配置
config = """
<config>
<database><host>localhost</host><port>5432</port></database>
<logging level="INFO"/>
</config>
"""

# 解析并格式化
root = etree.fromstring(config)
formatted_config = etree.tostring(
    root,
    pretty_print=True,
    encoding="unicode",
    xml_declaration=True
)

# 保存到文件
with open("config_formatted.xml", "w") as f:
    f.write(formatted_config)

6. 性能比較

對(duì)于大型XML文件，不同方法的性能差異明顯：

import time
from xml.dom import minidom
from lxml import etree
import xml.etree.ElementTree as ET

# 生成大型XML
large_xml = "<root>" + "".join([f"<item id='{i}'/>" for i in range(10000)]) + "</root>"

# 測(cè)試minidom
start = time.time()
dom = minidom.parseString(large_xml)
_ = dom.toprettyxml()
print(f"minidom耗時(shí): {time.time()-start:.2f}秒")

# 測(cè)試lxml
start = time.time()
root = etree.fromstring(large_xml)
_ = etree.tostring(root, pretty_print=True, encoding="unicode")
print(f"lxml耗時(shí): {time.time()-start:.2f}秒")

# 測(cè)試ElementTree手動(dòng)格式化（僅小樣本）
small_xml = "<root>" + "".join([f"<item id='{i}'/>" for i in range(100)]) + "</root>"
start = time.time()
root = ET.fromstring(small_xml)
_ = prettify(root)
print(f"ElementTree手動(dòng)格式化耗時(shí): {time.time()-start:.2f}秒")

典型結(jié)果：

minidom耗時(shí): 1.25秒
lxml耗時(shí): 0.05秒
ElementTree手動(dòng)格式化耗時(shí): 0.01秒（小樣本）

7. 總結(jié)與建議

簡(jiǎn)單需求：使用xml.dom.minidom的toprettyxml()方法，它是標(biāo)準(zhǔn)庫(kù)的一部分，無(wú)需額外安裝
專業(yè)需求：選擇lxml庫(kù)，它提供更強(qiáng)大的功能和更好的性能
特殊需求：如果需要完全控制格式化過(guò)程，可以考慮手動(dòng)實(shí)現(xiàn)或擴(kuò)展ElementTree方法
性能關(guān)鍵場(chǎng)景：對(duì)于非常大的XML文件，lxml通常是最佳選擇
避免重復(fù)換行：minidom可能會(huì)產(chǎn)生重復(fù)換行，必要時(shí)需要后處理