Python3 XML 解析

XML とは？

XML は拡張可能なマークアップ言語（eXtensible Markup LXtensible Markup Language）であり、標準汎用マークアップ言語の部分集合で、電子ファイルに構造を持たせるためのマークアップ言語です。このサイトで学習できます。XML チュートリアル

XML はデータの転送と保存のために設計されています。

XML は意味的なマークを定義する規則のセットであり、これらのマークは文書を多くの部分に分割し、それらの部分を識別します。

また、XML はメタマークアップ言語でもあり、特定のドメインに関連する、意味論的で構造化されたマークアップ言語を定義するための構文言語を定義します。

Python による XML の解析

一般的な XML プログラミングインターフェースには DOM と SAX があり、これら2つのインターフェースは XML ファイルの処理方法が異なるため、使用場面も異なります。

Python には XML を解析する3つの方法があります：ElementTree、SAX、DOM です。

1. ElementTree

xml.etree.ElementTree は Python 標準ライブラリで XML を処理するためのモジュールで、XML 文書を解析・生成するためのシンプルで効率的な API を提供します。

2.SAX (simple API for XML )

Python 標準ライブラリには SAX パーサーが含まれており、SAX はイベント駆動モデルを使用し、XML を解析する過程でイベントを次々と発生させ、ユーザー定義のコールバック関数を呼び出して XML ファイルを処理します。

3.DOM(Document Object Model)

XML データをメモリ内でツリーとして解析し、ツリーの操作を通じて XML を操作します。

この章で使用する XML サンプルファイルmovies.xml内容は次のとおりです：

例

<collection shelf="New Arrivals">
<movie title="Enemy Behind">
<type>War, Thriller</type>
<format>DVD</format>
<year>2003</year>
<rating>PG</rating>
<stars>10</stars>
<description>Talk about a US-Japan war</description>
</movie>
<movie title="Transformers">
<type>Anime, Science Fiction</type>
<format>DVD</format>
<year>1989</year>
<rating>R</rating>
<stars>8</stars>
<description>A schientific fiction</description>
</movie>
<movie title="Trigun">
<type>Anime, Action</type>
<format>DVD</format>
<episodes>4</episodes>
<rating>PG</rating>
<stars>10</stars>
<description>Vash the Stampede!</description>
</movie>
<movie title="Ishtar">
<type>Comedy</type>
<format>VHS</format>
<rating>PG</rating>
<stars>2</stars>
<description>Viewable boredom</description>
</movie>
</collection>

Python での ElementTree を使った xml 解析

xml.etree.ElementTreePython 標準ライブラリで XML を処理するためのモジュールです。

以下は xml.etree.ElementTree モジュールの主要な概念と使用法です：

ElementTree と Element オブジェクト：

ElementTree： ElementTree クラスは XML 文書のツリー表現です。1つ以上の Element オブジェクトを含み、XML 文書全体を表します。
Element： Element オブジェクトは XML 文書内の要素の表現です。各要素にはタグ、一連の属性、およびゼロ個以上の子要素があります。

XML の解析

fromstring() メソッド： fromstring() メソッドを使用すると、XML データを含む文字列を Element オブジェクトに変換できます：

例

import xml.etree.ElementTree as ET

xml_string = '<root><element>Some data</element></root>'
root = ET.fromstring(xml_string)

parse() メソッド： XML データがファイルに保存されている場合は、parse() メソッドを使用して XML 文書全体を解析できます：

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

XML ツリーの走査

find() メソッド： find() メソッドを使用すると、指定したタグを持つ最初の子要素を見つけることができます：

title_element = root.find('title')

findall() メソッド： findall() メソッドを使用すると、指定したタグを持つすべての子要素を見つけることができます：

book_elements = root.findall('book')

要素の属性とテキスト内容へのアクセス

attrib属性： attrib プロパティを使用すると、要素の属性にアクセスできます：

price = book_element.attrib['price']

text属性： text プロパティを使用すると、要素のテキスト内容にアクセスできます：

title_text = title_element.text

XML の作成

Element() コンストラクター： Element() コンストラクターを使用すると、新しい要素を作成できます：

new_element = ET.Element('new_element')

SubElement() 関数： SubElement() 関数を使用すると、指定したタグを持つ子要素を作成できます：

new_sub_element = ET.SubElement(root, 'new_sub_element')

XML の変更

要素の属性とテキスト内容の変更：要素の attrib と text プロパティを直接変更します。

要素の削除： remove() メソッドを使用すると、要素を削除できます：

root.remove(title_element)

XML コンテンツの簡単な読み取り：

例

import xml.etree.ElementTree as ET

# XML 文字列を定義する
xml_string = '''
<bookstore>
<book>
<title>Introduction to Python</title>
<author>John Doe</author>
<price>29.99</price>
</book>
<book>
<title>Data Science with Python</title>
<author>Jane Smith</author>
<price>39.95</price>
</book>
</bookstore>
'''

# ElementTree を使用して XML 文字列を解析する
root = ET.fromstring(xml_string)

# XML ツリーを走査する
for book in root.findall('book'):
title = book.find('title').text
author = book.find('author').text
price = book.find('price').text
print(f'Title: {title}, Author: {author}, Price: {price}')

上記のコードを実行した出力結果は次のとおりです：

Title: Introduction to Python, Author: John Doe, Price: 29.99
Title: Data Science with Python, Author: Jane Smith, Price: 39.95

次に、書籍情報を含む XML 文書を作成し、そのモジュールを使用して解析・操作します：

例

import xml.etree.ElementTree as ET

# XML 文書を作成する
root = ET.Element('bookstore')

# 1冊目の本を追加する
book1 = ET.SubElement(root, 'book')
title1 = ET.SubElement(book1, 'title')
title1.text = 'Introduction to Python'
author1 = ET.SubElement(book1, 'author')
author1.text = 'John Doe'
price1 = ET.SubElement(book1, 'price')
price1.text = '29.99'

# 2冊目の本を追加する
book2 = ET.SubElement(root, 'book')
title2 = ET.SubElement(book2, 'title')
title2.text = 'Data Science with Python'
author2 = ET.SubElement(book2, 'author')
author2.text = 'Jane Smith'
price2 = ET.SubElement(book2, 'price')
price2.text = '39.95'

# XML 文書をファイルに保存する
tree = ET.ElementTree(root)
tree.write('books.xml')

# ファイルから XML 文書を解析する
parsed_tree = ET.parse('books.xml')
parsed_root = parsed_tree.getroot()

# XML ツリーを走査して書籍情報を出力する
for book in parsed_root.findall('book'):
title = book.find('title').text
author = book.find('author').text
price = book.find('price').text
print(f'Title: {title}, Author: {author}, Price: {price}')

上記の例では、まず2冊の本の情報を含む XML 文書を作成し、その文書を books.xml ファイルに保存します。次に、ET.parse() メソッドを使用してファイル内の XML 文書を解析し、文書ツリーを走査して、各本のタイトル、作者、価格情報を抽出して出力します。

Python での SAX を使用した xml 解析

SAX はイベント駆動型のAPIです。

SAX を使用して XML 文書を解析するには、2つの部分が必要です：パーサーとイベントハンドラー。

パーサーは XML 文書を読み取り、要素の開始や終了などのイベントをイベントハンドラーに送信します。

一方、イベントハンドラーはイベントに応答し、渡された XML データを処理します。

1、大きなファイルを処理する；
2、ファイルの一部の内容だけが必要、またはファイルから特定の情報だけを取得したい場合。
3、独自のオブジェクトモデルを構築したい場合。

Python で sax 方式を使用して xml を処理するには、まず xml.sax の parse 関数と、xml.sax.handler の ContentHandler をインポートする必要があります。

ContentHandler クラスのメソッドの紹介

characters(content) メソッド

呼び出しタイミング：

行の先頭からタグに遭遇するまでの間に文字が存在する場合、content の値はそれらの文字列になります。

あるタグから次のタグに遭遇するまでの間に文字が存在する場合、content の値はそれらの文字列になります。

あるタグから行終了記号に遭遇するまでの間に文字が存在する場合、content の値はそれらの文字列になります。

タグは開始タグでも終了タグでもかまいません。

startDocument() メソッド

文書の開始時に呼び出されます。

endDocument() メソッド

パーサーが文書の末尾に達したときに呼び出されます。

startElement(name, attrs) メソッド

XML の開始タグに遭遇したときに呼び出されます。name はタグ名、attrs はタグの属性値の辞書です。

endElement(name) メソッド

XML の終了タグに遭遇したときに呼び出されます。

make_parser メソッド

以下のメソッドは新しいパーサーオブジェクトを作成して返します。

xml.sax.make_parser( [parser_list] )

パラメータの説明：

parser_list- オプションのパラメータ、パーサーのリスト

parser メソッド

以下のメソッドは SAX パーサーを作成し、xml 文書を解析します：

xml.sax.parse( xmlfile, contenthandler[, errorhandler])

パラメータの説明：

xmlfile- xml ファイル名
contenthandler- ContentHandler オブジェクトである必要があります
errorhandler- このパラメータを指定する場合、errorhandler は SAX ErrorHandler オブジェクトである必要があります

parseString メソッド

parseStringメソッドはXMLパーサーを作成し、XML文字列を解析します：

xml.sax.parseString(xmlstring, contenthandler[, errorhandler])

パラメータの説明:

xmlstring- XML文字列
contenthandler- ContentHandler オブジェクトである必要があります
errorhandler- このパラメータを指定する場合、errorhandler は SAX ErrorHandler オブジェクトである必要があります

Python による XML 解析の例

例

#!/usr/bin/python3

import xml.sax

class MovieHandler( xml.sax.ContentHandler ):
def __init__(self):
self.CurrentData = ""
self.type = ""
self.format = ""
self.year = ""
self.rating = ""
self.stars = ""
self.description = ""

# 要素開始時に呼び出される
def startElement(self, tag, attributes):
self.CurrentData = tag
if tag == "movie":
print ("*****Movie*****")
title = attributes["title"]
print ("Title:", title)

# 要素終了時に呼び出される
def endElement(self, tag):
if self.CurrentData == "type":
print ("Type:", self.type)
elif self.CurrentData == "format":
print ("Format:", self.format)
elif self.CurrentData == "year":
print ("Year:", self.year)
elif self.CurrentData == "rating":
print ("Rating:", self.rating)
elif self.CurrentData == "stars":
print ("Stars:", self.stars)
elif self.CurrentData == "description":
print ("Description:", self.description)
self.CurrentData = ""

# 文字読み取り時に呼び出される
def characters(self, content):
if self.CurrentData == "type":
self.type = content
elif self.CurrentData == "format":
self.format = content
elif self.CurrentData == "year":
self.year = content
elif self.CurrentData == "rating":
self.rating = content
elif self.CurrentData == "stars":
self.stars = content
elif self.CurrentData == "description":
self.description = content

if ( __name__ == "__main__"):

# XMLReader を作成する
parser = xml.sax.make_parser()
# 名前空間を閉じる
parser.setFeature(xml.sax.handler.feature_namespaces, 0)

# ContextHandler をオーバーライドする
Handler = MovieHandler()
parser.setContentHandler( Handler )

parser.parse("movies.xml")

上記コードの実行結果は次のとおりです：

*****Movie*****
Title: Enemy Behind
Type: War, Thriller
Format: DVD
Year: 2003
Rating: PG
Stars: 10
Description: Talk about a US-Japan war
*****Movie*****
Title: Transformers
Type: Anime, Science Fiction
Format: DVD
Year: 1989
Rating: R
Stars: 8
Description: A schientific fiction
*****Movie*****
Title: Trigun
Type: Anime, Action
Format: DVD
Rating: PG
Stars: 10
Description: Vash the Stampede!
*****Movie*****
Title: Ishtar
Type: Comedy
Format: VHS
Rating: PG
Stars: 2
Description: Viewable boredom

完全な SAX API ドキュメントはこちらを参照してくださいPython SAX APIs

xml.dom を使用した xml 解析

文書オブジェクトモデル（Document Object Model、略してDOM）は、W3Cが推奨する拡張可能マークアップ言語を処理するための標準プログラミングインターフェースです。

DOMパーサーはXMLドキュメントを解析する際、ドキュメント全体を一度に読み取り、ドキュメント内のすべての要素をメモリ内のツリー構造に保存します。その後、DOMが提供するさまざまな関数を使用して、ドキュメントの内容と構造を読み取ったり変更したりでき、変更した内容をXMLファイルに書き込むこともできます。

Pythonでは xml.dom.minidom を使用してXMLファイルを解析します。例は次のとおりです：

例

#!/usr/bin/python3

from xml.dom.minidom import parse
import xml.dom.minidom

# minidomパーサーを使用してXMLドキュメントを開く
DOMTree = xml.dom.minidom.parse("movies.xml")
collection = DOMTree.documentElement
if collection.hasAttribute("shelf"):
print ("Root element : %s" % collection.getAttribute("shelf"))

# コレクション内のすべての映画を取得する
movies = collection.getElementsByTagName("movie")

# 各映画の詳細情報を出力する
for movie in movies:
print ("*****Movie*****")
if movie.hasAttribute("title"):
print ("Title: %s" % movie.getAttribute("title"))

type = movie.getElementsByTagName('type')[0]
print ("Type: %s" % type.childNodes[0].data)
format = movie.getElementsByTagName('format')[0]
print ("Format: %s" % format.childNodes[0].data)
rating = movie.getElementsByTagName('rating')[0]
print ("Rating: %s" % rating.childNodes[0].data)
description = movie.getElementsByTagName('description')[0]
print ("Description: %s" % description.childNodes[0].data)

上記プログラムの実行結果は次のとおりです：

Root element : New Arrivals
*****Movie*****
Title: Enemy Behind
Type: War, Thriller
Format: DVD
Rating: PG
Description: Talk about a US-Japan war
*****Movie*****
Title: Transformers
Type: Anime, Science Fiction
Format: DVD
Rating: R
Description: A schientific fiction
*****Movie*****
Title: Trigun
Type: Anime, Action
Format: DVD
Rating: PG
Description: Vash the Stampede!
*****Movie*****
Title: Ishtar
Type: Comedy
Format: VHS
Rating: PG
Description: Viewable boredom

完全な DOM API ドキュメントはこちらを参照してくださいPython DOM APIs。

その他の拡張機能

Python3上級チュートリアル