Python标准库xml.etree.ElementTreeElementTreeXMLAPI

函数¶

xml.etree.ElementInclude.default_loader(href, parse, encoding=None)¶

默认的加载器。 这个默认的加载器会从磁盘读取所包括的资源。 href 是一个 URL。 parse 是 "xml" 或 "text" 表示解析模式。 encoding 是可选的文本编码格式。 如果未给出，则编码格式为 utf-8。 返回已扩展的资源。 如果解析模式为 "xml"，则它是一个 ElementTree 实例。 如果解析模式为 "text"，则它是一个 Unicode 字符串。 如果加载器失败，它可以返回 None 或者引发异常。

xml.etree.ElementInclude.include(elem, loader=None)¶

This function expands XInclude directives. elem is the root element. loader is

an optional resource loader. If omitted, it defaults to default_loader().

If given, it should be a callable that implements the same interface as

default_loader(). Returns the expanded resource. If the parse mode is

"xml", this is an ElementTree instance. If the parse mode is "text",

this is a Unicode string. If the loader fails, it can return None or

raise an exception.

元素对象¶

class xml.etree.ElementTree.Element(tag, attrib={}, **extra)¶

元素类。 这个类定义了 Element 接口，并提供了这个接口的引用实现。

元素名、属性名和属性值可以是字节串或 Unicode 字符串。 tag 是元素名。 attrib 是一个可选的字典，其中包含元素属性。 extra 包含额外的属性，以关键字参数形式给出。

tag¶

一个标识此元素意味着何种数据的字符串(换句话说，元素类型)。

text¶

tail¶

这些属性可被用于存放与元素相关联的额外数据。 它们的值通常为字符串但也可以是任何应用专属的对象。 如果元素是基于 XML 文件创建的，text 属性会存放元素的开始标记及其第一个子元素或结束标记之间的文本，或者为 None，而 tail 属性会存放元素的结束标记及下一个标记之间的文本，或者为 None。 对于 XML 数据

<a><b>1<c>2<d/>3</c></b>4</a>

a 元素的 text 和 tail 属性均为 None，b 元素的 text 为 "1" 而 tail 为 "4"，c 元素的 text 为 "2" 而 tail 为 None，d 元素的 text 为 None 而 tail 为 "3"。

要获取一个元素的内部文本，请参阅 itertext()，例如 "".join(element.itertext())。

应用程序可以将任意对象存入这些属性。

attrib¶

一个包含元素属性的字典。 请注意虽然 attrib 值总是一个真正可变的 Python 字典，但 ElementTree 实现可以选择其他内部表示形式，并只在有需要时才创建字典。 为了发挥这种实现的优势，请在任何可能情况下使用下列字典方法。

以下字典类方法可作用于元素属性。

clear()¶

重设一个元素。 此方法会移除所有子元素，清空所有属性，并将 text 和 tail 属性设为 None。

get(key, default=None)¶

获取名为 key 的元素属性。

返回属性的值，或者如果属性未找到则返回 default。

items()¶

将元素属性以 (name, value) 对序列的形式返回。 所返回属性的顺序任意。

keys()¶

将元素属性名称以列表的形式返回。 所返回名称的顺序任意。

set(key, value)¶

将元素的 key 属性设为 value。

以下方法作用于元素的下级（子元素）。

append(subelement)¶

将元素 subelement 添加到此元素的子元素内部列表。 如果 subelement 不是一个 Element 则会引发 TypeError。

extend(subelements)¶

使用具有零个或多个元素的序列对象添加 subelements。 如果某个子元素不是 Element 则会引发 TypeError。

3.2 新版功能.

find(match, namespaces=None)¶

Finds the first subelement matching match. match may be a tag name

or a path. Returns an element instance

or None. namespaces is an optional mapping from namespace prefix

to full name.

findall(match, namespaces=None)¶

Finds all matching subelements, by tag name or

path. Returns a list containing all matching

elements in document order. namespaces is an optional mapping from

namespace prefix to full name.

findtext(match, default=None, namespaces=None)¶

Finds text for the first subelement matching match. match may be

a tag name or a path. Returns the text content

of the first matching element, or default if no element was found.

Note that if the matching element has no text content an empty string

is returned. namespaces is an optional mapping from namespace prefix

to full name.

getchildren()¶

3.2 版后已移除: Use list(elem) or iteration.

getiterator(tag=None)¶

3.2 版后已移除: Use method Element.iter() instead.

insert(index, subelement)¶

将 subelement 插入到此元素的给定位置中。 如果 subelement 不是一个 Element 则会引发 TypeError。

iter(tag=None)¶

创建一个以当前元素为根元素的树的 iterator。 该迭代器将以文档（深度优先）顺序迭代此元素及其所有下级元素。 如果 tag 不为 None 或 '*'，则迭代器只返回标记为 tag 的元素。 如果树结构在迭代期间被修改，则结果是未定义的。

3.2 新版功能.

iterfind(match, namespaces=None)¶

根据标记名称或者 路径 查找所有匹配的子元素。 返回一个按文档顺序产生所有匹配元素的可迭代对象。 namespaces 是可选的从命名空间前缀到完整名称的映射。

3.2 新版功能.

itertext()¶

创建一个文本迭代器。 该迭代器将按文档顺序遍历此元素及其所有子元素，并返回所有内部文本。

3.2 新版功能.

makeelement(tag, attrib)¶

创建一个与此元素类型相同的新元素对象。 请不要调用此方法，而应改用 SubElement() 工厂函数。

remove(subelement)¶

从元素中移除 subelement。 与 find* 方法不同的是此方法会基于实例的标识来比较元素，而不是基于标记的值或内容。

Element 对象还支持下列序列类型方法以配合子元素使用: __delitem__(), __getitem__(), __setitem__(), __len__()。

注意：不带子元素的元素将被检测为 False。 此行为将在未来的版本中发生变化。 请改用 len(elem) 或 elemisNone 进行检测。

element=root.find('foo')
ifnotelement:# careful!
print("element not found, or element has no subelements")
ifelementisNone:
print("element not found")

ElementTree 对象¶

class xml.etree.ElementTree.ElementTree(element=None, file=None)¶

ElementTree 包装器类。 这个类表示一个完整的元素层级结构，并添加了一些对于标准 XML 序列化的额外支持。

element 是根元素。 如果给出 XML file 则将使用其内容来初始化树结构。

_setroot(element)¶

替换该树结构的根元素。 这将丢弃该树结构的当前内容，并将其替换为给定的元素。 请小心使用。 element 是一个元素实例。

find(match, namespaces=None)¶

与 Element.find() 类似，从树的根节点开始。

findall(match, namespaces=None)¶

与 Element.findall() 类似，从树的根节点开始。

findtext(match, default=None, namespaces=None)¶

与 Element.findtext() 类似，从树的根节点开始。

getiterator(tag=None)¶

3.2 版后已移除: Use method ElementTree.iter() instead.

getroot()¶

返回这个树的根元素。

iter(tag=None)¶

创建并返回根元素的树结构迭代器。 该迭代器会以节顺序遍历这个树的所有元素。 tag 是要查找的标记（默认返回所有元素）。

iterfind(match, namespaces=None)¶

与 Element.iterfind() 类似，从树的根节点开始。

3.2 新版功能.

parse(source, parser=None)¶

将一个外部 XML 节载入到此元素树。 source 是一个文件名或 file object。 parser 是可选的解析器实例。 如果未给出，则会使用标准的 XMLParser 解析器。 返回该节的根元素。

write(file, encoding="us-ascii", xml_declaration=None, default_namespace=None, method="xml", *, short_empty_elements=True)¶

将元素树以 XML 格式写入到文件。 file 为文件名，或是以写入模式打开的 file object。 encoding 1 为输出编码格式 (默认为 US-ASCII)。 xml_declaration 控制是否要将 XML 声明添加到文件中。 使用 False 表示从不添加，True 表示总是添加，None 表示仅在非 US-ASCII 或 UTF-8 或 Unicode 时添加 (默认为 None)。 default_namespace 设置默认 XML 命名空间 (用于 "xmlns")。 method 为 "xml", "html" 或 "text" (默认为 "xml")。 仅限关键字形参 short_empty_elements 控制不包含内容的元素的格式。 如为 True (默认值)，它们会被输出为单个自结束标记，否则它们会被输出为一对开始/结束标记。

输出是一个字符串 (str) 或字节串 (bytes)。 由*encoding* 参数来控制。 如果 encoding 为 "unicode"，则输出是一个字符串；否则为字节串；请注意这可能与 file 的类型相冲突，如果它是一个打开的 file object 的话；请确保你不会试图写入字符串到二进制流或者反向操作。

3.4 新版功能: short_empty_elements 形参。

这是将要被操作的 XML 文件:

<html>
<head>
<title>Examplepage</title>
</head>
<body>
<p>Movedto<ahref="http://example.org/">example.org</a>
or<ahref="http://example.com/">example.com</a>.</p>
</body>
</html>

修改第一段中的每个链接的 "target" 属性的示例:

>>> fromxml.etree.ElementTreeimportElementTree
>>> tree=ElementTree()
>>> tree.parse("index.xhtml")
<Element 'html' at 0xb77e6fac>
>>> p=tree.find("body/p")# Finds first occurrence of tag p in body
>>> p
<Element 'p' at 0xb77ec26c>
>>> links=list(p.iter("a"))# Returns list of all links
>>> links
[<Element 'a' at 0xb77ec2ac>, <Element 'a' at 0xb77ec1cc>]
>>> foriinlinks:# Iterates through all found links
... i.attrib["target"]="blank"
>>> tree.write("output.xhtml")