Gecko [ v99win.today ]

Name	Size	Permission
2to3.html	63.71 KB	-rw-r--r--
__builtin__.html	11.79 KB	-rw-r--r--
__future__.html	15.58 KB	-rw-r--r--
__main__.html	8.33 KB	-rw-r--r--
_winreg.html	73.99 KB	-rw-r--r--
abc.html	26.82 KB	-rw-r--r--
aepack.html	15.47 KB	-rw-r--r--
aetools.html	18.79 KB	-rw-r--r--
aetypes.html	27.08 KB	-rw-r--r--
aifc.html	29.59 KB	-rw-r--r--
al.html	22.13 KB	-rw-r--r--
allos.html	35.48 KB	-rw-r--r--
anydbm.html	19.31 KB	-rw-r--r--
archiving.html	10.64 KB	-rw-r--r--
argparse.html	269.59 KB	-rw-r--r--
array.html	35.35 KB	-rw-r--r--
ast.html	42.42 KB	-rw-r--r--
asynchat.html	35.84 KB	-rw-r--r--
asyncore.html	43.22 KB	-rw-r--r--
atexit.html	19.23 KB	-rw-r--r--
audioop.html	41.32 KB	-rw-r--r--
autogil.html	9.77 KB	-rw-r--r--
base64.html	24.8 KB	-rw-r--r--
basehttpserver.html	40.6 KB	-rw-r--r--
bastion.html	13.02 KB	-rw-r--r--
bdb.html	50.06 KB	-rw-r--r--
binascii.html	26.64 KB	-rw-r--r--
binhex.html	12.66 KB	-rw-r--r--
bisect.html	28.52 KB	-rw-r--r--
bsddb.html	32.02 KB	-rw-r--r--
bz2.html	31.92 KB	-rw-r--r--
calendar.html	50.16 KB	-rw-r--r--
carbon.html	54.14 KB	-rw-r--r--
cd.html	35.24 KB	-rw-r--r--
cgi.html	58.4 KB	-rw-r--r--
cgihttpserver.html	15.12 KB	-rw-r--r--
cgitb.html	13.5 KB	-rw-r--r--
chunk.html	17.41 KB	-rw-r--r--
cmath.html	32.41 KB	-rw-r--r--
cmd.html	32.69 KB	-rw-r--r--
code.html	28.92 KB	-rw-r--r--
codecs.html	125.92 KB	-rw-r--r--
codeop.html	16.42 KB	-rw-r--r--
collections.html	150.36 KB	-rw-r--r--
colorpicker.html	9.02 KB	-rw-r--r--
colorsys.html	14.38 KB	-rw-r--r--
commands.html	16.63 KB	-rw-r--r--
compileall.html	21.18 KB	-rw-r--r--
compiler.html	78.14 KB	-rw-r--r--
configparser.html	73.92 KB	-rw-r--r--
constants.html	14.68 KB	-rw-r--r--
contextlib.html	22.91 KB	-rw-r--r--
cookie.html	45.38 KB	-rw-r--r--
cookielib.html	102.78 KB	-rw-r--r--
copy.html	14.21 KB	-rw-r--r--
copy_reg.html	15.82 KB	-rw-r--r--
crypt.html	11.62 KB	-rw-r--r--
crypto.html	8.35 KB	-rw-r--r--
csv.html	82.79 KB	-rw-r--r--
ctypes.html	280.57 KB	-rw-r--r--
curses.ascii.html	28.97 KB	-rw-r--r--
curses.html	200.94 KB	-rw-r--r--
curses.panel.html	18.43 KB	-rw-r--r--
custominterp.html	8.59 KB	-rw-r--r--
datatypes.html	18.84 KB	-rw-r--r--
datetime.html	261.02 KB	-rw-r--r--
dbhash.html	18.4 KB	-rw-r--r--
dbm.html	14.75 KB	-rw-r--r--
debug.html	11.28 KB	-rw-r--r--
decimal.html	239.14 KB	-rw-r--r--
development.html	15.27 KB	-rw-r--r--
difflib.html	96.93 KB	-rw-r--r--
dircache.html	13.66 KB	-rw-r--r--
dis.html	96.52 KB	-rw-r--r--
distribution.html	8.27 KB	-rw-r--r--
distutils.html	10.97 KB	-rw-r--r--
dl.html	19.27 KB	-rw-r--r--
doctest.html	193.18 KB	-rw-r--r--
docxmlrpcserver.html	20.02 KB	-rw-r--r--
dumbdbm.html	16.74 KB	-rw-r--r--
dummy_thread.html	11.04 KB	-rw-r--r--
dummy_threading.html	9.96 KB	-rw-r--r--
easydialogs.html	38.83 KB	-rw-r--r--
email-examples.html	47.2 KB	-rw-r--r--
email.charset.html	32.45 KB	-rw-r--r--
email.encoders.html	14.09 KB	-rw-r--r--
email.errors.html	19.2 KB	-rw-r--r--
email.generator.html	24.78 KB	-rw-r--r--
email.header.html	31.12 KB	-rw-r--r--
email.html	55.3 KB	-rw-r--r--
email.iterators.html	14.22 KB	-rw-r--r--
email.message.html	74.91 KB	-rw-r--r--
email.mime.html	34.51 KB	-rw-r--r--
email.parser.html	37.09 KB	-rw-r--r--
email.utils.html	30.04 KB	-rw-r--r--
ensurepip.html	20.21 KB	-rw-r--r--
errno.html	52.31 KB	-rw-r--r--
exceptions.html	73.4 KB	-rw-r--r--
fcntl.html	27.85 KB	-rw-r--r--
filecmp.html	26.49 KB	-rw-r--r--
fileformats.html	10.21 KB	-rw-r--r--
fileinput.html	29.36 KB	-rw-r--r--
filesys.html	11.55 KB	-rw-r--r--
fl.html	71.58 KB	-rw-r--r--
fm.html	15 KB	-rw-r--r--
fnmatch.html	17.78 KB	-rw-r--r--
formatter.html	43.91 KB	-rw-r--r--
fpectl.html	17.84 KB	-rw-r--r--
fpformat.html	12.65 KB	-rw-r--r--
fractions.html	27.17 KB	-rw-r--r--
framework.html	44.24 KB	-rw-r--r--
frameworks.html	8.11 KB	-rw-r--r--
ftplib.html	56.56 KB	-rw-r--r--
functions.html	216.84 KB	-rw-r--r--
functools.html	31.06 KB	-rw-r--r--
future_builtins.html	15.9 KB	-rw-r--r--
gc.html	30.74 KB	-rw-r--r--
gdbm.html	19.35 KB	-rw-r--r--
gensuitemodule.html	14.54 KB	-rw-r--r--
getopt.html	26.56 KB	-rw-r--r--
getpass.html	12.5 KB	-rw-r--r--
gettext.html	91.32 KB	-rw-r--r--
gl.html	26.71 KB	-rw-r--r--
glob.html	15.42 KB	-rw-r--r--
grp.html	12.33 KB	-rw-r--r--
gzip.html	21.95 KB	-rw-r--r--
hashlib.html	27.4 KB	-rw-r--r--
heapq.html	36.72 KB	-rw-r--r--
hmac.html	15.97 KB	-rw-r--r--
hotshot.html	22.69 KB	-rw-r--r--
htmllib.html	29.9 KB	-rw-r--r--
htmlparser.html	45.11 KB	-rw-r--r--
httplib.html	78.55 KB	-rw-r--r--
i18n.html	10.61 KB	-rw-r--r--
ic.html	22.03 KB	-rw-r--r--
idle.html	45.74 KB	-rw-r--r--
imageop.html	20.94 KB	-rw-r--r--
imaplib.html	69.9 KB	-rw-r--r--
imgfile.html	14.91 KB	-rw-r--r--
imghdr.html	13.43 KB	-rw-r--r--
imp.html	41.48 KB	-rw-r--r--
importlib.html	10.27 KB	-rw-r--r--
imputil.html	36.11 KB	-rw-r--r--
index.html	82.54 KB	-rw-r--r--
inspect.html	64.31 KB	-rw-r--r--
internet.html	26.77 KB	-rw-r--r--
intro.html	9.76 KB	-rw-r--r--
io.html	122.3 KB	-rw-r--r--
ipc.html	17.18 KB	-rw-r--r--
itertools.html	129.91 KB	-rw-r--r--
jpeg.html	15.36 KB	-rw-r--r--
json.html	79.09 KB	-rw-r--r--
keyword.html	9.27 KB	-rw-r--r--
language.html	12.35 KB	-rw-r--r--
linecache.html	12.7 KB	-rw-r--r--
locale.html	68.54 KB	-rw-r--r--
logging.config.html	82.23 KB	-rw-r--r--
logging.handlers.html	91.96 KB	-rw-r--r--
logging.html	123.15 KB	-rw-r--r--
mac.html	24.49 KB	-rw-r--r--
macos.html	18.51 KB	-rw-r--r--
macosa.html	14.55 KB	-rw-r--r--
macostools.html	19.67 KB	-rw-r--r--
macpath.html	9.19 KB	-rw-r--r--
mailbox.html	185.53 KB	-rw-r--r--
mailcap.html	15.3 KB	-rw-r--r--
markup.html	20.37 KB	-rw-r--r--
marshal.html	19.88 KB	-rw-r--r--
math.html	50.52 KB	-rw-r--r--
md5.html	16.65 KB	-rw-r--r--
mhlib.html	30.04 KB	-rw-r--r--
mimetools.html	23.84 KB	-rw-r--r--
mimetypes.html	35.82 KB	-rw-r--r--
mimewriter.html	18.19 KB	-rw-r--r--
mimify.html	16.96 KB	-rw-r--r--
miniaeframe.html	14.5 KB	-rw-r--r--
misc.html	7.77 KB	-rw-r--r--
mm.html	10.19 KB	-rw-r--r--
mmap.html	33.52 KB	-rw-r--r--
modulefinder.html	19.85 KB	-rw-r--r--
modules.html	9.68 KB	-rw-r--r--
msilib.html	72.78 KB	-rw-r--r--
msvcrt.html	24.1 KB	-rw-r--r--
multifile.html	28.82 KB	-rw-r--r--
multiprocessing.html	423.97 KB	-rw-r--r--
mutex.html	13.56 KB	-rw-r--r--
netdata.html	19.28 KB	-rw-r--r--
netrc.html	15.51 KB	-rw-r--r--
new.html	16.1 KB	-rw-r--r--
nis.html	13.19 KB	-rw-r--r--
nntplib.html	51.08 KB	-rw-r--r--
numbers.html	40.91 KB	-rw-r--r--
numeric.html	14.85 KB	-rw-r--r--
operator.html	118.32 KB	-rw-r--r--
optparse.html	251.08 KB	-rw-r--r--
os.html	270.49 KB	-rw-r--r--
os.path.html	48.87 KB	-rw-r--r--
ossaudiodev.html	49.79 KB	-rw-r--r--
othergui.html	9.98 KB	-rw-r--r--
parser.html	44.52 KB	-rw-r--r--
pdb.html	41.44 KB	-rw-r--r--
persistence.html	16.25 KB	-rw-r--r--
pickle.html	107.94 KB	-rw-r--r--
pickletools.html	13.21 KB	-rw-r--r--
pipes.html	21.85 KB	-rw-r--r--
pkgutil.html	30.59 KB	-rw-r--r--
platform.html	40.14 KB	-rw-r--r--
plistlib.html	20.96 KB	-rw-r--r--
popen2.html	30.13 KB	-rw-r--r--
poplib.html	27.93 KB	-rw-r--r--
posix.html	17.27 KB	-rw-r--r--
posixfile.html	23.68 KB	-rw-r--r--
pprint.html	36.42 KB	-rw-r--r--
profile.html	76.65 KB	-rw-r--r--
pty.html	11.42 KB	-rw-r--r--
pwd.html	13.53 KB	-rw-r--r--
py_compile.html	13.33 KB	-rw-r--r--
pyclbr.html	18.14 KB	-rw-r--r--
pydoc.html	14.33 KB	-rw-r--r--
pyexpat.html	93.28 KB	-rw-r--r--
python.html	13.53 KB	-rw-r--r--
queue.html	29.64 KB	-rw-r--r--
quopri.html	14.5 KB	-rw-r--r--
random.html	47.78 KB	-rw-r--r--
re.html	163.11 KB	-rw-r--r--
readline.html	41.2 KB	-rw-r--r--
repr.html	24.57 KB	-rw-r--r--
resource.html	30.86 KB	-rw-r--r--
restricted.html	12.69 KB	-rw-r--r--
rexec.html	43.59 KB	-rw-r--r--
rfc822.html	51.25 KB	-rw-r--r--
rlcompleter.html	15.29 KB	-rw-r--r--
robotparser.html	15.01 KB	-rw-r--r--
runpy.html	23.55 KB	-rw-r--r--
sched.html	21.76 KB	-rw-r--r--
scrolledtext.html	10.67 KB	-rw-r--r--
select.html	50.17 KB	-rw-r--r--
sets.html	39.92 KB	-rw-r--r--
sgi.html	11.09 KB	-rw-r--r--
sgmllib.html	38.77 KB	-rw-r--r--
sha.html	14.55 KB	-rw-r--r--
shelve.html	32.93 KB	-rw-r--r--
shlex.html	38.43 KB	-rw-r--r--
shutil.html	49.49 KB	-rw-r--r--
signal.html	36.52 KB	-rw-r--r--
simplehttpserver.html	21.57 KB	-rw-r--r--
simplexmlrpcserver.html	40.41 KB	-rw-r--r--
site.html	29 KB	-rw-r--r--
smtpd.html	15.64 KB	-rw-r--r--
smtplib.html	51.86 KB	-rw-r--r--
sndhdr.html	12.05 KB	-rw-r--r--
socket.html	126.94 KB	-rw-r--r--
socketserver.html	81.38 KB	-rw-r--r--
someos.html	17.09 KB	-rw-r--r--
spwd.html	12.25 KB	-rw-r--r--
sqlite3.html	154.12 KB	-rw-r--r--
ssl.html	214.5 KB	-rw-r--r--
stat.html	41.11 KB	-rw-r--r--
statvfs.html	13.24 KB	-rw-r--r--
stdtypes.html	309.83 KB	-rw-r--r--
string.html	129.58 KB	-rw-r--r--
stringio.html	21.1 KB	-rw-r--r--
stringprep.html	21.4 KB	-rw-r--r--
strings.html	16.42 KB	-rw-r--r--
struct.html	47.68 KB	-rw-r--r--
subprocess.html	117 KB	-rw-r--r--
sun.html	7.83 KB	-rw-r--r--
sunau.html	35.43 KB	-rw-r--r--
sunaudio.html	21.05 KB	-rw-r--r--
symbol.html	9.06 KB	-rw-r--r--
symtable.html	29.03 KB	-rw-r--r--
sys.html	118.12 KB	-rw-r--r--
sysconfig.html	28.8 KB	-rw-r--r--
syslog.html	21.29 KB	-rw-r--r--
tabnanny.html	12.78 KB	-rw-r--r--
tarfile.html	99.54 KB	-rw-r--r--
telnetlib.html	30.46 KB	-rw-r--r--
tempfile.html	35.02 KB	-rw-r--r--
termios.html	19.22 KB	-rw-r--r--
test.html	61.42 KB	-rw-r--r--
textwrap.html	32.28 KB	-rw-r--r--
thread.html	22.67 KB	-rw-r--r--
threading.html	92.04 KB	-rw-r--r--
time.html	65.55 KB	-rw-r--r--
timeit.html	44.38 KB	-rw-r--r--
tix.html	56.73 KB	-rw-r--r--
tk.html	26.76 KB	-rw-r--r--
tkinter.html	86.67 KB	-rw-r--r--
token.html	27.31 KB	-rw-r--r--
tokenize.html	21.69 KB	-rw-r--r--
trace.html	33.91 KB	-rw-r--r--
traceback.html	44.22 KB	-rw-r--r--
ttk.html	123.83 KB	-rw-r--r--
tty.html	10.95 KB	-rw-r--r--
turtle.html	246.17 KB	-rw-r--r--
types.html	33.66 KB	-rw-r--r--
undoc.html	25.54 KB	-rw-r--r--
unicodedata.html	22.64 KB	-rw-r--r--
unittest.html	246.75 KB	-rw-r--r--
unix.html	11.9 KB	-rw-r--r--
urllib.html	71.61 KB	-rw-r--r--
urllib2.html	128.77 KB	-rw-r--r--
urlparse.html	49.04 KB	-rw-r--r--
user.html	13.41 KB	-rw-r--r--
userdict.html	32.96 KB	-rw-r--r--
uu.html	13.25 KB	-rw-r--r--
uuid.html	33.55 KB	-rw-r--r--
warnings.html	51.86 KB	-rw-r--r--
wave.html	29.08 KB	-rw-r--r--
weakref.html	41.14 KB	-rw-r--r--
webbrowser.html	29.53 KB	-rw-r--r--
whichdb.html	10.44 KB	-rw-r--r--
windows.html	10.37 KB	-rw-r--r--
winsound.html	22.56 KB	-rw-r--r--
wsgiref.html	94.38 KB	-rw-r--r--
xdrlib.html	38.05 KB	-rw-r--r--
xml.dom.html	110.39 KB	-rw-r--r--
xml.dom.minidom.html	45.23 KB	-rw-r--r--
xml.dom.pulldom.html	16.32 KB	-rw-r--r--
xml.etree.elementtree.html	124.2 KB	-rw-r--r--
xml.html	18.76 KB	-rw-r--r--
xml.sax.handler.html	47.5 KB	-rw-r--r--
xml.sax.html	26.04 KB	-rw-r--r--
xml.sax.reader.html	51.4 KB	-rw-r--r--
xml.sax.utils.html	18.11 KB	-rw-r--r--
xmlrpclib.html	71.79 KB	-rw-r--r--
zipfile.html	67.26 KB	-rw-r--r--
zipimport.html	24.32 KB	-rw-r--r--
zlib.html	34.41 KB	-rw-r--r--

Code Editor : xml.etree.elementtree.html

<!DOCTYPE html>

<title>19.7. xml.etree.ElementTree — The ElementTree XML API &#8212; Python 2.7.18 documentation</title>
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
 <link rel="stylesheet" type="text/css" href="../_static/classic.css" />
 
 <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
 <script src="../_static/jquery.js"></script>
 <script src="../_static/underscore.js"></script>
 <script src="../_static/doctools.js"></script>
 
 <script src="../_static/sidebar.js"></script>
 
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within Python 2.7.18 documentation"
 href="../_static/opensearch.xml"/>
 <link rel="author" title="About these documents" href="../about.html" />
 <link rel="index" title="Index" href="../genindex.html" />
 <link rel="search" title="Search" href="../search.html" />
 <link rel="copyright" title="Copyright" href="../copyright.html" />
 <link rel="next" title="19.8. xml.dom — The Document Object Model API" href="xml.dom.html" />
 <link rel="prev" title="19.5. XML Processing Modules" href="xml.html" />
 <link rel="shortcut icon" type="image/png" href="../_static/py.png" />
 <link rel="canonical" href="file:///usr/share/doc/python2.7/html/library/xml.etree.elementtree.html" />
 <script type="text/javascript" src="../_static/copybutton.js"></script>

</head><body>
<div id="outdated-warning" style="padding: .5em; text-align: center; background-color: #FFBABA; color: #6A0E0E;">
 This document is for an old version of Python that is <a href="https://devguide.python.org/devcycle/#end-of-life-branches">no longer supported</a>.
 You should install the python3 and python3-doc packages and read the 
 <a href="file:///usr/share/doc/python3-doc/html/library/xml.etree.elementtree.html"> Python documentation for the Python3 version packaged in this release</a>.
</div>
 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="xml.dom.html" title="19.8. xml.dom — The Document Object Model API"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="xml.html" title="19.5. XML Processing Modules"
 accesskey="P">previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="markup.html" accesskey="U">19. Structured Markup Processing Tools</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">19.7. <code class="xref py py-mod docutils literal notranslate">xml.etree.ElementTree</code> — The ElementTree XML API</a></li> 
 </ul>
 </div>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="module-xml.etree.ElementTree">
<h1>19.7. <a class="reference internal" href="#module-xml.etree.ElementTree" title="xml.etree.ElementTree: Implementation of the ElementTree API."><code class="xref py py-mod docutils literal notranslate">xml.etree.ElementTree</code></a> — The ElementTree XML API<a class="headerlink" href="#module-xml.etree.ElementTree" title="Permalink to this headline">¶</a></h1>
<div class="versionadded">
New in version 2.5.
</div>
Source code: <a class="reference external" href="https://github.com/python/cpython/tree/2.7/Lib/xml/etree/ElementTree.py">Lib/xml/etree/ElementTree.py</a>
<hr class="docutils" />
The <a class="reference internal" href="#xml.etree.ElementTree.Element" title="xml.etree.ElementTree.Element"><code class="xref py py-class docutils literal notranslate">Element</code></a> type is a flexible container object, designed to store
hierarchical data structures in memory. The type can be described as a cross
between a list and a dictionary.
<div class="admonition warning">
Warning
The <a class="reference internal" href="#module-xml.etree.ElementTree" title="xml.etree.ElementTree: Implementation of the ElementTree API."><code class="xref py py-mod docutils literal notranslate">xml.etree.ElementTree</code></a> module is not secure against
maliciously constructed data. If you need to parse untrusted or
unauthenticated data see <a class="reference internal" href="xml.html#xml-vulnerabilities">XML vulnerabilities</a>.
</div>
Each element has a number of properties associated with it:
<ul class="simple">
<li>a tag which is a string identifying what kind of data this element represents
(the element type, in other words).</li>
<li>a number of attributes, stored in a Python dictionary.</li>
<li>a text string.</li>
<li>an optional tail string.</li>
<li>a number of child elements, stored in a Python sequence</li>
</ul>
To create an element instance, use the <a class="reference internal" href="#xml.etree.ElementTree.Element" title="xml.etree.ElementTree.Element"><code class="xref py py-class docutils literal notranslate">Element</code></a> constructor or the
<a class="reference internal" href="#xml.etree.ElementTree.SubElement" title="xml.etree.ElementTree.SubElement"><code class="xref py py-func docutils literal notranslate">SubElement()</code></a> factory function.
The <a class="reference internal" href="#xml.etree.ElementTree.ElementTree" title="xml.etree.ElementTree.ElementTree"><code class="xref py py-class docutils literal notranslate">ElementTree</code></a> class can be used to wrap an element structure, and
convert it from and to XML.
A C implementation of this API is available as <code class="xref py py-mod docutils literal notranslate">xml.etree.cElementTree</code>.
See <a class="reference external" href="http://effbot.org/zone/element-index.htm">http://effbot.org/zone/element-index.htm</a> for tutorials and links to other
docs. Fredrik Lundh’s page is also the location of the development version of
the xml.etree.ElementTree.
<div class="versionchanged">
Changed in version 2.7: The ElementTree API is updated to 1.3. For more information, see
<a class="reference external" href="http://effbot.org/zone/elementtree-13-intro.htm">Introducing ElementTree 1.3</a>.
</div>
<section id="tutorial">
<h2>19.7.1. Tutorial<a class="headerlink" href="#tutorial" title="Permalink to this headline">¶</a></h2>
This is a short tutorial for using <a class="reference internal" href="#module-xml.etree.ElementTree" title="xml.etree.ElementTree: Implementation of the ElementTree API."><code class="xref py py-mod docutils literal notranslate">xml.etree.ElementTree</code></a> (<code class="docutils literal notranslate">ET</code> in
short). The goal is to demonstrate some of the building blocks and basic
concepts of the module.
<section id="xml-tree-and-elements">
<h3>19.7.1.1. XML tree and elements<a class="headerlink" href="#xml-tree-and-elements" title="Permalink to this headline">¶</a></h3>
XML is an inherently hierarchical data format, and the most natural way to
represent it is with a tree. <code class="docutils literal notranslate">ET</code> has two classes for this purpose -
<a class="reference internal" href="#xml.etree.ElementTree.ElementTree" title="xml.etree.ElementTree.ElementTree"><code class="xref py py-class docutils literal notranslate">ElementTree</code></a> represents the whole XML document as a tree, and
<a class="reference internal" href="#xml.etree.ElementTree.Element" title="xml.etree.ElementTree.Element"><code class="xref py py-class docutils literal notranslate">Element</code></a> represents a single node in this tree. Interactions with
the whole document (reading and writing to/from files) are usually done
on the <a class="reference internal" href="#xml.etree.ElementTree.ElementTree" title="xml.etree.ElementTree.ElementTree"><code class="xref py py-class docutils literal notranslate">ElementTree</code></a> level. Interactions with a single XML element
and its sub-elements are done on the <a class="reference internal" href="#xml.etree.ElementTree.Element" title="xml.etree.ElementTree.Element"><code class="xref py py-class docutils literal notranslate">Element</code></a> level.
</section>
<section id="parsing-xml">
<h3>19.7.1.2. Parsing XML<a class="headerlink" href="#parsing-xml" title="Permalink to this headline">¶</a></h3>
We’ll be using the following XML document as the sample data for this section:
<div class="highlight-xml notranslate"><div class="highlight"><pre>&lt;?xml version=&quot;1.0&quot;?&gt;
&lt;data&gt;
 &lt;country name=&quot;Liechtenstein&quot;&gt;
 &lt;rank&gt;1&lt;/rank&gt;
 &lt;year&gt;2008&lt;/year&gt;
 &lt;gdppc&gt;141100&lt;/gdppc&gt;
 &lt;neighbor name=&quot;Austria&quot; direction=&quot;E&quot;/&gt;
 &lt;neighbor name=&quot;Switzerland&quot; direction=&quot;W&quot;/&gt;
 &lt;/country&gt;
 &lt;country name=&quot;Singapore&quot;&gt;
 &lt;rank&gt;4&lt;/rank&gt;
 &lt;year&gt;2011&lt;/year&gt;
 &lt;gdppc&gt;59900&lt;/gdppc&gt;
 &lt;neighbor name=&quot;Malaysia&quot; direction=&quot;N&quot;/&gt;
 &lt;/country&gt;
 &lt;country name=&quot;Panama&quot;&gt;
 &lt;rank&gt;68&lt;/rank&gt;
 &lt;year&gt;2011&lt;/year&gt;
 &lt;gdppc&gt;13600&lt;/gdppc&gt;
 &lt;neighbor name=&quot;Costa Rica&quot; direction=&quot;W&quot;/&gt;
 &lt;neighbor name=&quot;Colombia&quot; direction=&quot;E&quot;/&gt;
 &lt;/country&gt;
&lt;/data&gt;
</pre></div>
</div>
We have a number of ways to import the data. Reading the file from disk:
<div class="highlight-default notranslate"><div class="highlight"><pre>import xml.etree.ElementTree as ET
tree = ET.parse(&#39;country_data.xml&#39;)
root = tree.getroot()
</pre></div>
</div>
Reading the data from a string:
<div class="highlight-default notranslate"><div class="highlight"><pre>root = ET.fromstring(country_data_as_string)
</pre></div>
</div>
<a class="reference internal" href="#xml.etree.ElementTree.fromstring" title="xml.etree.ElementTree.fromstring"><code class="xref py py-func docutils literal notranslate">fromstring()</code></a> parses XML from a string directly into an <a class="reference internal" href="#xml.etree.ElementTree.Element" title="xml.etree.ElementTree.Element"><code class="xref py py-class docutils literal notranslate">Element</code></a>,
which is the root element of the parsed tree. Other parsing functions may
create an <a class="reference internal" href="#xml.etree.ElementTree.ElementTree" title="xml.etree.ElementTree.ElementTree"><code class="xref py py-class docutils literal notranslate">ElementTree</code></a>. Check the documentation to be sure.
As an <a class="reference internal" href="#xml.etree.ElementTree.Element" title="xml.etree.ElementTree.Element"><code class="xref py py-class docutils literal notranslate">Element</code></a>, <code class="docutils literal notranslate">root</code> has a tag and a dictionary of attributes:
<div class="highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; root.tag
&#39;data&#39;
&gt;&gt;&gt; root.attrib
{}
</pre></div>
</div>
It also has children nodes over which we can iterate:
<div class="highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; for child in root:
... print child.tag, child.attrib
...
country {&#39;name&#39;: &#39;Liechtenstein&#39;}
country {&#39;name&#39;: &#39;Singapore&#39;}
country {&#39;name&#39;: &#39;Panama&#39;}
</pre></div>
</div>
Children are nested, and we can access specific child nodes by index:
<div class="highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; root[0][1].text
&#39;2008&#39;
</pre></div>
</div>
</section>
<section id="finding-interesting-elements">
<h3>19.7.1.3. Finding interesting elements<a class="headerlink" href="#finding-interesting-elements" title="Permalink to this headline">¶</a></h3>
<a class="reference internal" href="#xml.etree.ElementTree.Element" title="xml.etree.ElementTree.Element"><code class="xref py py-class docutils literal notranslate">Element</code></a> has some useful methods that help iterate recursively over all
the sub-tree below it (its children, their children, and so on). For example,
<a class="reference internal" href="#xml.etree.ElementTree.Element.iter" title="xml.etree.ElementTree.Element.iter"><code class="xref py py-meth docutils literal notranslate">Element.iter()</code></a>:
<div class="highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; for neighbor in root.iter(&#39;neighbor&#39;):
... print neighbor.attrib
...
{&#39;name&#39;: &#39;Austria&#39;, &#39;direction&#39;: &#39;E&#39;}
{&#39;name&#39;: &#39;Switzerland&#39;, &#39;direction&#39;: &#39;W&#39;}
{&#39;name&#39;: &#39;Malaysia&#39;, &#39;direction&#39;: &#39;N&#39;}
{&#39;name&#39;: &#39;Costa Rica&#39;, &#39;direction&#39;: &#39;W&#39;}
{&#39;name&#39;: &#39;Colombia&#39;, &#39;direction&#39;: &#39;E&#39;}
</pre></div>
</div>
<a class="reference internal" href="#xml.etree.ElementTree.Element.findall" title="xml.etree.ElementTree.Element.findall"><code class="xref py py-meth docutils literal notranslate">Element.findall()</code></a> finds only elements with a tag which are direct
children of the current element. <a class="reference internal" href="#xml.etree.ElementTree.Element.find" title="xml.etree.ElementTree.Element.find"><code class="xref py py-meth docutils literal notranslate">Element.find()</code></a> finds the first child
with a particular tag, and <a class="reference internal" href="#xml.etree.ElementTree.Element.text" title="xml.etree.ElementTree.Element.text"><code class="xref py py-attr docutils literal notranslate">Element.text</code></a> accesses the element’s text
content. <a class="reference internal" href="#xml.etree.ElementTree.Element.get" title="xml.etree.ElementTree.Element.get"><code class="xref py py-meth docutils literal notranslate">Element.get()</code></a> accesses the element’s attributes:
<div class="highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; for country in root.findall(&#39;country&#39;):
... rank = country.find(&#39;rank&#39;).text
... name = country.get(&#39;name&#39;)
... print name, rank
...
Liechtenstein 1
Singapore 4
Panama 68
</pre></div>
</div>
More sophisticated specification of which elements to look for is possible by
using <a class="reference internal" href="#elementtree-xpath">XPath</a>.
</section>
<section id="modifying-an-xml-file">
<h3>19.7.1.4. Modifying an XML File<a class="headerlink" href="#modifying-an-xml-file" title="Permalink to this headline">¶</a></h3>
<a class="reference internal" href="#xml.etree.ElementTree.ElementTree" title="xml.etree.ElementTree.ElementTree"><code class="xref py py-class docutils literal notranslate">ElementTree</code></a> provides a simple way to build XML documents and write them to files.
The <a class="reference internal" href="#xml.etree.ElementTree.ElementTree.write" title="xml.etree.ElementTree.ElementTree.write"><code class="xref py py-meth docutils literal notranslate">ElementTree.write()</code></a> method serves this purpose.
Once created, an <a class="reference internal" href="#xml.etree.ElementTree.Element" title="xml.etree.ElementTree.Element"><code class="xref py py-class docutils literal notranslate">Element</code></a> object may be manipulated by directly changing
its fields (such as <a class="reference internal" href="#xml.etree.ElementTree.Element.text" title="xml.etree.ElementTree.Element.text"><code class="xref py py-attr docutils literal notranslate">Element.text</code></a>), adding and modifying attributes
(<a class="reference internal" href="#xml.etree.ElementTree.Element.set" title="xml.etree.ElementTree.Element.set"><code class="xref py py-meth docutils literal notranslate">Element.set()</code></a> method), as well as adding new children (for example
with <a class="reference internal" href="#xml.etree.ElementTree.Element.append" title="xml.etree.ElementTree.Element.append"><code class="xref py py-meth docutils literal notranslate">Element.append()</code></a>).
Let’s say we want to add one to each country’s rank, and add an <code class="docutils literal notranslate">updated</code>
attribute to the rank element:
<div class="highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; for rank in root.iter(&#39;rank&#39;):
... new_rank = int(rank.text) + 1
... rank.text = str(new_rank)
... rank.set(&#39;updated&#39;, &#39;yes&#39;)
...
&gt;&gt;&gt; tree.write(&#39;output.xml&#39;)
</pre></div>
</div>
Our XML now looks like this:
<div class="highlight-xml notranslate"><div class="highlight"><pre>&lt;?xml version=&quot;1.0&quot;?&gt;
&lt;data&gt;
 &lt;country name=&quot;Liechtenstein&quot;&gt;
 &lt;rank updated=&quot;yes&quot;&gt;2&lt;/rank&gt;
 &lt;year&gt;2008&lt;/year&gt;
 &lt;gdppc&gt;141100&lt;/gdppc&gt;
 &lt;neighbor name=&quot;Austria&quot; direction=&quot;E&quot;/&gt;
 &lt;neighbor name=&quot;Switzerland&quot; direction=&quot;W&quot;/&gt;
 &lt;/country&gt;
 &lt;country name=&quot;Singapore&quot;&gt;
 &lt;rank updated=&quot;yes&quot;&gt;5&lt;/rank&gt;
 &lt;year&gt;2011&lt;/year&gt;
 &lt;gdppc&gt;59900&lt;/gdppc&gt;
 &lt;neighbor name=&quot;Malaysia&quot; direction=&quot;N&quot;/&gt;
 &lt;/country&gt;
 &lt;country name=&quot;Panama&quot;&gt;
 &lt;rank updated=&quot;yes&quot;&gt;69&lt;/rank&gt;
 &lt;year&gt;2011&lt;/year&gt;
 &lt;gdppc&gt;13600&lt;/gdppc&gt;
 &lt;neighbor name=&quot;Costa Rica&quot; direction=&quot;W&quot;/&gt;
 &lt;neighbor name=&quot;Colombia&quot; direction=&quot;E&quot;/&gt;
 &lt;/country&gt;
&lt;/data&gt;
</pre></div>
</div>
We can remove elements using <a class="reference internal" href="#xml.etree.ElementTree.Element.remove" title="xml.etree.ElementTree.Element.remove"><code class="xref py py-meth docutils literal notranslate">Element.remove()</code></a>. Let’s say we want to
remove all countries with a rank higher than 50:
<div class="highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; for country in root.findall(&#39;country&#39;):
... rank = int(country.find(&#39;rank&#39;).text)
... if rank &gt; 50:
... root.remove(country)
...
&gt;&gt;&gt; tree.write(&#39;output.xml&#39;)
</pre></div>
</div>
Our XML now looks like this:
<div class="highlight-xml notranslate"><div class="highlight"><pre>&lt;?xml version=&quot;1.0&quot;?&gt;
&lt;data&gt;
 &lt;country name=&quot;Liechtenstein&quot;&gt;
 &lt;rank updated=&quot;yes&quot;&gt;2&lt;/rank&gt;
 &lt;year&gt;2008&lt;/year&gt;
 &lt;gdppc&gt;141100&lt;/gdppc&gt;
 &lt;neighbor name=&quot;Austria&quot; direction=&quot;E&quot;/&gt;
 &lt;neighbor name=&quot;Switzerland&quot; direction=&quot;W&quot;/&gt;
 &lt;/country&gt;
 &lt;country name=&quot;Singapore&quot;&gt;
 &lt;rank updated=&quot;yes&quot;&gt;5&lt;/rank&gt;
 &lt;year&gt;2011&lt;/year&gt;
 &lt;gdppc&gt;59900&lt;/gdppc&gt;
 &lt;neighbor name=&quot;Malaysia&quot; direction=&quot;N&quot;/&gt;
 &lt;/country&gt;
&lt;/data&gt;
</pre></div>
</div>
</section>
<section id="building-xml-documents">
<h3>19.7.1.5. Building XML documents<a class="headerlink" href="#building-xml-documents" title="Permalink to this headline">¶</a></h3>
The <a class="reference internal" href="#xml.etree.ElementTree.SubElement" title="xml.etree.ElementTree.SubElement"><code class="xref py py-func docutils literal notranslate">SubElement()</code></a> function also provides a convenient way to create new
sub-elements for a given element:
<div class="highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; a = ET.Element(&#39;a&#39;)
&gt;&gt;&gt; b = ET.SubElement(a, &#39;b&#39;)
&gt;&gt;&gt; c = ET.SubElement(a, &#39;c&#39;)
&gt;&gt;&gt; d = ET.SubElement(c, &#39;d&#39;)
&gt;&gt;&gt; ET.dump(a)
&lt;a&gt;&lt;b /&gt;&lt;c&gt;&lt;d /&gt;&lt;/c&gt;&lt;/a&gt;
</pre></div>
</div>
</section>
<section id="parsing-xml-with-namespaces">
<h3>19.7.1.6. Parsing XML with Namespaces<a class="headerlink" href="#parsing-xml-with-namespaces" title="Permalink to this headline">¶</a></h3>
If the XML input has <a class="reference external" href="https://en.wikipedia.org/wiki/XML_namespace">namespaces</a>, tags and attributes
with prefixes in the form <code class="docutils literal notranslate">prefix:sometag</code> get expanded to
<code class="docutils literal notranslate">{uri}sometag</code> where the prefix is replaced by the full URI.
Also, if there is a <a class="reference external" href="https://www.w3.org/TR/xml-names/#defaulting">default namespace</a>,
that full URI gets prepended to all of the non-prefixed tags.
Here is an XML example that incorporates two namespaces, one with the
prefix “fictional” and the other serving as the default namespace:
<div class="highlight-xml notranslate"><div class="highlight"><pre>&lt;?xml version=&quot;1.0&quot;?&gt;
&lt;actors xmlns:fictional=&quot;http://characters.example.com&quot;
 xmlns=&quot;http://people.example.com&quot;&gt;
 &lt;actor&gt;
 &lt;name&gt;John Cleese&lt;/name&gt;
 &lt;fictional:character&gt;Lancelot&lt;/fictional:character&gt;
 &lt;fictional:character&gt;Archie Leach&lt;/fictional:character&gt;
 &lt;/actor&gt;
 &lt;actor&gt;
 &lt;name&gt;Eric Idle&lt;/name&gt;
 &lt;fictional:character&gt;Sir Robin&lt;/fictional:character&gt;
 &lt;fictional:character&gt;Gunther&lt;/fictional:character&gt;
 &lt;fictional:character&gt;Commander Clement&lt;/fictional:character&gt;
 &lt;/actor&gt;
&lt;/actors&gt;
</pre></div>
</div>
One way to search and explore this XML example is to manually add the
URI to every tag or attribute in the xpath of a
<a class="reference internal" href="#xml.etree.ElementTree.Element.find" title="xml.etree.ElementTree.Element.find"><code class="xref py py-meth docutils literal notranslate">find()</code></a> or <a class="reference internal" href="#xml.etree.ElementTree.Element.findall" title="xml.etree.ElementTree.Element.findall"><code class="xref py py-meth docutils literal notranslate">findall()</code></a>:
<div class="highlight-default notranslate"><div class="highlight"><pre>root = fromstring(xml_text)
for actor in root.findall(&#39;{http://people.example.com}actor&#39;):
 name = actor.find(&#39;{http://people.example.com}name&#39;)
 print name.text
 for char in actor.findall(&#39;{http://characters.example.com}character&#39;):
 print &#39; |--&gt;&#39;, char.text
</pre></div>
</div>
A better way to search the namespaced XML example is to create a
dictionary with your own prefixes and use those in the search functions:
<div class="highlight-default notranslate"><div class="highlight"><pre>ns = {&#39;real_person&#39;: &#39;http://people.example.com&#39;,
 &#39;role&#39;: &#39;http://characters.example.com&#39;}

for actor in root.findall(&#39;real_person:actor&#39;, ns):
 name = actor.find(&#39;real_person:name&#39;, ns)
 print name.text
 for char in actor.findall(&#39;role:character&#39;, ns):
 print &#39; |--&gt;&#39;, char.text
</pre></div>
</div>
These two approaches both output:
<div class="highlight-default notranslate"><div class="highlight"><pre>John Cleese
 |--&gt; Lancelot
 |--&gt; Archie Leach
Eric Idle
 |--&gt; Sir Robin
 |--&gt; Gunther
 |--&gt; Commander Clement
</pre></div>
</div>
</section>
<section id="additional-resources">
<h3>19.7.1.7. Additional resources<a class="headerlink" href="#additional-resources" title="Permalink to this headline">¶</a></h3>
See <a class="reference external" href="http://effbot.org/zone/element-index.htm">http://effbot.org/zone/element-index.htm</a> for tutorials and links to other
docs.
</section>
</section>
<section id="xpath-support">
<h2>19.7.2. XPath support<a class="headerlink" href="#xpath-support" title="Permalink to this headline">¶</a></h2>
This module provides limited support for
<a class="reference external" href="https://www.w3.org/TR/xpath">XPath expressions</a> for locating elements in a
tree. The goal is to support a small subset of the abbreviated syntax; a full
XPath engine is outside the scope of the module.
<section id="example">
<h3>19.7.2.1. Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h3>
Here’s an example that demonstrates some of the XPath capabilities of the
module. We’ll be using the <code class="docutils literal notranslate">countrydata</code> XML document from the
<a class="reference internal" href="#elementtree-parsing-xml">Parsing XML</a> section:
<div class="highlight-default notranslate"><div class="highlight"><pre>import xml.etree.ElementTree as ET

root = ET.fromstring(countrydata)

# Top-level elements
root.findall(&quot;.&quot;)

# All &#39;neighbor&#39; grand-children of &#39;country&#39; children of the top-level
# elements
root.findall(&quot;./country/neighbor&quot;)

# Nodes with name=&#39;Singapore&#39; that have a &#39;year&#39; child
root.findall(&quot;.//year/..[@name=&#39;Singapore&#39;]&quot;)

# &#39;year&#39; nodes that are children of nodes with name=&#39;Singapore&#39;
root.findall(&quot;.//*[@name=&#39;Singapore&#39;]/year&quot;)

# All &#39;neighbor&#39; nodes that are the second child of their parent
root.findall(&quot;.//neighbor[2]&quot;)
</pre></div>
</div>
</section>
<section id="supported-xpath-syntax">
<h3>19.7.2.2. Supported XPath syntax<a class="headerlink" href="#supported-xpath-syntax" title="Permalink to this headline">¶</a></h3>
<table class="docutils align-default">
<colgroup>
<col style="width: 30%" />
<col style="width: 70%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head">Syntax</th>
<th class="head">Meaning</th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><code class="docutils literal notranslate">tag</code></td>
<td>Selects all child elements with the given tag.
For example, <code class="docutils literal notranslate">spam</code> selects all child elements
named <code class="docutils literal notranslate">spam</code>, and <code class="docutils literal notranslate">spam/egg</code> selects all
grandchildren named <code class="docutils literal notranslate">egg</code> in all children named
<code class="docutils literal notranslate">spam</code>.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">*</code></td>
<td>Selects all child elements. For example, <code class="docutils literal notranslate">*/egg</code>
selects all grandchildren named <code class="docutils literal notranslate">egg</code>.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">.</code></td>
<td>Selects the current node. This is mostly useful
at the beginning of the path, to indicate that it’s
a relative path.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">//</code></td>
<td>Selects all subelements, on all levels beneath the
current element. For example, <code class="docutils literal notranslate">.//egg</code> selects
all <code class="docutils literal notranslate">egg</code> elements in the entire tree.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">..</code></td>
<td>Selects the parent element.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">[&#64;attrib]</code></td>
<td>Selects all elements that have the given attribute.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">[&#64;attrib='value']</code></td>
<td>Selects all elements for which the given attribute
has the given value. The value cannot contain
quotes.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">[tag]</code></td>
<td>Selects all elements that have a child named
<code class="docutils literal notranslate">tag</code>. Only immediate children are supported.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">[tag='text']</code></td>
<td>Selects all elements that have a child named
<code class="docutils literal notranslate">tag</code> whose complete text content, including
descendants, equals the given <code class="docutils literal notranslate">text</code>.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">[position]</code></td>
<td>Selects all elements that are located at the given
position. The position can be either an integer
(1 is the first position), the expression <code class="docutils literal notranslate">last()</code>
(for the last position), or a position relative to
the last position (e.g. <code class="docutils literal notranslate">last()-1</code>).</td>
</tr>
</tbody>
</table>
Predicates (expressions within square brackets) must be preceded by a tag
name, an asterisk, or another predicate. <code class="docutils literal notranslate">position</code> predicates must be
preceded by a tag name.
</section>
</section>
<section id="reference">
<h2>19.7.3. Reference<a class="headerlink" href="#reference" title="Permalink to this headline">¶</a></h2>
<section id="functions">
<h3>19.7.3.1. Functions<a class="headerlink" href="#functions" title="Permalink to this headline">¶</a></h3>
<dl class="py function">
<dt class="sig sig-object py" id="xml.etree.ElementTree.Comment">
xml.etree.ElementTree.Comment(text=None)<a class="headerlink" href="#xml.etree.ElementTree.Comment" title="Permalink to this definition">¶</a></dt>
<dd>Comment element factory. This factory function creates a special element
that will be serialized as an XML comment by the standard serializer. The
comment string can be either a bytestring or a Unicode string. text is a
string containing the comment string. Returns an element instance
representing a comment.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="xml.etree.ElementTree.dump">
xml.etree.ElementTree.dump(elem)<a class="headerlink" href="#xml.etree.ElementTree.dump" title="Permalink to this definition">¶</a></dt>
<dd>Writes an element tree or element structure to sys.stdout. This function
should be used for debugging only.
The exact output format is implementation dependent. In this version, it’s
written as an ordinary XML file.
elem is an element tree or an individual element.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="xml.etree.ElementTree.fromstring">
xml.etree.ElementTree.fromstring(text)<a class="headerlink" href="#xml.etree.ElementTree.fromstring" title="Permalink to this definition">¶</a></dt>
<dd>Parses an XML section from a string constant. Same as <a class="reference internal" href="#xml.etree.ElementTree.XML" title="xml.etree.ElementTree.XML"><code class="xref py py-func docutils literal notranslate">XML()</code></a>. text
is a string containing XML data. Returns an <a class="reference internal" href="#xml.etree.ElementTree.Element" title="xml.etree.ElementTree.Element"><code class="xref py py-class docutils literal notranslate">Element</code></a> instance.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="xml.etree.ElementTree.fromstringlist">
xml.etree.ElementTree.fromstringlist(sequence, parser=None)<a class="headerlink" href="#xml.etree.ElementTree.fromstringlist" title="Permalink to this definition">¶</a></dt>
<dd>Parses an XML document from a sequence of string fragments. sequence is a
list or other sequence containing XML data fragments. parser is an
optional parser instance. If not given, the standard <a class="reference internal" href="#xml.etree.ElementTree.XMLParser" title="xml.etree.ElementTree.XMLParser"><code class="xref py py-class docutils literal notranslate">XMLParser</code></a>
parser is used. Returns an <a class="reference internal" href="#xml.etree.ElementTree.Element" title="xml.etree.ElementTree.Element"><code class="xref py py-class docutils literal notranslate">Element</code></a> instance.
<div class="versionadded">
New in version 2.7.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="xml.etree.ElementTree.iselement">
xml.etree.ElementTree.iselement(element)<a class="headerlink" href="#xml.etree.ElementTree.iselement" title="Permalink to this definition">¶</a></dt>
<dd>Checks if an object appears to be a valid element object. element is an
element instance. Returns a true value if this is an element object.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="xml.etree.ElementTree.iterparse">
xml.etree.ElementTree.iterparse(source, events=None, parser=None)<a class="headerlink" href="#xml.etree.ElementTree.iterparse" title="Permalink to this definition">¶</a></dt>
<dd>Parses an XML section into an element tree incrementally, and reports what’s
going on to the user. source is a filename or file object containing XML
data. events is a list of events to report back. If omitted, only “end”
events are reported. parser is an optional parser instance. If not
given, the standard <a class="reference internal" href="#xml.etree.ElementTree.XMLParser" title="xml.etree.ElementTree.XMLParser"><code class="xref py py-class docutils literal notranslate">XMLParser</code></a> parser is used. parser is not
supported by <code class="docutils literal notranslate">cElementTree</code>. Returns an <a class="reference internal" href="../glossary.html#term-iterator">iterator</a> providing
<code class="docutils literal notranslate">(event, elem)</code> pairs.
<div class="admonition note">
Note
<a class="reference internal" href="#xml.etree.ElementTree.iterparse" title="xml.etree.ElementTree.iterparse"><code class="xref py py-func docutils literal notranslate">iterparse()</code></a> only guarantees that it has seen the “&gt;”
character of a starting tag when it emits a “start” event, so the
attributes are defined, but the contents of the text and tail attributes
are undefined at that point. The same applies to the element children;
they may or may not be present.
If you need a fully populated element, look for “end” events instead.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="xml.etree.ElementTree.parse">
xml.etree.ElementTree.parse(source, parser=None)<a class="headerlink" href="#xml.etree.ElementTree.parse" title="Permalink to this definition">¶</a></dt>
<dd>Parses an XML section into an element tree. source is a filename or file
object containing XML data. parser is an optional parser instance. If
not given, the standard <a class="reference internal" href="#xml.etree.ElementTree.XMLParser" title="xml.etree.ElementTree.XMLParser"><code class="xref py py-class docutils literal notranslate">XMLParser</code></a> parser is used. Returns an
<a class="reference internal" href="#xml.etree.ElementTree.ElementTree" title="xml.etree.ElementTree.ElementTree"><code class="xref py py-class docutils literal notranslate">ElementTree</code></a> instance.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="xml.etree.ElementTree.ProcessingInstruction">
xml.etree.ElementTree.ProcessingInstruction(target, text=None)<a class="headerlink" href="#xml.etree.ElementTree.ProcessingInstruction" title="Permalink to this definition">¶</a></dt>
<dd>PI element factory. This factory function creates a special element that
will be serialized as an XML processing instruction. target is a string
containing the PI target. text is a string containing the PI contents, if
given. Returns an element instance, representing a processing instruction.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="xml.etree.ElementTree.register_namespace">
xml.etree.ElementTree.register_namespace(prefix, uri)<a class="headerlink" href="#xml.etree.ElementTree.register_namespace" title="Permalink to this definition">¶</a></dt>
<dd>Registers a namespace prefix. The registry is global, and any existing
mapping for either the given prefix or the namespace URI will be removed.
prefix is a namespace prefix. uri is a namespace uri. Tags and
attributes in this namespace will be serialized with the given prefix, if at
all possible.
<div class="versionadded">
New in version 2.7.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="xml.etree.ElementTree.SubElement">
xml.etree.ElementTree.SubElement(parent, tag, attrib={}, **extra)<a class="headerlink" href="#xml.etree.ElementTree.SubElement" title="Permalink to this definition">¶</a></dt>
<dd>Subelement factory. This function creates an element instance, and appends
it to an existing element.
The element name, attribute names, and attribute values can be either
bytestrings or Unicode strings. parent is the parent element. tag is
the subelement name. attrib is an optional dictionary, containing element
attributes. extra contains additional attributes, given as keyword
arguments. Returns an element instance.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="xml.etree.ElementTree.tostring">
xml.etree.ElementTree.tostring(element, encoding='us-ascii', method='xml')<a class="headerlink" href="#xml.etree.ElementTree.tostring" title="Permalink to this definition">¶</a></dt>
<dd>Generates a string representation of an XML element, including all
subelements. element is an <a class="reference internal" href="#xml.etree.ElementTree.Element" title="xml.etree.ElementTree.Element"><code class="xref py py-class docutils literal notranslate">Element</code></a> instance. encoding <a class="footnote-reference brackets" href="#id5" id="id1">1</a> is
the output encoding (default is US-ASCII). method is either <code class="docutils literal notranslate">&quot;xml&quot;</code>,
<code class="docutils literal notranslate">&quot;html&quot;</code> or <code class="docutils literal notranslate">&quot;text&quot;</code> (default is <code class="docutils literal notranslate">&quot;xml&quot;</code>). Returns an encoded string
containing the XML data.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="xml.etree.ElementTree.tostringlist">
xml.etree.ElementTree.tostringlist(element, encoding='us-ascii', method='xml')<a class="headerlink" href="#xml.etree.ElementTree.tostringlist" title="Permalink to this definition">¶</a></dt>
<dd>Generates a string representation of an XML element, including all
subelements. element is an <a class="reference internal" href="#xml.etree.ElementTree.Element" title="xml.etree.ElementTree.Element"><code class="xref py py-class docutils literal notranslate">Element</code></a> instance. encoding <a class="footnote-reference brackets" href="#id5" id="id2">1</a> is
the output encoding (default is US-ASCII). method is either <code class="docutils literal notranslate">&quot;xml&quot;</code>,
<code class="docutils literal notranslate">&quot;html&quot;</code> or <code class="docutils literal notranslate">&quot;text&quot;</code> (default is <code class="docutils literal notranslate">&quot;xml&quot;</code>). Returns a list of encoded
strings containing the XML data. It does not guarantee any specific
sequence, except that <code class="docutils literal notranslate">&quot;&quot;.join(tostringlist(element)) ==
tostring(element)</code>.
<div class="versionadded">
New in version 2.7.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="xml.etree.ElementTree.XML">
xml.etree.ElementTree.XML(text, parser=None)<a class="headerlink" href="#xml.etree.ElementTree.XML" title="Permalink to this definition">¶</a></dt>
<dd>Parses an XML section from a string constant. This function can be used to
embed “XML literals” in Python code. text is a string containing XML
data. parser is an optional parser instance. If not given, the standard
<a class="reference internal" href="#xml.etree.ElementTree.XMLParser" title="xml.etree.ElementTree.XMLParser"><code class="xref py py-class docutils literal notranslate">XMLParser</code></a> parser is used. Returns an <a class="reference internal" href="#xml.etree.ElementTree.Element" title="xml.etree.ElementTree.Element"><code class="xref py py-class docutils literal notranslate">Element</code></a> instance.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="xml.etree.ElementTree.XMLID">
xml.etree.ElementTree.XMLID(text, parser=None)<a class="headerlink" href="#xml.etree.ElementTree.XMLID" title="Permalink to this definition">¶</a></dt>
<dd>Parses an XML section from a string constant, and also returns a dictionary
which maps from element id:s to elements. text is a string containing XML
data. parser is an optional parser instance. If not given, the standard
<a class="reference internal" href="#xml.etree.ElementTree.XMLParser" title="xml.etree.ElementTree.XMLParser"><code class="xref py py-class docutils literal notranslate">XMLParser</code></a> parser is used. Returns a tuple containing an
<a class="reference internal" href="#xml.etree.ElementTree.Element" title="xml.etree.ElementTree.Element"><code class="xref py py-class docutils literal notranslate">Element</code></a> instance and a dictionary.
</dd></dl>

</section>
<section id="element-objects">
<h3>19.7.3.2. Element Objects<a class="headerlink" href="#element-objects" title="Permalink to this headline">¶</a></h3>
<dl class="py class">
<dt class="sig sig-object py" id="xml.etree.ElementTree.Element">
class xml.etree.ElementTree.Element(tag, attrib={}, **extra)<a class="headerlink" href="#xml.etree.ElementTree.Element" title="Permalink to this definition">¶</a></dt>
<dd>Element class. This class defines the Element interface, and provides a
reference implementation of this interface.
The element name, attribute names, and attribute values can be either
bytestrings or Unicode strings. tag is the element name. attrib is
an optional dictionary, containing element attributes. extra contains
additional attributes, given as keyword arguments.
<dl class="py attribute">
<dt class="sig sig-object py" id="xml.etree.ElementTree.Element.tag">
tag<a class="headerlink" href="#xml.etree.ElementTree.Element.tag" title="Permalink to this definition">¶</a></dt>
<dd>A string identifying what kind of data this element represents (the
element type, in other words).
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="xml.etree.ElementTree.Element.text">
text<a class="headerlink" href="#xml.etree.ElementTree.Element.text" title="Permalink to this definition">¶</a></dt>
<dt class="sig sig-object py" id="xml.etree.ElementTree.Element.tail">
tail<a class="headerlink" href="#xml.etree.ElementTree.Element.tail" title="Permalink to this definition">¶</a></dt>
<dd>These attributes can be used to hold additional data associated with
the element. Their values are usually strings but may be any
application-specific object. If the element is created from
an XML file, the text attribute holds either the text between
the element’s start tag and its first child or end tag, or <code class="docutils literal notranslate">None</code>, and
the tail attribute holds either the text between the element’s
end tag and the next tag, or <code class="docutils literal notranslate">None</code>. For the XML data
<div class="highlight-xml notranslate"><div class="highlight"><pre>&lt;a&gt;&lt;b&gt;1&lt;c&gt;2&lt;d/&gt;3&lt;/c&gt;&lt;/b&gt;4&lt;/a&gt;
</pre></div>
</div>
the a element has <code class="docutils literal notranslate">None</code> for both text and tail attributes,
the b element has text <code class="docutils literal notranslate">&quot;1&quot;</code> and tail <code class="docutils literal notranslate">&quot;4&quot;</code>,
the c element has text <code class="docutils literal notranslate">&quot;2&quot;</code> and tail <code class="docutils literal notranslate">None</code>,
and the d element has text <code class="docutils literal notranslate">None</code> and tail <code class="docutils literal notranslate">&quot;3&quot;</code>.
To collect the inner text of an element, see <a class="reference internal" href="#xml.etree.ElementTree.Element.itertext" title="xml.etree.ElementTree.Element.itertext"><code class="xref py py-meth docutils literal notranslate">itertext()</code></a>, for
example <code class="docutils literal notranslate">&quot;&quot;.join(element.itertext())</code>.
Applications may store arbitrary objects in these attributes.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="xml.etree.ElementTree.Element.attrib">
attrib<a class="headerlink" href="#xml.etree.ElementTree.Element.attrib" title="Permalink to this definition">¶</a></dt>
<dd>A dictionary containing the element’s attributes. Note that while the
attrib value is always a real mutable Python dictionary, an ElementTree
implementation may choose to use another internal representation, and
create the dictionary only if someone asks for it. To take advantage of
such implementations, use the dictionary methods below whenever possible.
</dd></dl>

The following dictionary-like methods work on the element attributes.
<dl class="py method">
<dt class="sig sig-object py" id="xml.etree.ElementTree.Element.clear">
clear()<a class="headerlink" href="#xml.etree.ElementTree.Element.clear" title="Permalink to this definition">¶</a></dt>
<dd>Resets an element. This function removes all subelements, clears all
attributes, and sets the text and tail attributes to <code class="docutils literal notranslate">None</code>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xml.etree.ElementTree.Element.get">
get(key, default=None)<a class="headerlink" href="#xml.etree.ElementTree.Element.get" title="Permalink to this definition">¶</a></dt>
<dd>Gets the element attribute named key.
Returns the attribute value, or default if the attribute was not found.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xml.etree.ElementTree.Element.items">
items()<a class="headerlink" href="#xml.etree.ElementTree.Element.items" title="Permalink to this definition">¶</a></dt>
<dd>Returns the element attributes as a sequence of (name, value) pairs. The
attributes are returned in an arbitrary order.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xml.etree.ElementTree.Element.keys">
keys()<a class="headerlink" href="#xml.etree.ElementTree.Element.keys" title="Permalink to this definition">¶</a></dt>
<dd>Returns the elements attribute names as a list. The names are returned
in an arbitrary order.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xml.etree.ElementTree.Element.set">
set(key, value)<a class="headerlink" href="#xml.etree.ElementTree.Element.set" title="Permalink to this definition">¶</a></dt>
<dd>Set the attribute key on the element to value.
</dd></dl>

The following methods work on the element’s children (subelements).
<dl class="py method">
<dt class="sig sig-object py" id="xml.etree.ElementTree.Element.append">
append(subelement)<a class="headerlink" href="#xml.etree.ElementTree.Element.append" title="Permalink to this definition">¶</a></dt>
<dd>Adds the element subelement to the end of this elements internal list
of subelements.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xml.etree.ElementTree.Element.extend">
extend(subelements)<a class="headerlink" href="#xml.etree.ElementTree.Element.extend" title="Permalink to this definition">¶</a></dt>
<dd>Appends subelements from a sequence object with zero or more elements.
Raises <code class="xref py py-exc docutils literal notranslate">AssertionError</code> if a subelement is not a valid object.
<div class="versionadded">
New in version 2.7.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xml.etree.ElementTree.Element.find">
find(match)<a class="headerlink" href="#xml.etree.ElementTree.Element.find" title="Permalink to this definition">¶</a></dt>
<dd>Finds the first subelement matching match. match may be a tag name
or path. Returns an element instance or <code class="docutils literal notranslate">None</code>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xml.etree.ElementTree.Element.findall">
findall(match)<a class="headerlink" href="#xml.etree.ElementTree.Element.findall" title="Permalink to this definition">¶</a></dt>
<dd>Finds all matching subelements, by tag name or path. Returns a list
containing all matching elements in document order.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xml.etree.ElementTree.Element.findtext">
findtext(match, default=None)<a class="headerlink" href="#xml.etree.ElementTree.Element.findtext" title="Permalink to this definition">¶</a></dt>
<dd>Finds text for the first subelement matching match. match may be
a tag name or 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.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xml.etree.ElementTree.Element.getchildren">
getchildren()<a class="headerlink" href="#xml.etree.ElementTree.Element.getchildren" title="Permalink to this definition">¶</a></dt>
<dd><div class="deprecated">
Deprecated since version 2.7: Use <code class="docutils literal notranslate">list(elem)</code> or iteration.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xml.etree.ElementTree.Element.getiterator">
getiterator(tag=None)<a class="headerlink" href="#xml.etree.ElementTree.Element.getiterator" title="Permalink to this definition">¶</a></dt>
<dd><div class="deprecated">
Deprecated since version 2.7: Use method <a class="reference internal" href="#xml.etree.ElementTree.Element.iter" title="xml.etree.ElementTree.Element.iter"><code class="xref py py-meth docutils literal notranslate">Element.iter()</code></a> instead.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xml.etree.ElementTree.Element.insert">
insert(index, element)<a class="headerlink" href="#xml.etree.ElementTree.Element.insert" title="Permalink to this definition">¶</a></dt>
<dd>Inserts a subelement at the given position in this element.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xml.etree.ElementTree.Element.iter">
iter(tag=None)<a class="headerlink" href="#xml.etree.ElementTree.Element.iter" title="Permalink to this definition">¶</a></dt>
<dd>Creates a tree <a class="reference internal" href="../glossary.html#term-iterator">iterator</a> with the current element as the root.
The iterator iterates over this element and all elements below it, in
document (depth first) order. If tag is not <code class="docutils literal notranslate">None</code> or <code class="docutils literal notranslate">'*'</code>, only
elements whose tag equals tag are returned from the iterator. If the
tree structure is modified during iteration, the result is undefined.
<div class="versionadded">
New in version 2.7.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xml.etree.ElementTree.Element.iterfind">
iterfind(match)<a class="headerlink" href="#xml.etree.ElementTree.Element.iterfind" title="Permalink to this definition">¶</a></dt>
<dd>Finds all matching subelements, by tag name or path. Returns an iterable
yielding all matching elements in document order.
<div class="versionadded">
New in version 2.7.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xml.etree.ElementTree.Element.itertext">
itertext()<a class="headerlink" href="#xml.etree.ElementTree.Element.itertext" title="Permalink to this definition">¶</a></dt>
<dd>Creates a text iterator. The iterator loops over this element and all
subelements, in document order, and returns all inner text.
<div class="versionadded">
New in version 2.7.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xml.etree.ElementTree.Element.makeelement">
makeelement(tag, attrib)<a class="headerlink" href="#xml.etree.ElementTree.Element.makeelement" title="Permalink to this definition">¶</a></dt>
<dd>Creates a new element object of the same type as this element. Do not
call this method, use the <a class="reference internal" href="#xml.etree.ElementTree.SubElement" title="xml.etree.ElementTree.SubElement"><code class="xref py py-func docutils literal notranslate">SubElement()</code></a> factory function instead.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xml.etree.ElementTree.Element.remove">
remove(subelement)<a class="headerlink" href="#xml.etree.ElementTree.Element.remove" title="Permalink to this definition">¶</a></dt>
<dd>Removes subelement from the element. Unlike the find* methods this
method compares elements based on the instance identity, not on tag value
or contents.
</dd></dl>

<a class="reference internal" href="#xml.etree.ElementTree.Element" title="xml.etree.ElementTree.Element"><code class="xref py py-class docutils literal notranslate">Element</code></a> objects also support the following sequence type methods
for working with subelements: <a class="reference internal" href="../reference/datamodel.html#object.__delitem__" title="object.__delitem__"><code class="xref py py-meth docutils literal notranslate">__delitem__()</code></a>,
<a class="reference internal" href="../reference/datamodel.html#object.__getitem__" title="object.__getitem__"><code class="xref py py-meth docutils literal notranslate">__getitem__()</code></a>, <a class="reference internal" href="../reference/datamodel.html#object.__setitem__" title="object.__setitem__"><code class="xref py py-meth docutils literal notranslate">__setitem__()</code></a>,
<a class="reference internal" href="../reference/datamodel.html#object.__len__" title="object.__len__"><code class="xref py py-meth docutils literal notranslate">__len__()</code></a>.
Caution: Elements with no subelements will test as <code class="docutils literal notranslate">False</code>. This behavior
will change in future versions. Use specific <code class="docutils literal notranslate">len(elem)</code> or <code class="docutils literal notranslate">elem is
None</code> test instead.
<div class="highlight-default notranslate"><div class="highlight"><pre>element = root.find(&#39;foo&#39;)

if not element: # careful!
 print &quot;element not found, or element has no subelements&quot;

if element is None:
 print &quot;element not found&quot;
</pre></div>
</div>
</dd></dl>

</section>
<section id="elementtree-objects">
<h3>19.7.3.3. ElementTree Objects<a class="headerlink" href="#elementtree-objects" title="Permalink to this headline">¶</a></h3>
<dl class="py class">
<dt class="sig sig-object py" id="xml.etree.ElementTree.ElementTree">
class xml.etree.ElementTree.ElementTree(element=None, file=None)<a class="headerlink" href="#xml.etree.ElementTree.ElementTree" title="Permalink to this definition">¶</a></dt>
<dd>ElementTree wrapper class. This class represents an entire element
hierarchy, and adds some extra support for serialization to and from
standard XML.
element is the root element. The tree is initialized with the contents
of the XML file if given.
<dl class="py method">
<dt class="sig sig-object py" id="xml.etree.ElementTree.ElementTree._setroot">
_setroot(element)<a class="headerlink" href="#xml.etree.ElementTree.ElementTree._setroot" title="Permalink to this definition">¶</a></dt>
<dd>Replaces the root element for this tree. This discards the current
contents of the tree, and replaces it with the given element. Use with
care. element is an element instance.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xml.etree.ElementTree.ElementTree.find">
find(match)<a class="headerlink" href="#xml.etree.ElementTree.ElementTree.find" title="Permalink to this definition">¶</a></dt>
<dd>Same as <a class="reference internal" href="#xml.etree.ElementTree.Element.find" title="xml.etree.ElementTree.Element.find"><code class="xref py py-meth docutils literal notranslate">Element.find()</code></a>, starting at the root of the tree.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xml.etree.ElementTree.ElementTree.findall">
findall(match)<a class="headerlink" href="#xml.etree.ElementTree.ElementTree.findall" title="Permalink to this definition">¶</a></dt>
<dd>Same as <a class="reference internal" href="#xml.etree.ElementTree.Element.findall" title="xml.etree.ElementTree.Element.findall"><code class="xref py py-meth docutils literal notranslate">Element.findall()</code></a>, starting at the root of the tree.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xml.etree.ElementTree.ElementTree.findtext">
findtext(match, default=None)<a class="headerlink" href="#xml.etree.ElementTree.ElementTree.findtext" title="Permalink to this definition">¶</a></dt>
<dd>Same as <a class="reference internal" href="#xml.etree.ElementTree.Element.findtext" title="xml.etree.ElementTree.Element.findtext"><code class="xref py py-meth docutils literal notranslate">Element.findtext()</code></a>, starting at the root of the tree.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xml.etree.ElementTree.ElementTree.getiterator">
getiterator(tag=None)<a class="headerlink" href="#xml.etree.ElementTree.ElementTree.getiterator" title="Permalink to this definition">¶</a></dt>
<dd><div class="deprecated">
Deprecated since version 2.7: Use method <a class="reference internal" href="#xml.etree.ElementTree.ElementTree.iter" title="xml.etree.ElementTree.ElementTree.iter"><code class="xref py py-meth docutils literal notranslate">ElementTree.iter()</code></a> instead.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xml.etree.ElementTree.ElementTree.getroot">
getroot()<a class="headerlink" href="#xml.etree.ElementTree.ElementTree.getroot" title="Permalink to this definition">¶</a></dt>
<dd>Returns the root element for this tree.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xml.etree.ElementTree.ElementTree.iter">
iter(tag=None)<a class="headerlink" href="#xml.etree.ElementTree.ElementTree.iter" title="Permalink to this definition">¶</a></dt>
<dd>Creates and returns a tree iterator for the root element. The iterator
loops over all elements in this tree, in section order. tag is the tag
to look for (default is to return all elements).
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xml.etree.ElementTree.ElementTree.iterfind">
iterfind(match)<a class="headerlink" href="#xml.etree.ElementTree.ElementTree.iterfind" title="Permalink to this definition">¶</a></dt>
<dd>Finds all matching subelements, by tag name or path. Same as
getroot().iterfind(match). Returns an iterable yielding all matching
elements in document order.
<div class="versionadded">
New in version 2.7.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xml.etree.ElementTree.ElementTree.parse">
parse(source, parser=None)<a class="headerlink" href="#xml.etree.ElementTree.ElementTree.parse" title="Permalink to this definition">¶</a></dt>
<dd>Loads an external XML section into this element tree. source is a file
name or file object. parser is an optional parser instance. If not
given, the standard XMLParser parser is used. Returns the section
root element.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xml.etree.ElementTree.ElementTree.write">
write(file, encoding='us-ascii', xml_declaration=None, default_namespace=None, method='xml')<a class="headerlink" href="#xml.etree.ElementTree.ElementTree.write" title="Permalink to this definition">¶</a></dt>
<dd>Writes the element tree to a file, as XML. file is a file name, or a
file object opened for writing. encoding <a class="footnote-reference brackets" href="#id5" id="id3">1</a> is the output encoding
(default is US-ASCII). xml_declaration controls if an XML declaration
should be added to the file. Use <code class="docutils literal notranslate">False</code> for never, <code class="docutils literal notranslate">True</code> for always, <code class="docutils literal notranslate">None</code>
for only if not US-ASCII or UTF-8 (default is <code class="docutils literal notranslate">None</code>). default_namespace
sets the default XML namespace (for “xmlns”). method is either
<code class="docutils literal notranslate">&quot;xml&quot;</code>, <code class="docutils literal notranslate">&quot;html&quot;</code> or <code class="docutils literal notranslate">&quot;text&quot;</code> (default is <code class="docutils literal notranslate">&quot;xml&quot;</code>). Returns an
encoded string.
</dd></dl>

</dd></dl>

This is the XML file that is going to be manipulated:
<div class="highlight-default notranslate"><div class="highlight"><pre>&lt;html&gt;
 &lt;head&gt;
 &lt;title&gt;Example page&lt;/title&gt;
 &lt;/head&gt;
 &lt;body&gt;
 &lt;p&gt;Moved to &lt;a href=&quot;http://example.org/&quot;&gt;example.org&lt;/a&gt;
 or &lt;a href=&quot;http://example.com/&quot;&gt;example.com&lt;/a&gt;.&lt;/p&gt;
 &lt;/body&gt;
&lt;/html&gt;
</pre></div>
</div>
Example of changing the attribute “target” of every link in first paragraph:
<div class="highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; from xml.etree.ElementTree import ElementTree
&gt;&gt;&gt; tree = ElementTree()
&gt;&gt;&gt; tree.parse(&quot;index.xhtml&quot;)
&lt;Element &#39;html&#39; at 0xb77e6fac&gt;
&gt;&gt;&gt; p = tree.find(&quot;body/p&quot;) # Finds first occurrence of tag p in body
&gt;&gt;&gt; p
&lt;Element &#39;p&#39; at 0xb77ec26c&gt;
&gt;&gt;&gt; links = list(p.iter(&quot;a&quot;)) # Returns list of all links
&gt;&gt;&gt; links
[&lt;Element &#39;a&#39; at 0xb77ec2ac&gt;, &lt;Element &#39;a&#39; at 0xb77ec1cc&gt;]
&gt;&gt;&gt; for i in links: # Iterates through all found links
... i.attrib[&quot;target&quot;] = &quot;blank&quot;
...
&gt;&gt;&gt; tree.write(&quot;output.xhtml&quot;)
</pre></div>
</div>
</section>
<section id="qname-objects">
<h3>19.7.3.4. QName Objects<a class="headerlink" href="#qname-objects" title="Permalink to this headline">¶</a></h3>
<dl class="py class">
<dt class="sig sig-object py" id="xml.etree.ElementTree.QName">
class xml.etree.ElementTree.QName(text_or_uri, tag=None)<a class="headerlink" href="#xml.etree.ElementTree.QName" title="Permalink to this definition">¶</a></dt>
<dd>QName wrapper. This can be used to wrap a QName attribute value, in order
to get proper namespace handling on output. text_or_uri is a string
containing the QName value, in the form {uri}local, or, if the tag argument
is given, the URI part of a QName. If tag is given, the first argument is
interpreted as a URI, and this argument is interpreted as a local name.
<a class="reference internal" href="#xml.etree.ElementTree.QName" title="xml.etree.ElementTree.QName"><code class="xref py py-class docutils literal notranslate">QName</code></a> instances are opaque.
</dd></dl>

</section>
<section id="treebuilder-objects">
<h3>19.7.3.5. TreeBuilder Objects<a class="headerlink" href="#treebuilder-objects" title="Permalink to this headline">¶</a></h3>
<dl class="py class">
<dt class="sig sig-object py" id="xml.etree.ElementTree.TreeBuilder">
class xml.etree.ElementTree.TreeBuilder(element_factory=None)<a class="headerlink" href="#xml.etree.ElementTree.TreeBuilder" title="Permalink to this definition">¶</a></dt>
<dd>Generic element structure builder. This builder converts a sequence of
start, data, and end method calls to a well-formed element structure. You
can use this class to build an element structure using a custom XML parser,
or a parser for some other XML-like format. The element_factory is called
to create new <a class="reference internal" href="#xml.etree.ElementTree.Element" title="xml.etree.ElementTree.Element"><code class="xref py py-class docutils literal notranslate">Element</code></a> instances when given.
<dl class="py method">
<dt class="sig sig-object py" id="xml.etree.ElementTree.TreeBuilder.close">
close()<a class="headerlink" href="#xml.etree.ElementTree.TreeBuilder.close" title="Permalink to this definition">¶</a></dt>
<dd>Flushes the builder buffers, and returns the toplevel document
element. Returns an <a class="reference internal" href="#xml.etree.ElementTree.Element" title="xml.etree.ElementTree.Element"><code class="xref py py-class docutils literal notranslate">Element</code></a> instance.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xml.etree.ElementTree.TreeBuilder.data">
data(data)<a class="headerlink" href="#xml.etree.ElementTree.TreeBuilder.data" title="Permalink to this definition">¶</a></dt>
<dd>Adds text to the current element. data is a string. This should be
either a bytestring, or a Unicode string.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xml.etree.ElementTree.TreeBuilder.end">
end(tag)<a class="headerlink" href="#xml.etree.ElementTree.TreeBuilder.end" title="Permalink to this definition">¶</a></dt>
<dd>Closes the current element. tag is the element name. Returns the
closed element.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xml.etree.ElementTree.TreeBuilder.start">
start(tag, attrs)<a class="headerlink" href="#xml.etree.ElementTree.TreeBuilder.start" title="Permalink to this definition">¶</a></dt>
<dd>Opens a new element. tag is the element name. attrs is a dictionary
containing element attributes. Returns the opened element.
</dd></dl>

In addition, a custom <a class="reference internal" href="#xml.etree.ElementTree.TreeBuilder" title="xml.etree.ElementTree.TreeBuilder"><code class="xref py py-class docutils literal notranslate">TreeBuilder</code></a> object can provide the
following method:
<dl class="py method">
<dt class="sig sig-object py" id="xml.etree.ElementTree.TreeBuilder.doctype">
doctype(name, pubid, system)<a class="headerlink" href="#xml.etree.ElementTree.TreeBuilder.doctype" title="Permalink to this definition">¶</a></dt>
<dd>Handles a doctype declaration. name is the doctype name. pubid is
the public identifier. system is the system identifier. This method
does not exist on the default <a class="reference internal" href="#xml.etree.ElementTree.TreeBuilder" title="xml.etree.ElementTree.TreeBuilder"><code class="xref py py-class docutils literal notranslate">TreeBuilder</code></a> class.
<div class="versionadded">
New in version 2.7.
</div>
</dd></dl>

</dd></dl>

</section>
<section id="xmlparser-objects">
<h3>19.7.3.6. XMLParser Objects<a class="headerlink" href="#xmlparser-objects" title="Permalink to this headline">¶</a></h3>
<dl class="py class">
<dt class="sig sig-object py" id="xml.etree.ElementTree.XMLParser">
class xml.etree.ElementTree.XMLParser(html=0, target=None, encoding=None)<a class="headerlink" href="#xml.etree.ElementTree.XMLParser" title="Permalink to this definition">¶</a></dt>
<dd><a class="reference internal" href="#xml.etree.ElementTree.Element" title="xml.etree.ElementTree.Element"><code class="xref py py-class docutils literal notranslate">Element</code></a> structure builder for XML source data, based on the expat
parser. html are predefined HTML entities. This flag is not supported by
the current implementation. target is the target object. If omitted, the
builder uses an instance of the standard TreeBuilder class. encoding <a class="footnote-reference brackets" href="#id5" id="id4">1</a>
is optional. If given, the value overrides the encoding specified in the
XML file.
<dl class="py method">
<dt class="sig sig-object py" id="xml.etree.ElementTree.XMLParser.close">
close()<a class="headerlink" href="#xml.etree.ElementTree.XMLParser.close" title="Permalink to this definition">¶</a></dt>
<dd>Finishes feeding data to the parser. Returns an element structure.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xml.etree.ElementTree.XMLParser.doctype">
doctype(name, pubid, system)<a class="headerlink" href="#xml.etree.ElementTree.XMLParser.doctype" title="Permalink to this definition">¶</a></dt>
<dd><div class="deprecated">
Deprecated since version 2.7: Define the <a class="reference internal" href="#xml.etree.ElementTree.TreeBuilder.doctype" title="xml.etree.ElementTree.TreeBuilder.doctype"><code class="xref py py-meth docutils literal notranslate">TreeBuilder.doctype()</code></a> method on a custom TreeBuilder
target.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xml.etree.ElementTree.XMLParser.feed">
feed(data)<a class="headerlink" href="#xml.etree.ElementTree.XMLParser.feed" title="Permalink to this definition">¶</a></dt>
<dd>Feeds data to the parser. data is encoded data.
</dd></dl>

</dd></dl>

<a class="reference internal" href="#xml.etree.ElementTree.XMLParser.feed" title="xml.etree.ElementTree.XMLParser.feed"><code class="xref py py-meth docutils literal notranslate">XMLParser.feed()</code></a> calls target's <code class="xref py py-meth docutils literal notranslate">start()</code> method
for each opening tag, its <code class="xref py py-meth docutils literal notranslate">end()</code> method for each closing tag,
and data is processed by method <code class="xref py py-meth docutils literal notranslate">data()</code>. <a class="reference internal" href="#xml.etree.ElementTree.XMLParser.close" title="xml.etree.ElementTree.XMLParser.close"><code class="xref py py-meth docutils literal notranslate">XMLParser.close()</code></a>
calls target's method <code class="xref py py-meth docutils literal notranslate">close()</code>.
<a class="reference internal" href="#xml.etree.ElementTree.XMLParser" title="xml.etree.ElementTree.XMLParser"><code class="xref py py-class docutils literal notranslate">XMLParser</code></a> can be used not only for building a tree structure.
This is an example of counting the maximum depth of an XML file:
<div class="highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; from xml.etree.ElementTree import XMLParser
&gt;&gt;&gt; class MaxDepth: # The target object of the parser
... maxDepth = 0
... depth = 0
... def start(self, tag, attrib): # Called for each opening tag.
... self.depth += 1
... if self.depth &gt; self.maxDepth:
... self.maxDepth = self.depth
... def end(self, tag): # Called for each closing tag.
... self.depth -= 1
... def data(self, data):
... pass # We do not need to do anything with data.
... def close(self): # Called when all data has been parsed.
... return self.maxDepth
...
&gt;&gt;&gt; target = MaxDepth()
&gt;&gt;&gt; parser = XMLParser(target=target)
&gt;&gt;&gt; exampleXml = &quot;&quot;&quot;
... &lt;a&gt;
... &lt;b&gt;
... &lt;/b&gt;
... &lt;b&gt;
... &lt;c&gt;
... &lt;d&gt;
... &lt;/d&gt;
... &lt;/c&gt;
... &lt;/b&gt;
... &lt;/a&gt;&quot;&quot;&quot;
&gt;&gt;&gt; parser.feed(exampleXml)
&gt;&gt;&gt; parser.close()
4
</pre></div>
</div>
Footnotes
<dl class="footnote brackets">
<dt class="label" id="id5">1(<a href="#id1">1</a>,<a href="#id2">2</a>,<a href="#id3">3</a>,<a href="#id4">4</a>)</dt>
<dd>The encoding string included in XML output should conform to the
appropriate standards. For example, “UTF-8” is valid, but “UTF8” is
not. See <a class="reference external" href="https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl">https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl</a>
and <a class="reference external" href="https://www.iana.org/assignments/character-sets/character-sets.xhtml">https://www.iana.org/assignments/character-sets/character-sets.xhtml</a>.
</dd>
</dl>
</section>
</section>
</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#">19.7. <code class="xref py py-mod docutils literal notranslate">xml.etree.ElementTree</code> — The ElementTree XML API</a><ul>
<li><a class="reference internal" href="#tutorial">19.7.1. Tutorial</a><ul>
<li><a class="reference internal" href="#xml-tree-and-elements">19.7.1.1. XML tree and elements</a></li>
<li><a class="reference internal" href="#parsing-xml">19.7.1.2. Parsing XML</a></li>
<li><a class="reference internal" href="#finding-interesting-elements">19.7.1.3. Finding interesting elements</a></li>
<li><a class="reference internal" href="#modifying-an-xml-file">19.7.1.4. Modifying an XML File</a></li>
<li><a class="reference internal" href="#building-xml-documents">19.7.1.5. Building XML documents</a></li>
<li><a class="reference internal" href="#parsing-xml-with-namespaces">19.7.1.6. Parsing XML with Namespaces</a></li>
<li><a class="reference internal" href="#additional-resources">19.7.1.7. Additional resources</a></li>
</ul>
</li>
<li><a class="reference internal" href="#xpath-support">19.7.2. XPath support</a><ul>
<li><a class="reference internal" href="#example">19.7.2.1. Example</a></li>
<li><a class="reference internal" href="#supported-xpath-syntax">19.7.2.2. Supported XPath syntax</a></li>
</ul>
</li>
<li><a class="reference internal" href="#reference">19.7.3. Reference</a><ul>
<li><a class="reference internal" href="#functions">19.7.3.1. Functions</a></li>
<li><a class="reference internal" href="#element-objects">19.7.3.2. Element Objects</a></li>
<li><a class="reference internal" href="#elementtree-objects">19.7.3.3. ElementTree Objects</a></li>
<li><a class="reference internal" href="#qname-objects">19.7.3.4. QName Objects</a></li>
<li><a class="reference internal" href="#treebuilder-objects">19.7.3.5. TreeBuilder Objects</a></li>
<li><a class="reference internal" href="#xmlparser-objects">19.7.3.6. XMLParser Objects</a></li>
</ul>
</li>
</ul>
</li>
</ul>

<h4>Previous topic</h4>
 <a href="xml.html"
 title="previous chapter">19.5. XML Processing Modules</a>
 <h4>Next topic</h4>
 <a href="xml.dom.html"
 title="next chapter">19.8. <code class="xref py py-mod docutils literal notranslate">xml.dom</code> — The Document Object Model API</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../_sources/library/xml.etree.elementtree.rst.txt"
 rel="nofollow">Show Source</a></li>
 </ul>
 </div>
<div id="searchbox" style="display: none" role="search">
 <h3 id="searchlabel">Quick search</h3>
 <div class="searchformwrapper">
 <form class="search" action="../search.html" method="get">
 <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 <input type="submit" value="Go" />
 </form>
 </div>
</div>
<script>$('#searchbox').show(0);</script>
 </div>
 </div>
 <div class="clearer"></div>
 </div> 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="xml.dom.html" title="19.8. xml.dom — The Document Object Model API"
 >next</a> |</li>
 <li class="right" >
 <a href="xml.html" title="19.5. XML Processing Modules"
 >previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="markup.html" >19. Structured Markup Processing Tools</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">19.7. <code class="xref py py-mod docutils literal notranslate">xml.etree.ElementTree</code> — The ElementTree XML API</a></li> 
 </ul>
 </div> 
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 1990-2024, Python Software Foundation.
 
 The Python Software Foundation is a non-profit corporation.
 <a href="https://www.python.org/psf/donations/">Please donate.</a>
 
 Last updated on December 09, 2024.
 <a href="../bugs.html">Found a bug</a>?
 
 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 4.3.2.
 </div>

</body>
</html>

${this.title}

Code Editor : xml.etree.elementtree.html