Pretty printing XML in Python

Dealing with different Python versions

Python’s soul doesn’t age, but its versions do change. If you're lucky to be with Python 3.9+, you'll find a pretty indent function in xml.etree.ElementTree. Let's beatify your XML:

import xml.etree.ElementTree as ET

def pretty_print_etree(xml_string):
    root = ET.fromstring(xml_string)
    ET.indent(root, space="\t", level=0)
    return ET.tostring(root, encoding='unicode', method='xml')  # The Pyramid of Cheops was not built in a day, but your pretty XML is

# Usage
pretty_xml = pretty_print_etree('<your_xml>')
print(pretty_xml)  # Let's unleash the beauty on the world


Advanced pretty printing with lxml

Like a Swiss Army Knife, lxml comes with an array of features. For pretty printing, use the pretty_print parameter in the tostring method.

from lxml import etree

def pretty_print_lxml(xml_string):
    root = etree.fromstring(xml_string)
    return etree.tostring(root, pretty_print=True).decode()

# Dancing to the pretty tune:
pretty_xml = pretty_print_lxml('<your_xml>')
print(pretty_xml)  # Your XML now sings better than T-Pain with Auto-Tune


Don't forget to check the all-you-can-eat lxml tutorial.

Respecting the elders - older Python versions

Old is gold! For those working on older Python versions, BeautifulSoup is the stalwart, especially with its prettify() function.

from bs4 import BeautifulSoup

def pretty_print_bs(xml_string):
    soup = BeautifulSoup(xml_string, 'xml')
    return soup.prettify()  # Abracadabra! Your XML is as pretty as Mona Lisa’s smile

# The magic wand wave:
pretty_xml = pretty_print_bs('<your_xml>')
print(pretty_xml)  # Fasten your seat-belts. We are time-traveling to a prettier XML era


Remember, BeautifulSoup is a kind guest who doesn't arrive uninvited. Install it first.

Common pitfalls and pro-tips

• XML Namespaces: Messing up with namespaces can turn a soap opera into a Greek tragedy. Keep them intact!
• Encoding: Do you like sushi served with mango? Neither does your XML like improper encodings.
• Regular Expressions: You can attempt re.DOTALL and regex for text node replacements, but beware. With great power comes great NullPointerExceptions (oops, wrong language).

Customizing the minidom output

There’s no one-size-fits-all in XML land. Customize your toprettyxml output, like ordering bespoke tuxedos.

from xml.dom import minidom

def pretty_print_minidom(xml_string, indent="   "):
    dom = minidom.parseString(xml_string)
    return dom.toprettyxml(indent=indent)

# Suit-up
pretty_xml = pretty_print_minidom('<your_xml>', indent="  ")
print(pretty_xml)  # Let the XML walk the red carpet


Customize the indent parameter as per your needs for the perfect fitted XML.

The beauty lies in the details

Tailored for your XML

Before getting your hands dirty with pretty printing, understand your XML. Namespaces, special characters, custom indentation needs, all matter. Use the right tool to make your XML look photogenic.

Make it faster

In high-speed, memory-crunched environments, pick your pretty printing tool wisely. Efficiency is that secret ingredient that turns your vanilla ice cream into a sundae.

Compatibility is key

Your Python code is not Tom Hanks in Cast Away. It has to play well with its environment. If your environment restricts certain Python versions or disallows external dependencies, make peace with it and use what you have.