ファイル

[Python] xml.etree.ElementTreeの使い方 – XMLの読み書き

2025-01-18更新日: 2025-01-18

xml.etree.ElementTreeは、PythonでXMLデータを扱うための標準ライブラリです。

XMLファイルの読み込み、解析、生成、書き込みが可能です。

XMLの読み込みにはElementTree.parse()を使用し、XML文字列からの解析にはElementTree.fromstring()を使います。

XMLの要素はElementオブジェクトとして表現され、find()やfindall()で特定の要素を検索できます。

XMLの書き込みにはElementTree.write()を使用し、ファイルに保存できます。

目次から探す

xml.etree.ElementTreeとは

xml.etree.ElementTreeは、Pythonに標準で搭載されているXML処理ライブラリです。

このライブラリを使用することで、XMLデータの読み込み、解析、生成、操作が簡単に行えます。

ElementTreeは、XML文書をツリー構造として表現し、各要素をノードとして扱います。

これにより、XMLの階層構造を直感的に操作できるため、特にデータの抽出や編集が容易になります。

ElementTreeは、シンプルなAPIを提供しており、初心者でも扱いやすいのが特徴です。

また、XMLの読み書きに関する基本的な機能が揃っているため、データのフォーマット変換や設定ファイルの管理など、さまざまな用途に利用できます。

XMLはデータの構造化に優れているため、ElementTreeを使うことで、効率的にデータを扱うことが可能です。

XMLの読み込み

XMLファイルの読み込み

XMLファイルを読み込むには、ElementTreeモジュールのparse()メソッドを使用します。

このメソッドは、指定したXMLファイルを解析し、ツリー構造を生成します。

import xml.etree.ElementTree as ET
# XMLファイルの読み込み
tree = ET.parse('sample.xml')

XML文字列の解析

XML文字列を解析するには、fromstring()メソッドを使用します。

このメソッドは、文字列からXMLツリーを生成します。

import xml.etree.ElementTree as ET
# XML文字列の解析
xml_string = '<root><child>テキスト</child></root>'
root = ET.fromstring(xml_string)

ルート要素の取得

XMLツリーのルート要素を取得するには、getroot()メソッドを使用します。

これにより、ツリーの最上位の要素を取得できます。

import xml.etree.ElementTree as ET
tree = ET.parse('sample.xml')
root = tree.getroot()
print(root.tag)  # ルート要素のタグ名を表示

子要素の取得

ルート要素や任意の要素の子要素を取得するには、find()やfindall()メソッドを使用します。

これにより、特定のタグ名を持つ子要素を取得できます。

import xml.etree.ElementTree as ET
tree = ET.parse('sample.xml')
root = tree.getroot()
child = root.find('child')  # 最初の子要素を取得
print(child.tag)  # 子要素のタグ名を表示

属性の取得

要素の属性を取得するには、attribプロパティを使用します。

これにより、要素の属性を辞書形式で取得できます。

import xml.etree.ElementTree as ET
tree = ET.parse('sample.xml')
root = tree.getroot()
for child in root:
    print(child.attrib)  # 各子要素の属性を表示

テキストの取得

要素のテキスト内容を取得するには、textプロパティを使用します。

これにより、要素内のテキストを簡単に取得できます。

import xml.etree.ElementTree as ET
tree = ET.parse('sample.xml')
root = tree.getroot()
for child in root:
    print(child.text)  # 各子要素のテキストを表示

これらのメソッドを使用することで、XMLデータを効率的に読み込むことができます。

XMLの書き込み

新しいXMLの作成

新しいXMLを作成するには、Elementクラスを使用してルート要素を作成し、その後に子要素を追加していきます。

import xml.etree.ElementTree as ET
# ルート要素の作成
root = ET.Element('root')
# 新しいXMLツリーの作成
tree = ET.ElementTree(root)

要素の追加

既存の要素に子要素を追加するには、append()メソッドを使用します。

これにより、ツリー構造を簡単に拡張できます。

import xml.etree.ElementTree as ET
root = ET.Element('root')
# 子要素の追加
child1 = ET.Element('child1')
child2 = ET.Element('child2')
root.append(child1)
root.append(child2)

属性の追加

要素に属性を追加するには、set()メソッドを使用します。

これにより、要素に任意の属性を設定できます。

import xml.etree.ElementTree as ET
root = ET.Element('root')
child = ET.Element('child')
child.set('attribute', 'value')  # 属性の追加
root.append(child)

テキストの追加

要素にテキストを追加するには、textプロパティを使用します。

これにより、要素内に任意のテキストを設定できます。

import xml.etree.ElementTree as ET
root = ET.Element('root')
child = ET.Element('child')
child.text = 'これはテキストです'  # テキストの追加
root.append(child)

XMLファイルへの書き込み

作成したXMLツリーをファイルに書き込むには、write()メソッドを使用します。

これにより、指定したファイルにXMLデータを保存できます。

import xml.etree.ElementTree as ET
root = ET.Element('root')
child = ET.Element('child')
child.text = 'テキスト'
root.append(child)
# XMLファイルへの書き込み
tree = ET.ElementTree(root)
tree.write('output.xml', encoding='utf-8', xml_declaration=True)

XML文字列としての出力

XMLツリーを文字列として出力するには、tostring()メソッドを使用します。

これにより、XMLデータを文字列形式で取得できます。

import xml.etree.ElementTree as ET
root = ET.Element('root')
child = ET.Element('child')
child.text = 'テキスト'
root.append(child)
# XML文字列としての出力
xml_string = ET.tostring(root, encoding='utf-8').decode('utf-8')
print(xml_string)

これらの手法を用いることで、XMLデータの生成や編集が容易に行えます。

XMLの操作

要素の検索

XMLデータ内の要素を検索するためには、find()やfindall()メソッドを使用します。

これにより、特定の条件に合致する要素を簡単に取得できます。

find()メソッドの使い方

find()メソッドは、指定したタグ名を持つ最初の子要素を返します。

要素が見つからない場合はNoneを返します。

import xml.etree.ElementTree as ET
# XMLの読み込み
tree = ET.parse('sample.xml')
root = tree.getroot()
# 'child'タグを持つ最初の要素を検索
child = root.find('child')
if child is not None:
    print(child.text)  # 子要素のテキストを表示

findall()メソッドの使い方

findall()メソッドは、指定したタグ名を持つすべての子要素をリスト形式で返します。

要素が見つからない場合は空のリストを返します。

import xml.etree.ElementTree as ET
# XMLの読み込み
tree = ET.parse('sample.xml')
root = tree.getroot()
# 'child'タグを持つすべての要素を検索
children = root.findall('child')
for child in children:
    print(child.text)  # 各子要素のテキストを表示

要素の削除

要素を削除するには、親要素のremove()メソッドを使用します。

これにより、指定した子要素をツリーから削除できます。

import xml.etree.ElementTree as ET
# XMLの読み込み
tree = ET.parse('sample.xml')
root = tree.getroot()
# 'child'タグを持つ最初の要素を削除
child = root.find('child')
if child is not None:
    root.remove(child)  # 要素の削除

要素の更新

要素のテキストやタグ名を更新するには、textプロパティやtagプロパティを使用します。

import xml.etree.ElementTree as ET
# XMLの読み込み
tree = ET.parse('sample.xml')
root = tree.getroot()
# 'child'タグを持つ最初の要素を更新
child = root.find('child')
if child is not None:
    child.text = '新しいテキスト'  # テキストの更新
    child.tag = 'new_child'  # タグ名の更新

属性の更新

要素の属性を更新するには、set()メソッドを使用します。

既存の属性を新しい値に変更することができます。

import xml.etree.ElementTree as ET
# XMLの読み込み
tree = ET.parse('sample.xml')
root = tree.getroot()
# 'child'タグを持つ最初の要素の属性を更新
child = root.find('child')
if child is not None:
    child.set('attribute', '新しい値')  # 属性の更新

これらの操作を通じて、XMLデータを柔軟に管理し、必要に応じて変更を加えることができます。

応用例

XMLのネスト構造の操作

XMLは階層的なデータ構造を持つため、ネストされた要素を操作することがよくあります。

find()やfindall()メソッドを使用して、特定の深さにある要素を取得できます。

import xml.etree.ElementTree as ET
# XMLの読み込み
tree = ET.parse('nested.xml')
root = tree.getroot()
# ネストされた要素の取得
for parent in root.findall('parent'):
    for child in parent.findall('child'):
        print(child.text)  # ネストされた子要素のテキストを表示

名前空間を持つXMLの操作

XMLには名前空間を使用して、異なるスキーマの要素を区別することができます。

名前空間を扱うには、find()やfindall()メソッドで名前空間を指定します。

import xml.etree.ElementTree as ET
# XMLの読み込み
tree = ET.parse('namespaced.xml')
root = tree.getroot()
# 名前空間を指定して要素を検索
namespace = {'ns': 'http://example.com/ns'}
elements = root.findall('ns:child', namespace)
for elem in elements:
    print(elem.text)  # 名前空間を持つ要素のテキストを表示

大規模なXMLファイルの逐次処理

大規模なXMLファイルを一度にメモリに読み込むのは効率的ではありません。

iter()メソッドを使用して、要素を逐次処理することができます。

import xml.etree.ElementTree as ET
# 大規模なXMLファイルの逐次処理
for event, elem in ET.iterparse('large.xml'):
    if elem.tag == 'target':
        print(elem.text)  # 特定の要素のテキストを表示
    elem.clear()  # メモリを節約するために要素をクリア

XMLスキーマの検証

XMLスキーマを使用して、XMLデータの構造やデータ型を検証することができます。

Pythonではlxmlライブラリを使用することで、スキーマ検証が可能です。

from lxml import etree
# XMLとスキーマの読み込み
xml_doc = etree.parse('data.xml')
xml_schema_doc = etree.parse('schema.xsd')
xml_schema = etree.XMLSchema(xml_schema_doc)
# スキーマによる検証
if xml_schema.validate(xml_doc):
    print("XMLはスキーマに適合しています。")
else:
    print("XMLはスキーマに適合していません。")

XMLの整形と出力

XMLデータを整形して出力するには、minidomライブラリを使用することができます。

これにより、インデントを付けて可読性の高い形式で出力できます。

import xml.etree.ElementTree as ET
from xml.dom import minidom
# XMLの作成
root = ET.Element('root')
child = ET.Element('child')
child.text = 'テキスト'
root.append(child)
# XMLを整形して出力
xml_str = ET.tostring(root, encoding='utf-8')
pretty_xml = minidom.parseString(xml_str).toprettyxml(indent="  ")
print(pretty_xml)  # 整形されたXMLを表示

これらの応用例を通じて、XMLデータをより効果的に扱うことができ、さまざまなシナリオに対応することが可能です。