[Python]XMLドキュメントを読み取る

一般に公開されているAPIを使用した時にJSONではなくXML形式で値が返ることがある。
PythonでXMLドキュメントを読み込み値を取得する方法に関してまとめる。

xmlの読み込み

サンプルのXMLとして公式ドキュメントに記載のある下記を使用する。

<?xml version="1.0"?>
<data>
    <country name="Liechtenstein">
        <rank>1</rank>
        <year>2008</year>
        <gdppc>141100</gdppc>
        <neighbor name="Austria" direction="E"/>
        <neighbor name="Switzerland" direction="W"/>
    </country>
    <country name="Singapore">
        <rank>4</rank>
        <year>2011</year>
        <gdppc>59900</gdppc>
        <neighbor name="Malaysia" direction="N"/>
    </country>
    <country name="Panama">
        <rank>68</rank>
        <year>2011</year>
        <gdppc>13600</gdppc>
        <neighbor name="Costa Rica" direction="W"/>
        <neighbor name="Colombia" direction="E"/>
    </country>
</data>

xmlファイルを読み込む場合は下記のように指定する。

import xml.etree.ElementTree as ET

tree = ET.parse('country_data.xml')
root = tree.getroot()

xmlの形式になっている文字列を読み込むことも可能。

root = ET.fromstring(xml)

fromstring()を使用することで変数rootにはxml.etree.ElementTree.Elementオブジェクトが代入される。
ノードの値や属性を取得するにはこのElementオブジェクトのプロパティやメソッドを使用する。

子ノードの値を取得

Elementオブジェクトはイテレート可能な子ノードを持つ。またタグ名はtag、属性はattribで取得することができる。
attribは属性を辞書形式で返す。

root = ET.fromstring(xml)
for child in root:
    print(child.tag, child.attrib)
# =>
country {'name': 'Liechtenstein'}
country {'name': 'Singapore'}
country {'name': 'Panama'}

タグの値を取得するためにはtextを使用する。
またElementオブジェクトの子ノードは入れ子になっているのでインデックスを指定してアクセスすることができる。

print(root[0][0].text)
# => 1
print(root[0][1].text)
# => 2008

特定要素の検索

取得したい要素（XMLタグ）を指定するには、そのタグがrootノードからどの位置にあるかで検索方法を変える。

rootの子ノードの場合：findall

rootの子ノードを取得するためにはfindall()を使用する。

for country in root.findall('country'):
    rank = country.find('rank').text
    print(rank)
# => 
1
4
68

find()は特定のタグで最初の子要素を検索。タグの値をtextで取得している。

任意のノードの場合：iter

任意のノードの場合はiter()を使用する。

for neighbor in root.iter('neighbor'):
    print(neighbor.attrib)
# =>
{'name': 'Austria', 'direction': 'E'}
{'name': 'Switzerland', 'direction': 'W'}
{'name': 'Malaysia', 'direction': 'N'}
{'name': 'Costa Rica', 'direction': 'W'}
{'name': 'Colombia', 'direction': 'E'}