Convert XML to JSON in Python

Converting XML data to JSON is a common task when working with modern web applications and APIs. Python offers multiple ways to perform this conversion. This guide explains two approaches: using the ElementTree module and the Pandas library, with detailed examples and comparisons.

1. Sample XML File

Here’s a sample XML file data.xml:

<data>
    <record>
        <id>1</id>
        <name>John Doe</name>
        <age>30</age>
        <city>New York</city>
    </record>
    <record>
        <id>2</id>
        <name>Jane Smith</name>
        <age>25</age>
        <city>Los Angeles</city>
    </record>
    <record>
        <id>3</id>
        <name>Emily Davis</name>
        <age>35</age>
        <city>Chicago</city>
    </record>
</data>

2. Using Pandas `read_xml()` to Convert XML to JSON

The Pandas library provides the read_xml() method to easily parse XML data into a DataFrame, which can then be exported as a JSON file.

Code Example

import pandas as pd

# Input and output file paths
input_file = 'data.xml'
output_file = 'data.json'

# Read the XML file into a Pandas DataFrame
df = pd.read_xml(input_file)

# Export the DataFrame to a JSON file
df.to_json(output_file, orient='records', indent=4)

# Output confirmation
print(f"Data exported to {output_file} successfully.")

Explanation:

• pd.read_xml(): Parses the XML file and loads it into a DataFrame.
• df.to_json(): Exports the DataFrame to a JSON file.
• orient='records': Converts rows of the DataFrame into a list of dictionaries.
• indent=4: Pretty-prints the JSON with an indentation of 4 spaces.

3. Using ElementTree to Convert XML to JSON

The ElementTree module, part of Python’s standard library, allows you to parse XML files and write the data to a JSON file programmatically.

Code Example

import xml.etree.ElementTree as ET
import json

# Input and output file paths
input_file = 'data.xml'
output_file = 'data.json'

# Parse the XML file
tree = ET.parse(input_file)
root = tree.getroot()

# Extract data from XML
records = []

# Iterate through records
for record in root.findall('record'):
    data = {}
    for element in record:
        data[element.tag] = element.text
    records.append(data)

# Write data to JSON
with open(output_file, 'w', encoding='utf-8') as json_file:
    json.dump(records, json_file, indent=4)

print(f"Data exported to {output_file} successfully.")

Explanation:

• ET.parse(): Parses the XML file and creates a tree structure.
• root.findall('record'): Finds all the <record> elements in the XML file.
• json.dump(): Converts the Python dictionary into JSON format and writes it to a file.

4. Comparison of Methods

5. Which Method Should You Use?

Use Pandas `read_xml()` if:

• You need a quick and straightforward way to convert XML to JSON.
• The XML structure is flat and doesn't require advanced parsing.

Use ElementTree if:

• You need fine-grained control over XML parsing.
• The XML file has nested structures or requires custom handling.

Conclusion

Both methods are effective for converting XML to JSON in Python. Pandas is best for quick and simple tasks, while ElementTree offers flexibility for more complex requirements. Choose the approach that fits your specific use case.