Pretty Printing XML Files with Python's ElementTree

Problem Background and Core Challenges

In Python programming, processing XML data often requires saving generated XML tree structures to files in a human-readable format. ElementTree, as part of Python's standard library, provides basic XML handling capabilities, but its default write() method outputs XML files in a compact format without proper indentation or line breaks, making them difficult to read and debug. Users extracting data from SQLite databases and generating XML files encounter this typical issue: while minidom.parseString(ET.tostring(root)).toprettyxml(indent=" ") enables pretty printing in the console, directly calling tree.write() to write to a file fails to preserve formatting.

Solution 1: Combining minidom with File Operations

The most straightforward and widely compatible solution involves using the toprettyxml() method from the xml.dom.minidom module to generate a prettified XML string, then saving it to the target file via standard file operations. The implementation steps are as follows:

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

# Assuming root is a constructed Element object
xmlstr = minidom.parseString(ET.tostring(root)).toprettyxml(indent="   ")
with open("New_Database.xml", "w") as f:
    f.write(xmlstr)

The core of this method lies in the toprettyxml() function, which accepts an indent parameter to specify the indentation string (e.g., three spaces) and automatically adds line breaks, producing well-structured XML text. Note that in Python 2.x, toprettyxml() may return a Unicode string, potentially causing encoding issues when written directly to a file. In such cases, explicit encoding should be specified:

with open("New_Database.xml", "w") as f:
    f.write(xmlstr.encode('utf-8'))

This handling ensures cross-version compatibility, especially when dealing with XML content containing non-ASCII characters.

Solution 2: Using ElementTree's indent Function (Python 3.9+)

For developers using Python 3.9 and above, the ElementTree library introduces the indent() function, offering a more integrated solution for pretty printing. This function directly manipulates Element or ElementTree objects to add visual indentation:

import xml.etree.ElementTree as ET

tree = ET.ElementTree(root)
ET.indent(tree, space="\t", level=0)
tree.write("New_Database.xml", encoding="utf-8")

The indent() function's space parameter defines the string for each indentation level (defaulting to two spaces), while the level parameter handles nested indentation. This approach simplifies code structure by avoiding extra string conversion steps but is limited to newer Python versions.

Technical Details and Best Practices

When implementing XML pretty printing, several key points should be noted. First, ElementTree's tostring() method generates byte strings by default, and toprettyxml() expects string input, making direct passing feasible. Second, file writing should explicitly specify encoding (e.g., UTF-8) to ensure cross-platform consistency. For large XML files, streaming or chunked writing is recommended to prevent memory overflow. Additionally, while the indent() function offers convenience, the minidom solution is more flexible for backward compatibility or complex formatting needs.

Conclusion and Extended Considerations

The two methods discussed in this article each have advantages: the minidom solution is highly compatible across all Python versions, whereas the indent() function provides a more modern API. In practice, the choice depends on project environment, performance requirements, and team preferences. Regardless of the method, the core goal is to enhance the readability and maintainability of XML files. For advanced XML processing needs, such as custom formatting rules or performance optimization, developers can explore third-party libraries like lxml. By mastering these techniques, developers can handle XML data more efficiently, improving code quality and development experience.