8.13.1 関数

Comment( [text])

コメント・エレメントのファクトリーです。このファクトリー関数は XML コメントにシリアライズされる特別な要素を作ります。コメント文字列は、8-bit ASCII 文字列でも Unicode 文字列でも構いません。 text はそのコメント文字列を含んだ文字列です。

戻り値:: コメントを表わすエレメントのインスタンス。

dump( elem)

エレメントの木もしくはエレメントの構造を sys.stdout に書き込みます。この関数はデバグ目的でだけ使用してください。

出力される形式の正確なところは実装依存です。このバージョンでは、通常の XML ファイルとして書き込まれます。

elem はエレメントの木もしくは個別のエレメントです。

Element( tag[, attrib][, **extra])

エレメントのファクトリー。この関数は標準エレメント・インタフェースを実装したオブジェクトを返します。このオブジェクトのクラスや型が正確に何であるかは実装に依存しますが、いつでもこのモジュールにある _ElementInterface クラスと互換性があります。

エレメント名、アトリビュート名およびアトリビュート値は8-bit ASCII 文字列でも Unicode 文字列でも構いません。 tag はエレメント名です。 attrib はオプションの辞書で、エレメントのアトリビュートを含んでいます。 extra は追加のアトリビュートで、キーワード引数として与えられたものです。

戻り値:: エレメント・インスタンス。

fromstring( text)

文字列定数で与えられた XML 断片を構文解析します。XML 関数と同じです。 text は XML データを含んだ文字列です。

戻り値:: エレメント・インスタンス。

iselement( element)

オブジェクトが正当なエレメント・オブジェクトであるかをチェックします。 element はエレメント・インスタンスです。

戻り値:: 引数がエレメント・オブジェクトならば真値。

iterparse( source[, events])

XML 断片を構文解析してエレメントの木を漸増的に作っていき、その間進行状況をユーザーに報告します。 source は XML データを含むファイル名またはファイル風オブジェクト。 events は報告すべきイベントのリスト。省略された場合は ``end'' イベントだけが報告されます。

戻り値:: (イベント, エレメント) イテレータ。

parse( source[, parser])

XML 断片を構文解析してエレメントの木にしていきます。 source は XML データを含むファイル名またはファイル風オブジェクト。 parser はオプションの構文解析器インスタンスです。これが与えられない場合、標準の XMLTreeBuilder 構文解析器が使われます。

戻り値:: ElementTree インスタンス。

ProcessingInstruction( target[, text])

PI エレメントのファクトリー。このファクトリー関数は XML の処理命令(processing instruction) としてシリアライズされる特別なエレメントを作ります。 target は PI ターゲットを含んだ文字列です。 text は与えられるならば PI コンテンツを含んだ文字列です。

戻り値:: PI を表わすエレメント・インスタンス。

SubElement( parent, tag[, attrib] [, **extra])

部分エレメントのファクトリー。この関数はエレメント・インスタンスを作り、それを既存のエレメントに追加します。

エレメント名、アトリビュート名およびアトリビュート値は8-bit ASCII 文字列でも Unicode 文字列でも構いません。 parent は親エレメントです。 tag はエレメント名です。 attrib はオプションの辞書で、エレメントのアトリビュートを含んでいます。 extra は追加のアトリビュートで、キーワード引数として与えられたものです。

戻り値:: エレメント・インスタンス。

tostring( element[, encoding])

XML エレメントを全ての子エレメントを含めて表現する文字列を生成します。 element はエレメント・インスタンス。 encoding は出力エンコーディング(デフォルトは US-ASCII)です。

戻り値:: XML データを含んだエンコードされた文字列。

XML( text)

文字列定数で与えられた XML 断片を構文解析します。この関数は Python コードに「XML リテラル」を埋め込むのに使えます。 text は XML データを含んだ文字列です。

戻り値:: エレメント・インスタンス。

XMLID( text)

文字列定数で与えられた XML 断片を構文解析し、エレメント ID からエレメントへのマッピングを与える辞書も同時に返します。 text は XML データを含んだ文字列です。

戻り値:: エレメント・インスタンスと辞書のタプル。

ご意見やご指摘をお寄せになりたい方は、 このドキュメントについて... をご覧ください。