1 <?xml version="1.0" encoding="ascii"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6 <title>lxml.etree</title>
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
8 <script type="text/javascript" src="epydoc.js"></script>
11 <body bgcolor="white" text="black" link="blue" vlink="#204080"
13 <!-- ==================== NAVIGATION BAR ==================== -->
14 <table class="navbar" border="0" width="100%" cellpadding="0"
15 bgcolor="#a0c0ff" cellspacing="0">
18 <th> <a
19 href="lxml-module.html">Home</a> </th>
22 <th> <a
23 href="module-tree.html">Trees</a> </th>
26 <th> <a
27 href="identifier-index.html">Indices</a> </th>
30 <th> <a
31 href="help.html">Help</a> </th>
33 <!-- Project homepage -->
34 <th class="navbar" align="right" width="100%">
35 <table border="0" cellpadding="0" cellspacing="0">
36 <tr><th class="navbar" align="center"
37 ><a class="navbar" target="_top" href="/">lxml API</a></th>
41 <table width="100%" cellpadding="0" cellspacing="0">
44 <span class="breadcrumbs">
45 <a href="lxml-module.html">Package lxml</a> ::
50 <table cellpadding="0" cellspacing="0">
51 <!-- hide/show private -->
52 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
53 onclick="toggle_private();">hide private</a>]</span></td></tr>
54 <tr><td align="right"><span class="options"
55 >[<a href="frames.html" target="_top">frames</a
56 >] | <a href="lxml.etree-module.html"
57 target="_top">no frames</a>]</span></td></tr>
62 <!-- ==================== MODULE DESCRIPTION ==================== -->
63 <h1 class="epydoc">Module etree</h1><p class="nomargin-top"></p>
64 The <tt class="rst-docutils literal">lxml.etree</tt> module implements the extended ElementTree API for XML.
67 <div class="fields"> <p><strong>Version:</strong>
70 </div><!-- ==================== CLASSES ==================== -->
71 <a name="section-Classes"></a>
72 <table class="summary" border="1" cellpadding="3"
73 cellspacing="0" width="100%" bgcolor="white">
74 <tr bgcolor="#70b0f0" class="table-header">
75 <td colspan="2" class="table-header">
76 <table border="0" cellpadding="0" cellspacing="0" width="100%">
78 <td align="left"><span class="table-header">Classes</span></td>
79 <td align="right" valign="top"
80 ><span class="options">[<a href="#section-Classes"
81 class="privatelink" onclick="toggle_private();"
82 >hide private</a>]</span></td>
88 <td width="15%" align="right" valign="top" class="summary">
89 <span class="summary-type"> </span>
90 </td><td class="summary">
91 <a href="lxml.etree.AncestorsIterator-class.html" class="summary-name" onclick="show_private();">AncestorsIterator</a><br />
92 AncestorsIterator(self, node, tag=None)
93 Iterates over the ancestors of an element (from parent to parent).
97 <td width="15%" align="right" valign="top" class="summary">
98 <span class="summary-type"> </span>
99 </td><td class="summary">
100 <a href="lxml.etree.AttributeBasedElementClassLookup-class.html" class="summary-name">AttributeBasedElementClassLookup</a><br />
101 AttributeBasedElementClassLookup(self, attribute_name, class_mapping, fallback=None)
102 Checks an attribute of an Element and looks up the value in a
107 <td width="15%" align="right" valign="top" class="summary">
108 <span class="summary-type"> </span>
109 </td><td class="summary">
110 <a href="lxml.etree.C14NError-class.html" class="summary-name">C14NError</a><br />
111 Error during C14N serialisation.
115 <td width="15%" align="right" valign="top" class="summary">
116 <span class="summary-type"> </span>
117 </td><td class="summary">
118 <a href="lxml.etree.C14NWriterTarget-class.html" class="summary-name">C14NWriterTarget</a><br />
119 Canonicalization writer target for the XMLParser.
123 <td width="15%" align="right" valign="top" class="summary">
124 <span class="summary-type"> </span>
125 </td><td class="summary">
126 <a href="lxml.etree.CDATA-class.html" class="summary-name">CDATA</a><br />
131 <td width="15%" align="right" valign="top" class="summary">
132 <span class="summary-type"> </span>
133 </td><td class="summary">
134 <a href="lxml.etree.CommentBase-class.html" class="summary-name">CommentBase</a><br />
135 All custom Comment classes must inherit from this one.
139 <td width="15%" align="right" valign="top" class="summary">
140 <span class="summary-type"> </span>
141 </td><td class="summary">
142 <a href="lxml.etree.CustomElementClassLookup-class.html" class="summary-name">CustomElementClassLookup</a><br />
143 CustomElementClassLookup(self, fallback=None)
144 Element class lookup based on a subclass method.
148 <td width="15%" align="right" valign="top" class="summary">
149 <span class="summary-type"> </span>
150 </td><td class="summary">
151 <a href="lxml.etree.DTD-class.html" class="summary-name">DTD</a><br />
152 DTD(self, file=None, external_id=None)
157 <td width="15%" align="right" valign="top" class="summary">
158 <span class="summary-type"> </span>
159 </td><td class="summary">
160 <a href="lxml.etree.DTDError-class.html" class="summary-name">DTDError</a><br />
161 Base class for DTD errors.
165 <td width="15%" align="right" valign="top" class="summary">
166 <span class="summary-type"> </span>
167 </td><td class="summary">
168 <a href="lxml.etree.DTDParseError-class.html" class="summary-name">DTDParseError</a><br />
169 Error while parsing a DTD.
173 <td width="15%" align="right" valign="top" class="summary">
174 <span class="summary-type"> </span>
175 </td><td class="summary">
176 <a href="lxml.etree.DTDValidateError-class.html" class="summary-name">DTDValidateError</a><br />
177 Error while validating an XML document with a DTD.
181 <td width="15%" align="right" valign="top" class="summary">
182 <span class="summary-type"> </span>
183 </td><td class="summary">
184 <a href="lxml.etree.DocInfo-class.html" class="summary-name" onclick="show_private();">DocInfo</a><br />
185 Document information provided by parser and DTD.
189 <td width="15%" align="right" valign="top" class="summary">
190 <span class="summary-type"> </span>
191 </td><td class="summary">
192 <a href="lxml.etree.DocumentInvalid-class.html" class="summary-name">DocumentInvalid</a><br />
197 <td width="15%" align="right" valign="top" class="summary">
198 <span class="summary-type"> </span>
199 </td><td class="summary">
200 <a href="lxml.etree.ETCompatXMLParser-class.html" class="summary-name">ETCompatXMLParser</a><br />
201 ETCompatXMLParser(self, encoding=None, attribute_defaults=False, dtd_validation=False, load_dtd=False, no_network=True, ns_clean=False, recover=False, schema=None, huge_tree=False, remove_blank_text=False, resolve_entities=True, remove_comments=True, remove_pis=True, strip_cdata=True, target=None, compact=True)
205 <td width="15%" align="right" valign="top" class="summary">
206 <span class="summary-type"> </span>
207 </td><td class="summary">
208 <a href="lxml.etree.ETXPath-class.html" class="summary-name">ETXPath</a><br />
209 ETXPath(self, path, extensions=None, regexp=True, smart_strings=True)
210 Special XPath class that supports the ElementTree {uri} notation for namespaces.
214 <td width="15%" align="right" valign="top" class="summary">
215 <span class="summary-type"> </span>
216 </td><td class="summary">
217 <a href="lxml.etree.ElementBase-class.html" class="summary-name">ElementBase</a><br />
218 ElementBase(<a href="#id1"><span class="rst-problematic" id="rst-rst-id2">*</span></a>children, attrib=None, nsmap=None, <a href="#id3"><span class="rst-problematic" id="rst-rst-id4">**</span></a>_extra)
222 <td width="15%" align="right" valign="top" class="summary">
223 <span class="summary-type"> </span>
224 </td><td class="summary">
225 <a href="lxml.etree.ElementChildIterator-class.html" class="summary-name" onclick="show_private();">ElementChildIterator</a><br />
226 ElementChildIterator(self, node, tag=None, reversed=False)
227 Iterates over the children of an element.
231 <td width="15%" align="right" valign="top" class="summary">
232 <span class="summary-type"> </span>
233 </td><td class="summary">
234 <a href="lxml.etree.ElementClassLookup-class.html" class="summary-name">ElementClassLookup</a><br />
235 ElementClassLookup(self)
236 Superclass of Element class lookups.
240 <td width="15%" align="right" valign="top" class="summary">
241 <span class="summary-type"> </span>
242 </td><td class="summary">
243 <a href="lxml.etree.ElementDefaultClassLookup-class.html" class="summary-name">ElementDefaultClassLookup</a><br />
244 ElementDefaultClassLookup(self, element=None, comment=None, pi=None, entity=None)
245 Element class lookup scheme that always returns the default Element
250 <td width="15%" align="right" valign="top" class="summary">
251 <span class="summary-type"> </span>
252 </td><td class="summary">
253 <a href="lxml.etree.ElementDepthFirstIterator-class.html" class="summary-name" onclick="show_private();">ElementDepthFirstIterator</a><br />
254 ElementDepthFirstIterator(self, node, tag=None, inclusive=True)
255 Iterates over an element and its sub-elements in document order (depth
260 <td width="15%" align="right" valign="top" class="summary">
261 <span class="summary-type"> </span>
262 </td><td class="summary">
263 <a href="lxml.etree.ElementNamespaceClassLookup-class.html" class="summary-name">ElementNamespaceClassLookup</a><br />
264 ElementNamespaceClassLookup(self, fallback=None)
268 <td width="15%" align="right" valign="top" class="summary">
269 <span class="summary-type"> </span>
270 </td><td class="summary">
271 <a href="lxml.etree.ElementTextIterator-class.html" class="summary-name" onclick="show_private();">ElementTextIterator</a><br />
272 ElementTextIterator(self, element, tag=None, with_tail=True)
273 Iterates over the text content of a subtree.
277 <td width="15%" align="right" valign="top" class="summary">
278 <span class="summary-type"> </span>
279 </td><td class="summary">
280 <a href="lxml.etree.EntityBase-class.html" class="summary-name">EntityBase</a><br />
281 All custom Entity classes must inherit from this one.
285 <td width="15%" align="right" valign="top" class="summary">
286 <span class="summary-type"> </span>
287 </td><td class="summary">
288 <a href="lxml.etree.Error-class.html" class="summary-name">Error</a>
292 <td width="15%" align="right" valign="top" class="summary">
293 <span class="summary-type"> </span>
294 </td><td class="summary">
295 <a href="lxml.etree.ErrorDomains-class.html" class="summary-name">ErrorDomains</a><br />
296 Libxml2 error domains
300 <td width="15%" align="right" valign="top" class="summary">
301 <span class="summary-type"> </span>
302 </td><td class="summary">
303 <a href="lxml.etree.ErrorLevels-class.html" class="summary-name">ErrorLevels</a><br />
308 <td width="15%" align="right" valign="top" class="summary">
309 <span class="summary-type"> </span>
310 </td><td class="summary">
311 <a href="lxml.etree.ErrorTypes-class.html" class="summary-name">ErrorTypes</a><br />
316 <td width="15%" align="right" valign="top" class="summary">
317 <span class="summary-type"> </span>
318 </td><td class="summary">
319 <a href="lxml.etree.FallbackElementClassLookup-class.html" class="summary-name">FallbackElementClassLookup</a><br />
320 FallbackElementClassLookup(self, fallback=None)
324 <td width="15%" align="right" valign="top" class="summary">
325 <span class="summary-type"> </span>
326 </td><td class="summary">
327 <a href="lxml.etree.HTMLParser-class.html" class="summary-name">HTMLParser</a><br />
328 HTMLParser(self, encoding=None, remove_blank_text=False, remove_comments=False, remove_pis=False, strip_cdata=True, no_network=True, target=None, schema: XMLSchema =None, recover=True, compact=True, collect_ids=True, huge_tree=False)
332 <td width="15%" align="right" valign="top" class="summary">
333 <span class="summary-type"> </span>
334 </td><td class="summary">
335 <a href="lxml.etree.HTMLPullParser-class.html" class="summary-name" onclick="show_private();">HTMLPullParser</a><br />
336 HTMLPullParser(self, events=None, <a href="#id1"><span class="rst-problematic" id="rst-rst-id2">*</span></a>, tag=None, base_url=None, <a href="#id3"><span class="rst-problematic" id="rst-rst-id4">**</span></a>kwargs)
340 <td width="15%" align="right" valign="top" class="summary">
341 <span class="summary-type"> </span>
342 </td><td class="summary">
343 <a href="lxml.etree.LxmlError-class.html" class="summary-name">LxmlError</a><br />
344 Main exception base class for lxml. All other exceptions inherit from
349 <td width="15%" align="right" valign="top" class="summary">
350 <span class="summary-type"> </span>
351 </td><td class="summary">
352 <a href="lxml.etree.LxmlRegistryError-class.html" class="summary-name">LxmlRegistryError</a><br />
353 Base class of lxml registry errors.
357 <td width="15%" align="right" valign="top" class="summary">
358 <span class="summary-type"> </span>
359 </td><td class="summary">
360 <a href="lxml.etree.LxmlSyntaxError-class.html" class="summary-name">LxmlSyntaxError</a><br />
361 Base class for all syntax errors.
365 <td width="15%" align="right" valign="top" class="summary">
366 <span class="summary-type"> </span>
367 </td><td class="summary">
368 <a href="lxml.etree.NamespaceRegistryError-class.html" class="summary-name">NamespaceRegistryError</a><br />
369 Error registering a namespace extension.
373 <td width="15%" align="right" valign="top" class="summary">
374 <span class="summary-type"> </span>
375 </td><td class="summary">
376 <a href="lxml.etree.PIBase-class.html" class="summary-name">PIBase</a><br />
377 All custom Processing Instruction classes must inherit from this one.
381 <td width="15%" align="right" valign="top" class="summary">
382 <span class="summary-type"> </span>
383 </td><td class="summary">
384 <a href="lxml.etree.ParseError-class.html" class="summary-name">ParseError</a><br />
385 Syntax error while parsing an XML document.
389 <td width="15%" align="right" valign="top" class="summary">
390 <span class="summary-type"> </span>
391 </td><td class="summary">
392 <a href="lxml.etree.ParserBasedElementClassLookup-class.html" class="summary-name">ParserBasedElementClassLookup</a><br />
393 ParserBasedElementClassLookup(self, fallback=None)
394 Element class lookup based on the XML parser.
398 <td width="15%" align="right" valign="top" class="summary">
399 <span class="summary-type"> </span>
400 </td><td class="summary">
401 <a href="lxml.etree.ParserError-class.html" class="summary-name">ParserError</a><br />
402 Internal lxml parser error.
406 <td width="15%" align="right" valign="top" class="summary">
407 <span class="summary-type"> </span>
408 </td><td class="summary">
409 <a href="lxml.etree.PyErrorLog-class.html" class="summary-name">PyErrorLog</a><br />
410 PyErrorLog(self, logger_name=None, logger=None)
411 A global error log that connects to the Python stdlib logging package.
415 <td width="15%" align="right" valign="top" class="summary">
416 <span class="summary-type"> </span>
417 </td><td class="summary">
418 <a href="lxml.etree.PythonElementClassLookup-class.html" class="summary-name">PythonElementClassLookup</a><br />
419 PythonElementClassLookup(self, fallback=None)
420 Element class lookup based on a subclass method.
424 <td width="15%" align="right" valign="top" class="summary">
425 <span class="summary-type"> </span>
426 </td><td class="summary">
427 <a href="lxml.etree.QName-class.html" class="summary-name">QName</a><br />
428 QName(text_or_uri_or_element, tag=None)
432 <td width="15%" align="right" valign="top" class="summary">
433 <span class="summary-type"> </span>
434 </td><td class="summary">
435 <a href="lxml.etree.RelaxNG-class.html" class="summary-name">RelaxNG</a><br />
436 RelaxNG(self, etree=None, file=None)
437 Turn a document into a Relax NG validator.
441 <td width="15%" align="right" valign="top" class="summary">
442 <span class="summary-type"> </span>
443 </td><td class="summary">
444 <a href="lxml.etree.RelaxNGError-class.html" class="summary-name">RelaxNGError</a><br />
445 Base class for RelaxNG errors.
449 <td width="15%" align="right" valign="top" class="summary">
450 <span class="summary-type"> </span>
451 </td><td class="summary">
452 <a href="lxml.etree.RelaxNGErrorTypes-class.html" class="summary-name">RelaxNGErrorTypes</a><br />
453 Libxml2 RelaxNG error types
457 <td width="15%" align="right" valign="top" class="summary">
458 <span class="summary-type"> </span>
459 </td><td class="summary">
460 <a href="lxml.etree.RelaxNGParseError-class.html" class="summary-name">RelaxNGParseError</a><br />
461 Error while parsing an XML document as RelaxNG.
465 <td width="15%" align="right" valign="top" class="summary">
466 <span class="summary-type"> </span>
467 </td><td class="summary">
468 <a href="lxml.etree.RelaxNGValidateError-class.html" class="summary-name">RelaxNGValidateError</a><br />
469 Error while validating an XML document with a RelaxNG schema.
473 <td width="15%" align="right" valign="top" class="summary">
474 <span class="summary-type"> </span>
475 </td><td class="summary">
476 <a href="lxml.etree.Resolver-class.html" class="summary-name">Resolver</a><br />
477 This is the base class of all resolvers.
481 <td width="15%" align="right" valign="top" class="summary">
482 <span class="summary-type"> </span>
483 </td><td class="summary">
484 <a href="lxml.etree.Schematron-class.html" class="summary-name">Schematron</a><br />
485 Schematron(self, etree=None, file=None)
486 A Schematron validator.
490 <td width="15%" align="right" valign="top" class="summary">
491 <span class="summary-type"> </span>
492 </td><td class="summary">
493 <a href="lxml.etree.SchematronError-class.html" class="summary-name">SchematronError</a><br />
494 Base class of all Schematron errors.
498 <td width="15%" align="right" valign="top" class="summary">
499 <span class="summary-type"> </span>
500 </td><td class="summary">
501 <a href="lxml.etree.SchematronParseError-class.html" class="summary-name">SchematronParseError</a><br />
502 Error while parsing an XML document as Schematron schema.
506 <td width="15%" align="right" valign="top" class="summary">
507 <span class="summary-type"> </span>
508 </td><td class="summary">
509 <a href="lxml.etree.SchematronValidateError-class.html" class="summary-name">SchematronValidateError</a><br />
510 Error while validating an XML document with a Schematron schema.
514 <td width="15%" align="right" valign="top" class="summary">
515 <span class="summary-type"> </span>
516 </td><td class="summary">
517 <a href="lxml.etree.SerialisationError-class.html" class="summary-name">SerialisationError</a><br />
518 A libxml2 error that occurred during serialisation.
522 <td width="15%" align="right" valign="top" class="summary">
523 <span class="summary-type"> </span>
524 </td><td class="summary">
525 <a href="lxml.etree.SiblingsIterator-class.html" class="summary-name" onclick="show_private();">SiblingsIterator</a><br />
526 SiblingsIterator(self, node, tag=None, preceding=False)
527 Iterates over the siblings of an element.
531 <td width="15%" align="right" valign="top" class="summary">
532 <span class="summary-type"> </span>
533 </td><td class="summary">
534 <a href="lxml.etree.TreeBuilder-class.html" class="summary-name">TreeBuilder</a><br />
535 comment_factory=None, pi_factory=None,
536 insert_comments=True, insert_pis=True)
540 <td width="15%" align="right" valign="top" class="summary">
541 <span class="summary-type"> </span>
542 </td><td class="summary">
543 <a href="lxml.etree.XInclude-class.html" class="summary-name">XInclude</a><br />
549 <td width="15%" align="right" valign="top" class="summary">
550 <span class="summary-type"> </span>
551 </td><td class="summary">
552 <a href="lxml.etree.XIncludeError-class.html" class="summary-name">XIncludeError</a><br />
553 Error during XInclude processing.
557 <td width="15%" align="right" valign="top" class="summary">
558 <span class="summary-type"> </span>
559 </td><td class="summary">
560 <a href="lxml.etree.XMLParser-class.html" class="summary-name">XMLParser</a><br />
561 XMLParser(self, encoding=None, attribute_defaults=False, dtd_validation=False, load_dtd=False, no_network=True, ns_clean=False, recover=False, schema: XMLSchema =None, huge_tree=False, remove_blank_text=False, resolve_entities=True, remove_comments=False, remove_pis=False, strip_cdata=True, collect_ids=True, target=None, compact=True)
565 <td width="15%" align="right" valign="top" class="summary">
566 <span class="summary-type"> </span>
567 </td><td class="summary">
568 <a href="lxml.etree.XMLPullParser-class.html" class="summary-name" onclick="show_private();">XMLPullParser</a><br />
569 XMLPullParser(self, events=None, <a href="#id1"><span class="rst-problematic" id="rst-rst-id2">*</span></a>, tag=None, <a href="#id3"><span class="rst-problematic" id="rst-rst-id4">**</span></a>kwargs)
573 <td width="15%" align="right" valign="top" class="summary">
574 <span class="summary-type"> </span>
575 </td><td class="summary">
576 <a href="lxml.etree.XMLSchema-class.html" class="summary-name">XMLSchema</a><br />
577 XMLSchema(self, etree=None, file=None)
578 Turn a document into an XML Schema validator.
582 <td width="15%" align="right" valign="top" class="summary">
583 <span class="summary-type"> </span>
584 </td><td class="summary">
585 <a href="lxml.etree.XMLSchemaError-class.html" class="summary-name">XMLSchemaError</a><br />
586 Base class of all XML Schema errors
590 <td width="15%" align="right" valign="top" class="summary">
591 <span class="summary-type"> </span>
592 </td><td class="summary">
593 <a href="lxml.etree.XMLSchemaParseError-class.html" class="summary-name">XMLSchemaParseError</a><br />
594 Error while parsing an XML document as XML Schema.
598 <td width="15%" align="right" valign="top" class="summary">
599 <span class="summary-type"> </span>
600 </td><td class="summary">
601 <a href="lxml.etree.XMLSchemaValidateError-class.html" class="summary-name">XMLSchemaValidateError</a><br />
602 Error while validating an XML document with an XML Schema.
606 <td width="15%" align="right" valign="top" class="summary">
607 <span class="summary-type"> </span>
608 </td><td class="summary">
609 <a href="lxml.etree.XMLSyntaxError-class.html" class="summary-name">XMLSyntaxError</a><br />
610 Syntax error while parsing an XML document.
614 <td width="15%" align="right" valign="top" class="summary">
615 <span class="summary-type"> </span>
616 </td><td class="summary">
617 <a href="lxml.etree.ETCompatXMLParser-class.html" class="summary-name">XMLTreeBuilder</a><br />
618 ETCompatXMLParser(self, encoding=None, attribute_defaults=False, dtd_validation=False, load_dtd=False, no_network=True, ns_clean=False, recover=False, schema=None, huge_tree=False, remove_blank_text=False, resolve_entities=True, remove_comments=True, remove_pis=True, strip_cdata=True, target=None, compact=True)
622 <td width="15%" align="right" valign="top" class="summary">
623 <span class="summary-type"> </span>
624 </td><td class="summary">
625 <a href="lxml.etree.XPath-class.html" class="summary-name">XPath</a><br />
626 XPath(self, path, namespaces=None, extensions=None, regexp=True, smart_strings=True)
627 A compiled XPath expression that can be called on Elements and ElementTrees.
631 <td width="15%" align="right" valign="top" class="summary">
632 <span class="summary-type"> </span>
633 </td><td class="summary">
634 <a href="lxml.etree.XPathDocumentEvaluator-class.html" class="summary-name">XPathDocumentEvaluator</a><br />
635 XPathDocumentEvaluator(self, etree, namespaces=None, extensions=None, regexp=True, smart_strings=True)
636 Create an XPath evaluator for an ElementTree.
640 <td width="15%" align="right" valign="top" class="summary">
641 <span class="summary-type"> </span>
642 </td><td class="summary">
643 <a href="lxml.etree.XPathElementEvaluator-class.html" class="summary-name" onclick="show_private();">XPathElementEvaluator</a><br />
644 XPathElementEvaluator(self, element, namespaces=None, extensions=None, regexp=True, smart_strings=True)
645 Create an XPath evaluator for an element.
649 <td width="15%" align="right" valign="top" class="summary">
650 <span class="summary-type"> </span>
651 </td><td class="summary">
652 <a href="lxml.etree.XPathError-class.html" class="summary-name">XPathError</a><br />
653 Base class of all XPath errors.
657 <td width="15%" align="right" valign="top" class="summary">
658 <span class="summary-type"> </span>
659 </td><td class="summary">
660 <a href="lxml.etree.XPathEvalError-class.html" class="summary-name">XPathEvalError</a><br />
661 Error during XPath evaluation.
665 <td width="15%" align="right" valign="top" class="summary">
666 <span class="summary-type"> </span>
667 </td><td class="summary">
668 <a href="lxml.etree.XPathFunctionError-class.html" class="summary-name">XPathFunctionError</a><br />
669 Internal error looking up an XPath extension function.
673 <td width="15%" align="right" valign="top" class="summary">
674 <span class="summary-type"> </span>
675 </td><td class="summary">
676 <a href="lxml.etree.XPathResultError-class.html" class="summary-name">XPathResultError</a><br />
677 Error handling an XPath result.
681 <td width="15%" align="right" valign="top" class="summary">
682 <span class="summary-type"> </span>
683 </td><td class="summary">
684 <a href="lxml.etree.XPathSyntaxError-class.html" class="summary-name">XPathSyntaxError</a>
688 <td width="15%" align="right" valign="top" class="summary">
689 <span class="summary-type"> </span>
690 </td><td class="summary">
691 <a href="lxml.etree.XSLT-class.html" class="summary-name">XSLT</a><br />
692 XSLT(self, xslt_input, extensions=None, regexp=True, access_control=None)
696 <td width="15%" align="right" valign="top" class="summary">
697 <span class="summary-type"> </span>
698 </td><td class="summary">
699 <a href="lxml.etree.XSLTAccessControl-class.html" class="summary-name">XSLTAccessControl</a><br />
700 XSLTAccessControl(self, read_file=True, write_file=True, create_dir=True, read_network=True, write_network=True)
704 <td width="15%" align="right" valign="top" class="summary">
705 <span class="summary-type"> </span>
706 </td><td class="summary">
707 <a href="lxml.etree.XSLTApplyError-class.html" class="summary-name">XSLTApplyError</a><br />
708 Error running an XSL transformation.
712 <td width="15%" align="right" valign="top" class="summary">
713 <span class="summary-type"> </span>
714 </td><td class="summary">
715 <a href="lxml.etree.XSLTError-class.html" class="summary-name">XSLTError</a><br />
716 Base class of all XSLT errors.
720 <td width="15%" align="right" valign="top" class="summary">
721 <span class="summary-type"> </span>
722 </td><td class="summary">
723 <a href="lxml.etree.XSLTExtension-class.html" class="summary-name">XSLTExtension</a><br />
724 Base class of an XSLT extension element.
728 <td width="15%" align="right" valign="top" class="summary">
729 <span class="summary-type"> </span>
730 </td><td class="summary">
731 <a href="lxml.etree.XSLTExtensionError-class.html" class="summary-name">XSLTExtensionError</a><br />
732 Error registering an XSLT extension.
736 <td width="15%" align="right" valign="top" class="summary">
737 <span class="summary-type"> </span>
738 </td><td class="summary">
739 <a href="lxml.etree.XSLTParseError-class.html" class="summary-name">XSLTParseError</a><br />
740 Error parsing a stylesheet document.
744 <td width="15%" align="right" valign="top" class="summary">
745 <span class="summary-type"> </span>
746 </td><td class="summary">
747 <a href="lxml.etree.XSLTSaveError-class.html" class="summary-name">XSLTSaveError</a><br />
748 Error serialising an XSLT result.
752 <td width="15%" align="right" valign="top" class="summary">
753 <span class="summary-type"> </span>
754 </td><td class="summary">
755 <a href="lxml.etree._Attrib-class.html" class="summary-name" onclick="show_private();">_Attrib</a><br />
756 A dict-like proxy for the <tt class="rst-docutils literal">Element.attrib</tt> property.
760 <td width="15%" align="right" valign="top" class="summary">
761 <span class="summary-type"> </span>
762 </td><td class="summary">
763 <a href="lxml.etree._BaseErrorLog-class.html" class="summary-name" onclick="show_private();">_BaseErrorLog</a>
767 <td width="15%" align="right" valign="top" class="summary">
768 <span class="summary-type"> </span>
769 </td><td class="summary">
770 <a href="lxml.etree._Comment-class.html" class="summary-name" onclick="show_private();">_Comment</a>
774 <td width="15%" align="right" valign="top" class="summary">
775 <span class="summary-type"> </span>
776 </td><td class="summary">
777 <a href="lxml.etree._Document-class.html" class="summary-name" onclick="show_private();">_Document</a><br />
778 Internal base class to reference a libxml document.
782 <td width="15%" align="right" valign="top" class="summary">
783 <span class="summary-type"> </span>
784 </td><td class="summary">
785 <a href="lxml.etree._DomainErrorLog-class.html" class="summary-name" onclick="show_private();">_DomainErrorLog</a>
789 <td width="15%" align="right" valign="top" class="summary">
790 <span class="summary-type"> </span>
791 </td><td class="summary">
792 <a href="lxml.etree._Element-class.html" class="summary-name" onclick="show_private();">_Element</a><br />
797 <td width="15%" align="right" valign="top" class="summary">
798 <span class="summary-type"> </span>
799 </td><td class="summary">
800 <a href="lxml.etree._ElementIterator-class.html" class="summary-name" onclick="show_private();">_ElementIterator</a><br />
805 <td width="15%" align="right" valign="top" class="summary">
806 <span class="summary-type"> </span>
807 </td><td class="summary">
808 <a href="lxml.etree._ElementMatchIterator-class.html" class="summary-name" onclick="show_private();">_ElementMatchIterator</a>
812 <td width="15%" align="right" valign="top" class="summary">
813 <span class="summary-type"> </span>
814 </td><td class="summary">
815 <a href="lxml.etree._ElementStringResult-class.html" class="summary-name" onclick="show_private();">_ElementStringResult</a>
819 <td width="15%" align="right" valign="top" class="summary">
820 <span class="summary-type"> </span>
821 </td><td class="summary">
822 <a href="lxml.etree._ElementTagMatcher-class.html" class="summary-name" onclick="show_private();">_ElementTagMatcher</a><br />
827 <td width="15%" align="right" valign="top" class="summary">
828 <span class="summary-type"> </span>
829 </td><td class="summary">
830 <a href="lxml.etree._ElementTree-class.html" class="summary-name" onclick="show_private();">_ElementTree</a>
834 <td width="15%" align="right" valign="top" class="summary">
835 <span class="summary-type"> </span>
836 </td><td class="summary">
837 <a href="lxml.etree._ElementUnicodeResult-class.html" class="summary-name" onclick="show_private();">_ElementUnicodeResult</a>
841 <td width="15%" align="right" valign="top" class="summary">
842 <span class="summary-type"> </span>
843 </td><td class="summary">
844 <a href="lxml.etree._Entity-class.html" class="summary-name" onclick="show_private();">_Entity</a>
848 <td width="15%" align="right" valign="top" class="summary">
849 <span class="summary-type"> </span>
850 </td><td class="summary">
851 <a href="lxml.etree._ErrorLog-class.html" class="summary-name" onclick="show_private();">_ErrorLog</a>
855 <td width="15%" align="right" valign="top" class="summary">
856 <span class="summary-type"> </span>
857 </td><td class="summary">
858 <a href="lxml.etree._FeedParser-class.html" class="summary-name" onclick="show_private();">_FeedParser</a>
862 <td width="15%" align="right" valign="top" class="summary">
863 <span class="summary-type"> </span>
864 </td><td class="summary">
865 <a href="lxml.etree._IDDict-class.html" class="summary-name" onclick="show_private();">_IDDict</a><br />
867 A dictionary-like proxy class that mapps ID attributes to elements.
871 <td width="15%" align="right" valign="top" class="summary">
872 <span class="summary-type"> </span>
873 </td><td class="summary">
874 <a href="lxml.etree._ListErrorLog-class.html" class="summary-name" onclick="show_private();">_ListErrorLog</a><br />
875 Immutable base version of a list based error log.
879 <td width="15%" align="right" valign="top" class="summary">
880 <span class="summary-type"> </span>
881 </td><td class="summary">
882 <a href="lxml.etree._LogEntry-class.html" class="summary-name" onclick="show_private();">_LogEntry</a><br />
883 A log message entry from an error log.
887 <td width="15%" align="right" valign="top" class="summary">
888 <span class="summary-type"> </span>
889 </td><td class="summary">
890 <a href="lxml.etree._ProcessingInstruction-class.html" class="summary-name" onclick="show_private();">_ProcessingInstruction</a>
894 <td width="15%" align="right" valign="top" class="summary">
895 <span class="summary-type"> </span>
896 </td><td class="summary">
897 <a href="lxml.etree._RotatingErrorLog-class.html" class="summary-name" onclick="show_private();">_RotatingErrorLog</a>
901 <td width="15%" align="right" valign="top" class="summary">
902 <span class="summary-type"> </span>
903 </td><td class="summary">
904 <a href="lxml.etree._SaxParserTarget-class.html" class="summary-name" onclick="show_private();">_SaxParserTarget</a>
908 <td width="15%" align="right" valign="top" class="summary">
909 <span class="summary-type"> </span>
910 </td><td class="summary">
911 <a href="lxml.etree._TargetParserResult-class.html" class="summary-name" onclick="show_private();">_TargetParserResult</a>
915 <td width="15%" align="right" valign="top" class="summary">
916 <span class="summary-type"> </span>
917 </td><td class="summary">
918 <a href="lxml.etree._Validator-class.html" class="summary-name" onclick="show_private();">_Validator</a><br />
919 Base class for XML validators.
923 <td width="15%" align="right" valign="top" class="summary">
924 <span class="summary-type"> </span>
925 </td><td class="summary">
926 <a href="lxml.etree._XPathEvaluatorBase-class.html" class="summary-name" onclick="show_private();">_XPathEvaluatorBase</a>
930 <td width="15%" align="right" valign="top" class="summary">
931 <span class="summary-type"> </span>
932 </td><td class="summary">
933 <a href="lxml.etree._XSLTProcessingInstruction-class.html" class="summary-name" onclick="show_private();">_XSLTProcessingInstruction</a>
937 <td width="15%" align="right" valign="top" class="summary">
938 <span class="summary-type"> </span>
939 </td><td class="summary">
940 <a href="lxml.etree._XSLTResultTree-class.html" class="summary-name" onclick="show_private();">_XSLTResultTree</a><br />
941 The result of an XSLT evaluation.
945 <td width="15%" align="right" valign="top" class="summary">
946 <span class="summary-type"> </span>
947 </td><td class="summary">
948 <a href="lxml.etree.htmlfile-class.html" class="summary-name" onclick="show_private();">htmlfile</a><br />
949 htmlfile(self, output_file, encoding=None, compression=None, close=False, buffered=True)
953 <td width="15%" align="right" valign="top" class="summary">
954 <span class="summary-type"> </span>
955 </td><td class="summary">
956 <a href="lxml.etree.iterparse-class.html" class="summary-name">iterparse</a><br />
957 iterparse(self, source, events=("end",), tag=None, attribute_defaults=False, dtd_validation=False, load_dtd=False, no_network=True, remove_blank_text=False, remove_comments=False, remove_pis=False, encoding=None, html=False, recover=None, huge_tree=False, schema=None)
961 <td width="15%" align="right" valign="top" class="summary">
962 <span class="summary-type"> </span>
963 </td><td class="summary">
964 <a href="lxml.etree.iterwalk-class.html" class="summary-name">iterwalk</a><br />
965 iterwalk(self, element_or_tree, events=("end",), tag=None)
969 <td width="15%" align="right" valign="top" class="summary">
970 <span class="summary-type"> </span>
971 </td><td class="summary">
972 <a href="lxml.etree.xmlfile-class.html" class="summary-name" onclick="show_private();">xmlfile</a><br />
973 xmlfile(self, output_file, encoding=None, compression=None, close=False, buffered=True)
977 <!-- ==================== FUNCTIONS ==================== -->
978 <a name="section-Functions"></a>
979 <table class="summary" border="1" cellpadding="3"
980 cellspacing="0" width="100%" bgcolor="white">
981 <tr bgcolor="#70b0f0" class="table-header">
982 <td colspan="2" class="table-header">
983 <table border="0" cellpadding="0" cellspacing="0" width="100%">
985 <td align="left"><span class="table-header">Functions</span></td>
986 <td align="right" valign="top"
987 ><span class="options">[<a href="#section-Functions"
988 class="privatelink" onclick="toggle_private();"
989 >hide private</a>]</span></td>
995 <td width="15%" align="right" valign="top" class="summary">
996 <span class="summary-type"> </span>
997 </td><td class="summary">
998 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1000 <td><span class="summary-sig"><a name="Comment"></a><span class="summary-sig-name">Comment</span>(<span class="summary-sig-arg">text</span>=<span class="summary-sig-default">None</span>)</span><br />
1001 Comment element factory. This factory function creates a special element that will
1002 be serialized as an XML comment.</td>
1003 <td align="right" valign="top">
1013 <td width="15%" align="right" valign="top" class="summary">
1014 <span class="summary-type"> </span>
1015 </td><td class="summary">
1016 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1018 <td><span class="summary-sig"><a href="lxml.etree-module.html#Element" class="summary-sig-name">Element</a>(<span class="summary-sig-arg">_tag</span>,
1019 <span class="summary-sig-arg">attrib</span>=<span class="summary-sig-default">None</span>,
1020 <span class="summary-sig-arg">nsmap</span>=<span class="summary-sig-default">None</span>,
1021 <span class="summary-sig-arg">**_extra</span>)</span><br />
1022 Element factory. This function returns an object implementing the
1023 Element interface.</td>
1024 <td align="right" valign="top">
1034 <td width="15%" align="right" valign="top" class="summary">
1035 <span class="summary-type"> </span>
1036 </td><td class="summary">
1037 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1039 <td><span class="summary-sig"><a name="ElementTree"></a><span class="summary-sig-name">ElementTree</span>(<span class="summary-sig-arg">element</span>=<span class="summary-sig-default">None</span>,
1040 <span class="summary-sig-arg">file</span>=<span class="summary-sig-default">None</span>,
1041 <span class="summary-sig-arg">parser</span>=<span class="summary-sig-default">None</span>)</span><br />
1042 ElementTree wrapper class.</td>
1043 <td align="right" valign="top">
1053 <td width="15%" align="right" valign="top" class="summary">
1054 <span class="summary-type"> </span>
1055 </td><td class="summary">
1056 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1058 <td><span class="summary-sig"><a name="Entity"></a><span class="summary-sig-name">Entity</span>(<span class="summary-sig-arg">name</span>)</span><br />
1059 Entity factory. This factory function creates a special element
1060 that will be serialized as an XML entity reference or character
1061 reference. Note, however, that entities will not be automatically
1062 declared in the document. A document that uses entity references
1063 requires a DTD to define the entities.</td>
1064 <td align="right" valign="top">
1074 <td width="15%" align="right" valign="top" class="summary">
1075 <span class="summary-type"> </span>
1076 </td><td class="summary">
1077 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1079 <td><span class="summary-sig"><a href="lxml.etree-module.html#Extension" class="summary-sig-name">Extension</a>(<span class="summary-sig-arg">module</span>,
1080 <span class="summary-sig-arg">function_mapping</span>=<span class="summary-sig-default">None</span>,
1081 <span class="summary-sig-arg">ns</span>=<span class="summary-sig-default">None</span>)</span><br />
1082 Build a dictionary of extension functions from the functions
1083 defined in a module or the methods of an object.</td>
1084 <td align="right" valign="top">
1094 <td width="15%" align="right" valign="top" class="summary">
1095 <span class="summary-type"> </span>
1096 </td><td class="summary">
1097 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1099 <td><span class="summary-sig"><a href="lxml.etree-module.html#FunctionNamespace" class="summary-sig-name">FunctionNamespace</a>(<span class="summary-sig-arg">ns_uri</span>)</span><br />
1100 Retrieve the function namespace object associated with the given
1102 <td align="right" valign="top">
1112 <td width="15%" align="right" valign="top" class="summary">
1113 <span class="summary-type"> </span>
1114 </td><td class="summary">
1115 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1117 <td><span class="summary-sig"><a href="lxml.etree-module.html#HTML" class="summary-sig-name">HTML</a>(<span class="summary-sig-arg">text</span>,
1118 <span class="summary-sig-arg">parser</span>=<span class="summary-sig-default">None</span>,
1119 <span class="summary-sig-arg">base_url</span>=<span class="summary-sig-default">None</span>)</span><br />
1120 Parses an HTML document from a string constant. Returns the root
1121 node (or the result returned by a parser target). This function
1122 can be used to embed "HTML literals" in Python code.</td>
1123 <td align="right" valign="top">
1133 <td width="15%" align="right" valign="top" class="summary">
1134 <span class="summary-type"> </span>
1135 </td><td class="summary">
1136 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1138 <td><span class="summary-sig"><a name="PI"></a><span class="summary-sig-name">PI</span>(<span class="summary-sig-arg">target</span>,
1139 <span class="summary-sig-arg">text</span>=<span class="summary-sig-default">None</span>)</span><br />
1140 ProcessingInstruction element factory. This factory function creates a
1141 special element that will be serialized as an XML processing instruction.</td>
1142 <td align="right" valign="top">
1152 <td width="15%" align="right" valign="top" class="summary">
1153 <span class="summary-type"> </span>
1154 </td><td class="summary">
1155 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1157 <td><span class="summary-sig"><a name="ProcessingInstruction"></a><span class="summary-sig-name">ProcessingInstruction</span>(<span class="summary-sig-arg">target</span>,
1158 <span class="summary-sig-arg">text</span>=<span class="summary-sig-default">None</span>)</span><br />
1159 ProcessingInstruction element factory. This factory function creates a
1160 special element that will be serialized as an XML processing instruction.</td>
1161 <td align="right" valign="top">
1171 <td width="15%" align="right" valign="top" class="summary">
1172 <span class="summary-type"> </span>
1173 </td><td class="summary">
1174 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1176 <td><span class="summary-sig"><a name="SubElement"></a><span class="summary-sig-name">SubElement</span>(<span class="summary-sig-arg">_parent</span>,
1177 <span class="summary-sig-arg">_tag</span>,
1178 <span class="summary-sig-arg">attrib</span>=<span class="summary-sig-default">None</span>,
1179 <span class="summary-sig-arg">nsmap</span>=<span class="summary-sig-default">None</span>,
1180 <span class="summary-sig-arg">**_extra</span>)</span><br />
1181 Subelement factory. This function creates an element instance, and
1182 appends it to an existing element.</td>
1183 <td align="right" valign="top">
1193 <td width="15%" align="right" valign="top" class="summary">
1194 <span class="summary-type"> </span>
1195 </td><td class="summary">
1196 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1198 <td><span class="summary-sig"><a href="lxml.etree-module.html#XML" class="summary-sig-name">XML</a>(<span class="summary-sig-arg">text</span>,
1199 <span class="summary-sig-arg">parser</span>=<span class="summary-sig-default">None</span>,
1200 <span class="summary-sig-arg">base_url</span>=<span class="summary-sig-default">None</span>)</span><br />
1201 Parses an XML document or fragment from a string constant.
1202 Returns the root node (or the result returned by a parser target).
1203 This function can be used to embed "XML literals" in Python code,
1205 <td align="right" valign="top">
1215 <td width="15%" align="right" valign="top" class="summary">
1216 <span class="summary-type"> </span>
1217 </td><td class="summary">
1218 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1220 <td><span class="summary-sig"><a href="lxml.etree-module.html#XMLDTDID" class="summary-sig-name">XMLDTDID</a>(<span class="summary-sig-arg">text</span>,
1221 <span class="summary-sig-arg">parser</span>=<span class="summary-sig-default">None</span>,
1222 <span class="summary-sig-arg">base_url</span>=<span class="summary-sig-default">None</span>)</span><br />
1223 Parse the text and return a tuple (root node, ID dictionary). The root
1224 node is the same as returned by the XML() function. The dictionary
1225 contains string-element pairs. The dictionary keys are the values of ID
1226 attributes as defined by the DTD. The elements referenced by the ID are
1227 stored as dictionary values.</td>
1228 <td align="right" valign="top">
1238 <td width="15%" align="right" valign="top" class="summary">
1239 <span class="summary-type"> </span>
1240 </td><td class="summary">
1241 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1243 <td><span class="summary-sig"><a name="XMLID"></a><span class="summary-sig-name">XMLID</span>(<span class="summary-sig-arg">text</span>,
1244 <span class="summary-sig-arg">parser</span>=<span class="summary-sig-default">None</span>,
1245 <span class="summary-sig-arg">base_url</span>=<span class="summary-sig-default">None</span>)</span><br />
1246 Parse the text and return a tuple (root node, ID dictionary). The root
1247 node is the same as returned by the XML() function. The dictionary
1248 contains string-element pairs. The dictionary keys are the values of 'id'
1249 attributes. The elements referenced by the ID are stored as dictionary
1251 <td align="right" valign="top">
1261 <td width="15%" align="right" valign="top" class="summary">
1262 <span class="summary-type"> </span>
1263 </td><td class="summary">
1264 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1266 <td><span class="summary-sig"><a href="lxml.etree-module.html#XPathEvaluator" class="summary-sig-name">XPathEvaluator</a>(<span class="summary-sig-arg">etree_or_element</span>,
1267 <span class="summary-sig-arg">namespaces</span>=<span class="summary-sig-default">None</span>,
1268 <span class="summary-sig-arg">extensions</span>=<span class="summary-sig-default">None</span>,
1269 <span class="summary-sig-arg">regexp</span>=<span class="summary-sig-default">True</span>,
1270 <span class="summary-sig-arg">smart_strings</span>=<span class="summary-sig-default">True</span>)</span><br />
1271 Creates an XPath evaluator for an ElementTree or an Element.</td>
1272 <td align="right" valign="top">
1281 <tr class="private">
1282 <td width="15%" align="right" valign="top" class="summary">
1283 <span class="summary-type"> </span>
1284 </td><td class="summary">
1285 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1287 <td><span class="summary-sig"><a href="lxml.etree-module.html#adopt_external_document" class="summary-sig-name" onclick="show_private();">adopt_external_document</a>(<span class="summary-sig-arg">capsule</span>,
1288 <span class="summary-sig-arg">parser</span>=<span class="summary-sig-default">None</span>)</span><br />
1289 Unpack a libxml2 document pointer from a PyCapsule and wrap it in an
1290 lxml ElementTree object.</td>
1291 <td align="right" valign="top">
1301 <td width="15%" align="right" valign="top" class="summary">
1302 <span class="summary-type"> </span>
1303 </td><td class="summary">
1304 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1306 <td><span class="summary-sig"><a href="lxml.etree-module.html#canonicalize" class="summary-sig-name">canonicalize</a>(<span class="summary-sig-arg">...</span>)</span><br />
1307 Convert XML to its C14N 2.0 serialised form.</td>
1308 <td align="right" valign="top">
1318 <td width="15%" align="right" valign="top" class="summary">
1319 <span class="summary-type"> </span>
1320 </td><td class="summary">
1321 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1323 <td><span class="summary-sig"><a href="lxml.etree-module.html#cleanup_namespaces" class="summary-sig-name">cleanup_namespaces</a>(<span class="summary-sig-arg">tree_or_element</span>,
1324 <span class="summary-sig-arg">top_nsmap</span>=<span class="summary-sig-default">None</span>,
1325 <span class="summary-sig-arg">keep_ns_prefixes</span>=<span class="summary-sig-default">None</span>)</span><br />
1326 Remove all namespace declarations from a subtree that are not used
1327 by any of the elements or attributes in that tree.</td>
1328 <td align="right" valign="top">
1338 <td width="15%" align="right" valign="top" class="summary">
1339 <span class="summary-type"> </span>
1340 </td><td class="summary">
1341 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1343 <td><span class="summary-sig"><a href="lxml.etree-module.html#clear_error_log" class="summary-sig-name">clear_error_log</a>()</span><br />
1344 Clear the global error log. Note that this log is already bound to a
1346 <td align="right" valign="top">
1356 <td width="15%" align="right" valign="top" class="summary">
1357 <span class="summary-type"> </span>
1358 </td><td class="summary">
1359 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1361 <td><span class="summary-sig"><a name="dump"></a><span class="summary-sig-name">dump</span>(<span class="summary-sig-arg">elem</span>,
1362 <span class="summary-sig-arg">pretty_print</span>=<span class="summary-sig-default">True</span>,
1363 <span class="summary-sig-arg">with_tail</span>=<span class="summary-sig-default">True</span>)</span><br />
1364 Writes an element tree or element structure to sys.stdout. This function
1365 should be used for debugging only.</td>
1366 <td align="right" valign="top">
1376 <td width="15%" align="right" valign="top" class="summary">
1377 <span class="summary-type"> </span>
1378 </td><td class="summary">
1379 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1381 <td><span class="summary-sig"><a href="lxml.etree-module.html#fromstring" class="summary-sig-name">fromstring</a>(<span class="summary-sig-arg">text</span>,
1382 <span class="summary-sig-arg">parser</span>=<span class="summary-sig-default">None</span>,
1383 <span class="summary-sig-arg">base_url</span>=<span class="summary-sig-default">None</span>)</span><br />
1384 Parses an XML document or fragment from a string. Returns the
1385 root node (or the result returned by a parser target).</td>
1386 <td align="right" valign="top">
1396 <td width="15%" align="right" valign="top" class="summary">
1397 <span class="summary-type"> </span>
1398 </td><td class="summary">
1399 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1401 <td><span class="summary-sig"><a href="lxml.etree-module.html#fromstringlist" class="summary-sig-name">fromstringlist</a>(<span class="summary-sig-arg">strings</span>,
1402 <span class="summary-sig-arg">parser</span>=<span class="summary-sig-default">None</span>)</span><br />
1403 Parses an XML document from a sequence of strings. Returns the
1404 root node (or the result returned by a parser target).</td>
1405 <td align="right" valign="top">
1415 <td width="15%" align="right" valign="top" class="summary">
1416 <span class="summary-type"> </span>
1417 </td><td class="summary">
1418 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1420 <td><span class="summary-sig"><a name="get_default_parser"></a><span class="summary-sig-name">get_default_parser</span>()</span></td>
1421 <td align="right" valign="top">
1430 <tr class="private">
1431 <td width="15%" align="right" valign="top" class="summary">
1432 <span class="summary-type"> </span>
1433 </td><td class="summary">
1434 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1436 <td><span class="summary-sig"><a href="lxml.etree-module.html#indent" class="summary-sig-name" onclick="show_private();">indent</a>(<span class="summary-sig-arg">tree</span>,
1437 <span class="summary-sig-arg">space</span>=<span class="summary-sig-default">" "</span>,
1438 <span class="summary-sig-arg">level</span>=<span class="summary-sig-default">0</span>)</span><br />
1439 Indent an XML document by inserting newlines and indentation space
1440 after elements.</td>
1441 <td align="right" valign="top">
1451 <td width="15%" align="right" valign="top" class="summary">
1452 <span class="summary-type"> </span>
1453 </td><td class="summary">
1454 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1456 <td><span class="summary-sig"><a name="iselement"></a><span class="summary-sig-name">iselement</span>(<span class="summary-sig-arg">element</span>)</span><br />
1457 Checks if an object appears to be a valid element object.</td>
1458 <td align="right" valign="top">
1468 <td width="15%" align="right" valign="top" class="summary">
1469 <span class="summary-type"> </span>
1470 </td><td class="summary">
1471 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1473 <td><span class="summary-sig"><a href="lxml.etree-module.html#parse" class="summary-sig-name">parse</a>(<span class="summary-sig-arg">source</span>,
1474 <span class="summary-sig-arg">parser</span>=<span class="summary-sig-default">None</span>,
1475 <span class="summary-sig-arg">base_url</span>=<span class="summary-sig-default">None</span>)</span><br />
1476 Return an ElementTree object loaded with source elements. If no parser
1477 is provided as second argument, the default parser is used.</td>
1478 <td align="right" valign="top">
1488 <td width="15%" align="right" valign="top" class="summary">
1489 <span class="summary-type"> </span>
1490 </td><td class="summary">
1491 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1493 <td><span class="summary-sig"><a href="lxml.etree-module.html#parseid" class="summary-sig-name">parseid</a>(<span class="summary-sig-arg">source</span>,
1494 <span class="summary-sig-arg">parser</span>=<span class="summary-sig-default">None</span>)</span><br />
1495 Parses the source into a tuple containing an ElementTree object and an
1496 ID dictionary. If no parser is provided as second argument, the default
1497 parser is used.</td>
1498 <td align="right" valign="top">
1508 <td width="15%" align="right" valign="top" class="summary">
1509 <span class="summary-type"> </span>
1510 </td><td class="summary">
1511 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1513 <td><span class="summary-sig"><a name="register_namespace"></a><span class="summary-sig-name">register_namespace</span>(<span class="summary-sig-arg">...</span>)</span><br />
1514 Registers a namespace prefix that newly created Elements in that
1515 namespace will use. The registry is global, and any existing
1516 mapping for either the given prefix or the namespace URI will be
1518 <td align="right" valign="top">
1528 <td width="15%" align="right" valign="top" class="summary">
1529 <span class="summary-type"> </span>
1530 </td><td class="summary">
1531 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1533 <td><span class="summary-sig"><a href="lxml.etree-module.html#set_default_parser" class="summary-sig-name">set_default_parser</a>(<span class="summary-sig-arg">parser</span>=<span class="summary-sig-default">None</span>)</span><br />
1534 Set a default parser for the current thread. This parser is used
1535 globally whenever no parser is supplied to the various parse functions of
1536 the lxml API. If this function is called without a parser (or if it is
1537 None), the default parser is reset to the original configuration.</td>
1538 <td align="right" valign="top">
1548 <td width="15%" align="right" valign="top" class="summary">
1549 <span class="summary-type"> </span>
1550 </td><td class="summary">
1551 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1553 <td><span class="summary-sig"><a name="set_element_class_lookup"></a><span class="summary-sig-name">set_element_class_lookup</span>(<span class="summary-sig-arg">lookup</span>=<span class="summary-sig-default"> None</span>)</span><br />
1554 Set the global default element class lookup method.</td>
1555 <td align="right" valign="top">
1565 <td width="15%" align="right" valign="top" class="summary">
1566 <span class="summary-type"> </span>
1567 </td><td class="summary">
1568 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1570 <td><span class="summary-sig"><a href="lxml.etree-module.html#strip_attributes" class="summary-sig-name">strip_attributes</a>(<span class="summary-sig-arg">tree_or_element</span>,
1571 <span class="summary-sig-arg">*attribute_names</span>)</span><br />
1572 Delete all attributes with the provided attribute names from an
1573 Element (or ElementTree) and its descendants.</td>
1574 <td align="right" valign="top">
1584 <td width="15%" align="right" valign="top" class="summary">
1585 <span class="summary-type"> </span>
1586 </td><td class="summary">
1587 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1589 <td><span class="summary-sig"><a href="lxml.etree-module.html#strip_elements" class="summary-sig-name">strip_elements</a>(<span class="summary-sig-arg">tree_or_element</span>,
1590 <span class="summary-sig-arg">with_tail</span>=<span class="summary-sig-default">True</span>,
1591 <span class="summary-sig-arg">*tag_names</span>)</span><br />
1592 Delete all elements with the provided tag names from a tree or
1593 subtree. This will remove the elements and their entire subtree,
1594 including all their attributes, text content and descendants. It
1595 will also remove the tail text of the element unless you
1596 explicitly set the <tt class="rst-docutils literal">with_tail</tt> keyword argument option to False.</td>
1597 <td align="right" valign="top">
1607 <td width="15%" align="right" valign="top" class="summary">
1608 <span class="summary-type"> </span>
1609 </td><td class="summary">
1610 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1612 <td><span class="summary-sig"><a href="lxml.etree-module.html#strip_tags" class="summary-sig-name">strip_tags</a>(<span class="summary-sig-arg">tree_or_element</span>,
1613 <span class="summary-sig-arg">*tag_names</span>)</span><br />
1614 Delete all elements with the provided tag names from a tree or
1615 subtree. This will remove the elements and their attributes, but
1616 <em>not</em> their text/tail content or descendants. Instead, it will
1617 merge the text content and children of the element into its
1619 <td align="right" valign="top">
1629 <td width="15%" align="right" valign="top" class="summary">
1630 <span class="summary-type"> </span>
1631 </td><td class="summary">
1632 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1634 <td><span class="summary-sig"><a href="lxml.etree-module.html#tostring" class="summary-sig-name">tostring</a>(<span class="summary-sig-arg">element_or_tree</span>,
1635 <span class="summary-sig-arg">encoding</span>=<span class="summary-sig-default">None</span>,
1636 <span class="summary-sig-arg">method</span>=<span class="summary-sig-default">"xml"</span>,
1637 <span class="summary-sig-arg">xml_declaration</span>=<span class="summary-sig-default">None</span>,
1638 <span class="summary-sig-arg">pretty_print</span>=<span class="summary-sig-default">False</span>,
1639 <span class="summary-sig-arg">with_tail</span>=<span class="summary-sig-default">True</span>,
1640 <span class="summary-sig-arg">standalone</span>=<span class="summary-sig-default">None</span>,
1641 <span class="summary-sig-arg">doctype</span>=<span class="summary-sig-default">None</span>,
1642 <span class="summary-sig-arg">exclusive</span>=<span class="summary-sig-default">False</span>,
1643 <span class="summary-sig-arg">inclusive_ns_prefixes</span>=<span class="summary-sig-default">None</span>,
1644 <span class="summary-sig-arg">with_comments</span>=<span class="summary-sig-default">True</span>,
1645 <span class="summary-sig-arg">strip_text</span>=<span class="summary-sig-default">False</span>,
1646 <span class="summary-sig-arg"></span>)</span><br />
1647 Serialize an element to an encoded string representation of its XML
1649 <td align="right" valign="top">
1659 <td width="15%" align="right" valign="top" class="summary">
1660 <span class="summary-type"> </span>
1661 </td><td class="summary">
1662 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1664 <td><span class="summary-sig"><a href="lxml.etree-module.html#tostringlist" class="summary-sig-name">tostringlist</a>(<span class="summary-sig-arg">element_or_tree</span>,
1665 <span class="summary-sig-arg">*args</span>,
1666 <span class="summary-sig-arg">**kwargs</span>)</span><br />
1667 Serialize an element to an encoded string representation of its XML
1668 tree, stored in a list of partial strings.</td>
1669 <td align="right" valign="top">
1679 <td width="15%" align="right" valign="top" class="summary">
1680 <span class="summary-type"> </span>
1681 </td><td class="summary">
1682 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1684 <td><span class="summary-sig"><a href="lxml.etree-module.html#tounicode" class="summary-sig-name">tounicode</a>(<span class="summary-sig-arg">element_or_tree</span>,
1685 <span class="summary-sig-arg">method</span>=<span class="summary-sig-default">"xml"</span>,
1686 <span class="summary-sig-arg">pretty_print</span>=<span class="summary-sig-default">False</span>,
1687 <span class="summary-sig-arg">with_tail</span>=<span class="summary-sig-default">True</span>,
1688 <span class="summary-sig-arg">doctype</span>=<span class="summary-sig-default">None</span>)</span><br />
1689 Serialize an element to the Python unicode representation of its XML
1691 <td align="right" valign="top">
1701 <td width="15%" align="right" valign="top" class="summary">
1702 <span class="summary-type"> </span>
1703 </td><td class="summary">
1704 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1706 <td><span class="summary-sig"><a href="lxml.etree-module.html#use_global_python_log" class="summary-sig-name">use_global_python_log</a>(<span class="summary-sig-arg">log</span>)</span><br />
1707 Replace the global error log by an etree.PyErrorLog that uses the
1708 standard Python logging package.</td>
1709 <td align="right" valign="top">
1719 <!-- ==================== VARIABLES ==================== -->
1720 <a name="section-Variables"></a>
1721 <table class="summary" border="1" cellpadding="3"
1722 cellspacing="0" width="100%" bgcolor="white">
1723 <tr bgcolor="#70b0f0" class="table-header">
1724 <td colspan="2" class="table-header">
1725 <table border="0" cellpadding="0" cellspacing="0" width="100%">
1727 <td align="left"><span class="table-header">Variables</span></td>
1728 <td align="right" valign="top"
1729 ><span class="options">[<a href="#section-Variables"
1730 class="privatelink" onclick="toggle_private();"
1731 >hide private</a>]</span></td>
1737 <td width="15%" align="right" valign="top" class="summary">
1738 <span class="summary-type"> </span>
1739 </td><td class="summary">
1740 <a name="DEBUG"></a><span class="summary-name">DEBUG</span> = <code title="1">1</code>
1744 <td width="15%" align="right" valign="top" class="summary">
1745 <span class="summary-type"> </span>
1746 </td><td class="summary">
1747 <a name="LIBXML_COMPILED_VERSION"></a><span class="summary-name">LIBXML_COMPILED_VERSION</span> = <code title="(2, 9, 4)"><code class="variable-group">(</code>2<code class="variable-op">, </code>9<code class="variable-op">, </code>4<code class="variable-group">)</code></code>
1751 <td width="15%" align="right" valign="top" class="summary">
1752 <span class="summary-type"> </span>
1753 </td><td class="summary">
1754 <a name="LIBXML_VERSION"></a><span class="summary-name">LIBXML_VERSION</span> = <code title="(2, 9, 4)"><code class="variable-group">(</code>2<code class="variable-op">, </code>9<code class="variable-op">, </code>4<code class="variable-group">)</code></code>
1758 <td width="15%" align="right" valign="top" class="summary">
1759 <span class="summary-type"> </span>
1760 </td><td class="summary">
1761 <a name="LIBXSLT_COMPILED_VERSION"></a><span class="summary-name">LIBXSLT_COMPILED_VERSION</span> = <code title="(1, 1, 29)"><code class="variable-group">(</code>1<code class="variable-op">, </code>1<code class="variable-op">, </code>29<code class="variable-group">)</code></code>
1765 <td width="15%" align="right" valign="top" class="summary">
1766 <span class="summary-type"> </span>
1767 </td><td class="summary">
1768 <a name="LIBXSLT_VERSION"></a><span class="summary-name">LIBXSLT_VERSION</span> = <code title="(1, 1, 29)"><code class="variable-group">(</code>1<code class="variable-op">, </code>1<code class="variable-op">, </code>29<code class="variable-group">)</code></code>
1772 <td width="15%" align="right" valign="top" class="summary">
1773 <span class="summary-type"> </span>
1774 </td><td class="summary">
1775 <a name="LXML_VERSION"></a><span class="summary-name">LXML_VERSION</span> = <code title="(4, 5, 0, 0)"><code class="variable-group">(</code>4<code class="variable-op">, </code>5<code class="variable-op">, </code>0<code class="variable-op">, </code>0<code class="variable-group">)</code></code>
1778 <tr class="private">
1779 <td width="15%" align="right" valign="top" class="summary">
1780 <span class="summary-type"> </span>
1781 </td><td class="summary">
1782 <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="None">None</code><br />
1786 <tr class="private">
1787 <td width="15%" align="right" valign="top" class="summary">
1788 <span class="summary-type"> </span>
1789 </td><td class="summary">
1790 <a href="lxml.etree-module.html#__pyx_capi__" class="summary-name" onclick="show_private();">__pyx_capi__</a> = <code title="{'adoptExternalDocument': <capsule object "struct LxmlElementTree *(xm\
1791 lDoc *, PyObject *, int)" at 0x7f3a93c737b0>,
1792 'appendChild': <capsule object "void (struct LxmlElement *, struct Lx\
1793 mlElement *)" at 0x7f3a93c73f90>,
1794 'appendChildToElement': <capsule object "int (struct LxmlElement *, s\
1795 truct LxmlElement *)" at 0x7f3a93c73fc0>,
1796 'attributeValue': <capsule object "PyObject *(xmlNode *, xmlAttr *)" \
1797 at 0x7f3a93c73c60>,
1798 ..."><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">adoptExternalDocument</code><code class="variable-quote">'</code><code class="variable-op">: </code><capsule object "stru<code class="variable-ellipsis">...</code></code>
1801 <tr class="private">
1802 <td width="15%" align="right" valign="top" class="summary">
1803 <span class="summary-type"> </span>
1804 </td><td class="summary">
1805 <a href="lxml.etree-module.html#__test__" class="summary-name" onclick="show_private();">__test__</a> = <code title="{u'FunctionNamespace (line 207)': u'''FunctionNamespace(ns_uri)
1807 Retrieve the function namespace object associated with the given
1810 Creates a new one if it does not yet exist. A function namespace
1811 can only be used to register extension functions.
1813 ..."><code class="variable-group">{</code><code class="variable-quote">u'</code><code class="variable-string">FunctionNamespace (line 207)</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">u'</code><code class="variable-string">FunctionNamespa</code><code class="variable-ellipsis">...</code></code>
1816 <tr class="private">
1817 <td width="15%" align="right" valign="top" class="summary">
1818 <span class="summary-type"> </span>
1819 </td><td class="summary">
1820 <a name="memory_debugger"></a><span class="summary-name">memory_debugger</span> = <code title="<lxml.etree._MemDebug object>"><lxml.etree._MemDebug object></code>
1824 <!-- ==================== FUNCTION DETAILS ==================== -->
1825 <a name="section-FunctionDetails"></a>
1826 <table class="details" border="1" cellpadding="3"
1827 cellspacing="0" width="100%" bgcolor="white">
1828 <tr bgcolor="#70b0f0" class="table-header">
1829 <td colspan="2" class="table-header">
1830 <table border="0" cellpadding="0" cellspacing="0" width="100%">
1832 <td align="left"><span class="table-header">Function Details</span></td>
1833 <td align="right" valign="top"
1834 ><span class="options">[<a href="#section-FunctionDetails"
1835 class="privatelink" onclick="toggle_private();"
1836 >hide private</a>]</span></td>
1842 <a name="Element"></a>
1844 <table class="details" border="1" cellpadding="3"
1845 cellspacing="0" width="100%" bgcolor="white">
1847 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1848 <tr valign="top"><td>
1849 <h3 class="epydoc"><span class="sig"><span class="sig-name">Element</span>(<span class="sig-arg">_tag</span>,
1850 <span class="sig-arg">attrib</span>=<span class="sig-default">None</span>,
1851 <span class="sig-arg">nsmap</span>=<span class="sig-default">None</span>,
1852 <span class="sig-arg">**_extra</span>)</span>
1854 </td><td align="right" valign="top"
1859 <p>Element factory. This function returns an object implementing the
1860 Element interface.</p>
1861 <p>Also look at the <a href="lxml.etree._Element-class.html#makeelement" class="link">_Element.makeelement()</a> and
1862 <code class="link">_BaseParser.makeelement()</code> methods, which provide a faster way to
1863 create an Element within a specific document or parser context.</p>
1868 <a name="Extension"></a>
1870 <table class="details" border="1" cellpadding="3"
1871 cellspacing="0" width="100%" bgcolor="white">
1873 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1874 <tr valign="top"><td>
1875 <h3 class="epydoc"><span class="sig"><span class="sig-name">Extension</span>(<span class="sig-arg">module</span>,
1876 <span class="sig-arg">function_mapping</span>=<span class="sig-default">None</span>,
1877 <span class="sig-arg">ns</span>=<span class="sig-default">None</span>)</span>
1879 </td><td align="right" valign="top"
1884 <p>Build a dictionary of extension functions from the functions
1885 defined in a module or the methods of an object.</p>
1886 <p>As second argument, you can pass an additional mapping of
1887 attribute names to XPath function names, or a list of function
1888 names that should be taken.</p>
1889 <p>The <tt class="rst-docutils literal">ns</tt> keyword argument accepts a namespace URI for the XPath
1895 <a name="FunctionNamespace"></a>
1897 <table class="details" border="1" cellpadding="3"
1898 cellspacing="0" width="100%" bgcolor="white">
1900 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1901 <tr valign="top"><td>
1902 <h3 class="epydoc"><span class="sig"><span class="sig-name">FunctionNamespace</span>(<span class="sig-arg">ns_uri</span>)</span>
1904 </td><td align="right" valign="top"
1909 <p>Retrieve the function namespace object associated with the given
1911 <p>Creates a new one if it does not yet exist. A function namespace
1912 can only be used to register extension functions.</p>
1914 <pre class="py-doctest">
1915 <span class="py-prompt">>>> </span>ns_functions = FunctionNamespace(<span class="py-string">"http://schema.org/Movie"</span>)</pre>
1916 <pre class="py-doctest">
1917 <span class="py-prompt">>>> </span>@ns_functions <span class="py-comment"># uses function name</span>
1918 <span class="py-more">... </span><span class="py-keyword">def</span> <span class="py-defname">add2</span>(x):
1919 <span class="py-more">... </span> return x + 2</pre>
1920 <pre class="py-doctest">
1921 <span class="py-prompt">>>> </span>@ns_functions(<span class="py-string">"add3"</span>) <span class="py-comment"># uses explicit name</span>
1922 <span class="py-more">... </span><span class="py-keyword">def</span> <span class="py-defname">add_three</span>(x):
1923 <span class="py-more">... </span> return x + 3</pre>
1930 <table class="details" border="1" cellpadding="3"
1931 cellspacing="0" width="100%" bgcolor="white">
1933 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1934 <tr valign="top"><td>
1935 <h3 class="epydoc"><span class="sig"><span class="sig-name">HTML</span>(<span class="sig-arg">text</span>,
1936 <span class="sig-arg">parser</span>=<span class="sig-default">None</span>,
1937 <span class="sig-arg">base_url</span>=<span class="sig-default">None</span>)</span>
1939 </td><td align="right" valign="top"
1944 <p>Parses an HTML document from a string constant. Returns the root
1945 node (or the result returned by a parser target). This function
1946 can be used to embed "HTML literals" in Python code.</p>
1947 <p>To override the parser with a different <tt class="rst-docutils literal">HTMLParser</tt> you can pass it to
1948 the <tt class="rst-docutils literal">parser</tt> keyword argument.</p>
1949 <p>The <tt class="rst-docutils literal">base_url</tt> keyword argument allows to set the original base URL of
1950 the document to support relative Paths when looking up external entities
1951 (DTD, XInclude, ...).</p>
1958 <table class="details" border="1" cellpadding="3"
1959 cellspacing="0" width="100%" bgcolor="white">
1961 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1962 <tr valign="top"><td>
1963 <h3 class="epydoc"><span class="sig"><span class="sig-name">XML</span>(<span class="sig-arg">text</span>,
1964 <span class="sig-arg">parser</span>=<span class="sig-default">None</span>,
1965 <span class="sig-arg">base_url</span>=<span class="sig-default">None</span>)</span>
1967 </td><td align="right" valign="top"
1972 <p>Parses an XML document or fragment from a string constant.
1973 Returns the root node (or the result returned by a parser target).
1974 This function can be used to embed "XML literals" in Python code,
1977 <pre class="py-doctest">
1978 <span class="py-prompt">>>> </span>root = XML(<span class="py-string">"<root><test/></root>"</span>)
1979 <span class="py-prompt">>>> </span><span class="py-keyword">print</span>(root.tag)
1980 <span class="py-output">root</span></pre>
1982 <p>To override the parser with a different <tt class="rst-docutils literal">XMLParser</tt> you can pass it to
1983 the <tt class="rst-docutils literal">parser</tt> keyword argument.</p>
1984 <p>The <tt class="rst-docutils literal">base_url</tt> keyword argument allows to set the original base URL of
1985 the document to support relative Paths when looking up external entities
1986 (DTD, XInclude, ...).</p>
1991 <a name="XMLDTDID"></a>
1993 <table class="details" border="1" cellpadding="3"
1994 cellspacing="0" width="100%" bgcolor="white">
1996 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1997 <tr valign="top"><td>
1998 <h3 class="epydoc"><span class="sig"><span class="sig-name">XMLDTDID</span>(<span class="sig-arg">text</span>,
1999 <span class="sig-arg">parser</span>=<span class="sig-default">None</span>,
2000 <span class="sig-arg">base_url</span>=<span class="sig-default">None</span>)</span>
2002 </td><td align="right" valign="top"
2007 <p>Parse the text and return a tuple (root node, ID dictionary). The root
2008 node is the same as returned by the XML() function. The dictionary
2009 contains string-element pairs. The dictionary keys are the values of ID
2010 attributes as defined by the DTD. The elements referenced by the ID are
2011 stored as dictionary values.</p>
2012 <p>Note that you must not modify the XML tree if you use the ID dictionary.
2013 The results are undefined.</p>
2018 <a name="XPathEvaluator"></a>
2020 <table class="details" border="1" cellpadding="3"
2021 cellspacing="0" width="100%" bgcolor="white">
2023 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2024 <tr valign="top"><td>
2025 <h3 class="epydoc"><span class="sig"><span class="sig-name">XPathEvaluator</span>(<span class="sig-arg">etree_or_element</span>,
2026 <span class="sig-arg">namespaces</span>=<span class="sig-default">None</span>,
2027 <span class="sig-arg">extensions</span>=<span class="sig-default">None</span>,
2028 <span class="sig-arg">regexp</span>=<span class="sig-default">True</span>,
2029 <span class="sig-arg">smart_strings</span>=<span class="sig-default">True</span>)</span>
2031 </td><td align="right" valign="top"
2036 <p>Creates an XPath evaluator for an ElementTree or an Element.</p>
2037 <p>The resulting object can be called with an XPath expression as argument
2038 and XPath variables provided as keyword arguments.</p>
2039 <p>Additional namespace declarations can be passed with the
2040 'namespace' keyword argument. EXSLT regular expression support
2041 can be disabled with the 'regexp' boolean keyword (defaults to
2042 True). Smart strings will be returned for string results unless
2043 you pass <tt class="rst-docutils literal">smart_strings=False</tt>.</p>
2048 <a name="adopt_external_document"></a>
2049 <div class="private">
2050 <table class="details" border="1" cellpadding="3"
2051 cellspacing="0" width="100%" bgcolor="white">
2053 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2054 <tr valign="top"><td>
2055 <h3 class="epydoc"><span class="sig"><span class="sig-name">adopt_external_document</span>(<span class="sig-arg">capsule</span>,
2056 <span class="sig-arg">parser</span>=<span class="sig-default">None</span>)</span>
2058 </td><td align="right" valign="top"
2063 <p>Unpack a libxml2 document pointer from a PyCapsule and wrap it in an
2064 lxml ElementTree object.</p>
2065 <p>This allows external libraries to build XML/HTML trees using libxml2
2066 and then pass them efficiently into lxml for further processing.</p>
2067 <p>If a <tt class="rst-docutils literal">parser</tt> is provided, it will be used for configuring the
2068 lxml document. No parsing will be done.</p>
2069 <p>The capsule must have the name <tt class="rst-docutils literal">"libxml2:xmlDoc"</tt> and its pointer
2070 value must reference a correct libxml2 document of type <tt class="rst-docutils literal">xmlDoc*</tt>.
2071 The creator of the capsule must take care to correctly clean up the
2072 document using an appropriate capsule destructor. By default, the
2073 libxml2 document will be copied to let lxml safely own the memory
2074 of the internal tree that it uses.</p>
2075 <p>If the capsule context is non-NULL, it must point to a C string that
2076 can be compared using <tt class="rst-docutils literal">strcmp()</tt>. If the context string equals
2077 <tt class="rst-docutils literal">"destructor:xmlFreeDoc"</tt>, the libxml2 document will not be copied
2078 but the capsule invalidated instead by clearing its destructor and
2079 name. That way, lxml takes ownership of the libxml2 document in memory
2080 without creating a copy first, and the capsule destructor will not be
2081 called. The document will then eventually be cleaned up by lxml using
2082 the libxml2 API function <tt class="rst-docutils literal">xmlFreeDoc()</tt> once it is no longer used.</p>
2083 <p>If no copy is made, later modifications of the tree outside of lxml
2084 should not be attempted after transferring the ownership.</p>
2089 <a name="canonicalize"></a>
2091 <table class="details" border="1" cellpadding="3"
2092 cellspacing="0" width="100%" bgcolor="white">
2094 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2095 <tr valign="top"><td>
2096 <h3 class="epydoc"><span class="sig"><span class="sig-name">canonicalize</span>(<span class="sig-arg">...</span>)</span>
2098 </td><td align="right" valign="top"
2103 <p>Convert XML to its C14N 2.0 serialised form.</p>
2104 <p>If <em>out</em> is provided, it must be a file or file-like object that receives
2105 the serialised canonical XML output (text, not bytes) through its <tt class="rst-docutils literal">.write()</tt>
2106 method. To write to a file, open it in text mode with encoding "utf-8".
2107 If <em>out</em> is not provided, this function returns the output as text string.</p>
2108 <p>Either <em>xml_data</em> (an XML string, tree or Element) or <em>file</em>
2109 (a file path or file-like object) must be provided as input.</p>
2110 <p>The configuration options are the same as for the <tt class="rst-docutils literal">C14NWriterTarget</tt>.</p>
2115 <a name="cleanup_namespaces"></a>
2117 <table class="details" border="1" cellpadding="3"
2118 cellspacing="0" width="100%" bgcolor="white">
2120 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2121 <tr valign="top"><td>
2122 <h3 class="epydoc"><span class="sig"><span class="sig-name">cleanup_namespaces</span>(<span class="sig-arg">tree_or_element</span>,
2123 <span class="sig-arg">top_nsmap</span>=<span class="sig-default">None</span>,
2124 <span class="sig-arg">keep_ns_prefixes</span>=<span class="sig-default">None</span>)</span>
2126 </td><td align="right" valign="top"
2131 <p>Remove all namespace declarations from a subtree that are not used
2132 by any of the elements or attributes in that tree.</p>
2133 <p>If a 'top_nsmap' is provided, it must be a mapping from prefixes
2134 to namespace URIs. These namespaces will be declared on the top
2135 element of the subtree before running the cleanup, which allows
2136 moving namespace declarations to the top of the tree.</p>
2137 <p>If a 'keep_ns_prefixes' is provided, it must be a list of prefixes.
2138 These prefixes will not be removed as part of the cleanup.</p>
2143 <a name="clear_error_log"></a>
2145 <table class="details" border="1" cellpadding="3"
2146 cellspacing="0" width="100%" bgcolor="white">
2148 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2149 <tr valign="top"><td>
2150 <h3 class="epydoc"><span class="sig"><span class="sig-name">clear_error_log</span>()</span>
2152 </td><td align="right" valign="top"
2157 <p>Clear the global error log. Note that this log is already bound to a
2159 <p>Note: since lxml 2.2, the global error log is local to a thread
2160 and this function will only clear the global error log of the
2166 <a name="fromstring"></a>
2168 <table class="details" border="1" cellpadding="3"
2169 cellspacing="0" width="100%" bgcolor="white">
2171 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2172 <tr valign="top"><td>
2173 <h3 class="epydoc"><span class="sig"><span class="sig-name">fromstring</span>(<span class="sig-arg">text</span>,
2174 <span class="sig-arg">parser</span>=<span class="sig-default">None</span>,
2175 <span class="sig-arg">base_url</span>=<span class="sig-default">None</span>)</span>
2177 </td><td align="right" valign="top"
2182 <p>Parses an XML document or fragment from a string. Returns the
2183 root node (or the result returned by a parser target).</p>
2184 <p>To override the default parser with a different parser you can pass it to
2185 the <tt class="rst-docutils literal">parser</tt> keyword argument.</p>
2186 <p>The <tt class="rst-docutils literal">base_url</tt> keyword argument allows to set the original base URL of
2187 the document to support relative Paths when looking up external entities
2188 (DTD, XInclude, ...).</p>
2193 <a name="fromstringlist"></a>
2195 <table class="details" border="1" cellpadding="3"
2196 cellspacing="0" width="100%" bgcolor="white">
2198 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2199 <tr valign="top"><td>
2200 <h3 class="epydoc"><span class="sig"><span class="sig-name">fromstringlist</span>(<span class="sig-arg">strings</span>,
2201 <span class="sig-arg">parser</span>=<span class="sig-default">None</span>)</span>
2203 </td><td align="right" valign="top"
2208 <p>Parses an XML document from a sequence of strings. Returns the
2209 root node (or the result returned by a parser target).</p>
2210 <p>To override the default parser with a different parser you can pass it to
2211 the <tt class="rst-docutils literal">parser</tt> keyword argument.</p>
2216 <a name="indent"></a>
2217 <div class="private">
2218 <table class="details" border="1" cellpadding="3"
2219 cellspacing="0" width="100%" bgcolor="white">
2221 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2222 <tr valign="top"><td>
2223 <h3 class="epydoc"><span class="sig"><span class="sig-name">indent</span>(<span class="sig-arg">tree</span>,
2224 <span class="sig-arg">space</span>=<span class="sig-default">" "</span>,
2225 <span class="sig-arg">level</span>=<span class="sig-default">0</span>)</span>
2227 </td><td align="right" valign="top"
2232 <p>Indent an XML document by inserting newlines and indentation space
2234 <p><em>tree</em> is the ElementTree or Element to modify. The (root) element
2235 itself will not be changed, but the tail text of all elements in its
2236 subtree will be adapted.</p>
2237 <p><em>space</em> is the whitespace to insert for each indentation level, two
2238 space characters by default.</p>
2239 <p><em>level</em> is the initial indentation level. Setting this to a higher
2240 value than 0 can be used for indenting subtrees that are more deeply
2241 nested inside of a document.</p>
2246 <a name="parse"></a>
2248 <table class="details" border="1" cellpadding="3"
2249 cellspacing="0" width="100%" bgcolor="white">
2251 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2252 <tr valign="top"><td>
2253 <h3 class="epydoc"><span class="sig"><span class="sig-name">parse</span>(<span class="sig-arg">source</span>,
2254 <span class="sig-arg">parser</span>=<span class="sig-default">None</span>,
2255 <span class="sig-arg">base_url</span>=<span class="sig-default">None</span>)</span>
2257 </td><td align="right" valign="top"
2262 <p>Return an ElementTree object loaded with source elements. If no parser
2263 is provided as second argument, the default parser is used.</p>
2264 <p>The <tt class="rst-docutils literal">source</tt> can be any of the following:</p>
2265 <ul class="rst-simple">
2266 <li>a file name/path</li>
2267 <li>a file object</li>
2268 <li>a file-like object</li>
2269 <li>a URL using the HTTP or FTP protocol</li>
2271 <p>To parse from a string, use the <tt class="rst-docutils literal">fromstring()</tt> function instead.</p>
2272 <p>Note that it is generally faster to parse from a file path or URL
2273 than from an open file object or file-like object. Transparent
2274 decompression from gzip compressed sources is supported (unless
2275 explicitly disabled in libxml2).</p>
2276 <p>The <tt class="rst-docutils literal">base_url</tt> keyword allows setting a URL for the document
2277 when parsing from a file-like object. This is needed when looking
2278 up external entities (DTD, XInclude, ...) with relative paths.</p>
2283 <a name="parseid"></a>
2285 <table class="details" border="1" cellpadding="3"
2286 cellspacing="0" width="100%" bgcolor="white">
2288 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2289 <tr valign="top"><td>
2290 <h3 class="epydoc"><span class="sig"><span class="sig-name">parseid</span>(<span class="sig-arg">source</span>,
2291 <span class="sig-arg">parser</span>=<span class="sig-default">None</span>)</span>
2293 </td><td align="right" valign="top"
2298 <p>Parses the source into a tuple containing an ElementTree object and an
2299 ID dictionary. If no parser is provided as second argument, the default
2301 <p>Note that you must not modify the XML tree if you use the ID dictionary.
2302 The results are undefined.</p>
2307 <a name="set_default_parser"></a>
2309 <table class="details" border="1" cellpadding="3"
2310 cellspacing="0" width="100%" bgcolor="white">
2312 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2313 <tr valign="top"><td>
2314 <h3 class="epydoc"><span class="sig"><span class="sig-name">set_default_parser</span>(<span class="sig-arg">parser</span>=<span class="sig-default">None</span>)</span>
2316 </td><td align="right" valign="top"
2321 <p>Set a default parser for the current thread. This parser is used
2322 globally whenever no parser is supplied to the various parse functions of
2323 the lxml API. If this function is called without a parser (or if it is
2324 None), the default parser is reset to the original configuration.</p>
2325 <p>Note that the pre-installed default parser is not thread-safe. Avoid the
2326 default parser in multi-threaded environments. You can create a separate
2327 parser for each thread explicitly or use a parser pool.</p>
2332 <a name="strip_attributes"></a>
2334 <table class="details" border="1" cellpadding="3"
2335 cellspacing="0" width="100%" bgcolor="white">
2337 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2338 <tr valign="top"><td>
2339 <h3 class="epydoc"><span class="sig"><span class="sig-name">strip_attributes</span>(<span class="sig-arg">tree_or_element</span>,
2340 <span class="sig-arg">*attribute_names</span>)</span>
2342 </td><td align="right" valign="top"
2347 <p>Delete all attributes with the provided attribute names from an
2348 Element (or ElementTree) and its descendants.</p>
2349 <p>Attribute names can contain wildcards as in <a href="lxml.etree._Element-class.html#iter" class="link">_Element.iter</a>.</p>
2350 <p>Example usage:</p>
2351 <pre class="rst-literal-block">
2352 strip_attributes(root_element,
2354 '{http://some/ns}attrname',
2355 '{http://other/ns}*')
2361 <a name="strip_elements"></a>
2363 <table class="details" border="1" cellpadding="3"
2364 cellspacing="0" width="100%" bgcolor="white">
2366 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2367 <tr valign="top"><td>
2368 <h3 class="epydoc"><span class="sig"><span class="sig-name">strip_elements</span>(<span class="sig-arg">tree_or_element</span>,
2369 <span class="sig-arg">with_tail</span>=<span class="sig-default">True</span>,
2370 <span class="sig-arg">*tag_names</span>)</span>
2372 </td><td align="right" valign="top"
2377 <p>Delete all elements with the provided tag names from a tree or
2378 subtree. This will remove the elements and their entire subtree,
2379 including all their attributes, text content and descendants. It
2380 will also remove the tail text of the element unless you
2381 explicitly set the <tt class="rst-docutils literal">with_tail</tt> keyword argument option to False.</p>
2382 <p>Tag names can contain wildcards as in <a href="lxml.etree._Element-class.html#iter" class="link">_Element.iter</a>.</p>
2383 <p>Note that this will not delete the element (or ElementTree root
2384 element) that you passed even if it matches. It will only treat
2385 its descendants. If you want to include the root element, check
2386 its tag name directly before even calling this function.</p>
2387 <p>Example usage:</p>
2388 <pre class="rst-literal-block">
2389 strip_elements(some_element,
2390 'simpletagname', # non-namespaced tag
2391 '{http://some/ns}tagname', # namespaced tag
2392 '{http://some/other/ns}*' # any tag from a namespace
2393 lxml.etree.Comment # comments
2400 <a name="strip_tags"></a>
2402 <table class="details" border="1" cellpadding="3"
2403 cellspacing="0" width="100%" bgcolor="white">
2405 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2406 <tr valign="top"><td>
2407 <h3 class="epydoc"><span class="sig"><span class="sig-name">strip_tags</span>(<span class="sig-arg">tree_or_element</span>,
2408 <span class="sig-arg">*tag_names</span>)</span>
2410 </td><td align="right" valign="top"
2415 <p>Delete all elements with the provided tag names from a tree or
2416 subtree. This will remove the elements and their attributes, but
2417 <em>not</em> their text/tail content or descendants. Instead, it will
2418 merge the text content and children of the element into its
2420 <p>Tag names can contain wildcards as in <a href="lxml.etree._Element-class.html#iter" class="link">_Element.iter</a>.</p>
2421 <p>Note that this will not delete the element (or ElementTree root
2422 element) that you passed even if it matches. It will only treat
2423 its descendants.</p>
2424 <p>Example usage:</p>
2425 <pre class="rst-literal-block">
2426 strip_tags(some_element,
2427 'simpletagname', # non-namespaced tag
2428 '{http://some/ns}tagname', # namespaced tag
2429 '{http://some/other/ns}*' # any tag from a namespace
2430 Comment # comments (including their text!)
2437 <a name="tostring"></a>
2439 <table class="details" border="1" cellpadding="3"
2440 cellspacing="0" width="100%" bgcolor="white">
2442 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2443 <tr valign="top"><td>
2444 <h3 class="epydoc"><span class="sig"><span class="sig-name">tostring</span>(<span class="sig-arg">element_or_tree</span>,
2445 <span class="sig-arg">encoding</span>=<span class="sig-default">None</span>,
2446 <span class="sig-arg">method</span>=<span class="sig-default">"xml"</span>,
2447 <span class="sig-arg">xml_declaration</span>=<span class="sig-default">None</span>,
2448 <span class="sig-arg">pretty_print</span>=<span class="sig-default">False</span>,
2449 <span class="sig-arg">with_tail</span>=<span class="sig-default">True</span>,
2450 <span class="sig-arg">standalone</span>=<span class="sig-default">None</span>,
2451 <span class="sig-arg">doctype</span>=<span class="sig-default">None</span>,
2452 <span class="sig-arg">exclusive</span>=<span class="sig-default">False</span>,
2453 <span class="sig-arg">inclusive_ns_prefixes</span>=<span class="sig-default">None</span>,
2454 <span class="sig-arg">with_comments</span>=<span class="sig-default">True</span>,
2455 <span class="sig-arg">strip_text</span>=<span class="sig-default">False</span>,
2456 <span class="sig-arg"></span>)</span>
2458 </td><td align="right" valign="top"
2463 <p>Serialize an element to an encoded string representation of its XML
2465 <p>Defaults to ASCII encoding without XML declaration. This
2466 behaviour can be configured with the keyword arguments 'encoding'
2467 (string) and 'xml_declaration' (bool). Note that changing the
2468 encoding to a non UTF-8 compatible encoding will enable a
2469 declaration by default.</p>
2470 <p>You can also serialise to a Unicode string without declaration by
2471 passing the name <tt class="rst-docutils literal">'unicode'</tt> as encoding (or the <tt class="rst-docutils literal">str</tt> function
2472 in Py3 or <tt class="rst-docutils literal">unicode</tt> in Py2). This changes the return value from
2473 a byte string to an unencoded unicode string.</p>
2474 <p>The keyword argument 'pretty_print' (bool) enables formatted XML.</p>
2475 <p>The keyword argument 'method' selects the output method: 'xml',
2476 'html', plain 'text' (text content without tags), 'c14n' or 'c14n2'.
2477 Default is 'xml'.</p>
2478 <p>With <tt class="rst-docutils literal"><span class="pre">method="c14n"</span></tt> (C14N version 1), the options <tt class="rst-docutils literal">exclusive</tt>,
2479 <tt class="rst-docutils literal">with_comments</tt> and <tt class="rst-docutils literal">inclusive_ns_prefixes</tt> request exclusive
2480 C14N, include comments, and list the inclusive prefixes respectively.</p>
2481 <p>With <tt class="rst-docutils literal"><span class="pre">method="c14n2"</span></tt> (C14N version 2), the <tt class="rst-docutils literal">with_comments</tt> and
2482 <tt class="rst-docutils literal">strip_text</tt> options control the output of comments and text space
2483 according to C14N 2.0.</p>
2484 <p>Passing a boolean value to the <tt class="rst-docutils literal">standalone</tt> option will output
2485 an XML declaration with the corresponding <tt class="rst-docutils literal">standalone</tt> flag.</p>
2486 <p>The <tt class="rst-docutils literal">doctype</tt> option allows passing in a plain string that will
2487 be serialised before the XML tree. Note that passing in non
2488 well-formed content here will make the XML output non well-formed.
2489 Also, an existing doctype in the document tree will not be removed
2490 when serialising an ElementTree instance.</p>
2491 <p>You can prevent the tail text of the element from being serialised
2492 by passing the boolean <tt class="rst-docutils literal">with_tail</tt> option. This has no impact
2493 on the tail text of children, which will always be serialised.</p>
2498 <a name="tostringlist"></a>
2500 <table class="details" border="1" cellpadding="3"
2501 cellspacing="0" width="100%" bgcolor="white">
2503 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2504 <tr valign="top"><td>
2505 <h3 class="epydoc"><span class="sig"><span class="sig-name">tostringlist</span>(<span class="sig-arg">element_or_tree</span>,
2506 <span class="sig-arg">*args</span>,
2507 <span class="sig-arg">**kwargs</span>)</span>
2509 </td><td align="right" valign="top"
2514 <p>Serialize an element to an encoded string representation of its XML
2515 tree, stored in a list of partial strings.</p>
2516 <p>This is purely for ElementTree 1.3 compatibility. The result is a
2517 single string wrapped in a list.</p>
2522 <a name="tounicode"></a>
2524 <table class="details" border="1" cellpadding="3"
2525 cellspacing="0" width="100%" bgcolor="white">
2527 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2528 <tr valign="top"><td>
2529 <h3 class="epydoc"><span class="sig"><span class="sig-name">tounicode</span>(<span class="sig-arg">element_or_tree</span>,
2530 <span class="sig-arg">method</span>=<span class="sig-default">"xml"</span>,
2531 <span class="sig-arg">pretty_print</span>=<span class="sig-default">False</span>,
2532 <span class="sig-arg">with_tail</span>=<span class="sig-default">True</span>,
2533 <span class="sig-arg">doctype</span>=<span class="sig-default">None</span>)</span>
2535 </td><td align="right" valign="top"
2540 <p>Serialize an element to the Python unicode representation of its XML
2542 <p>Note that the result does not carry an XML encoding declaration and is
2543 therefore not necessarily suited for serialization to byte streams without
2544 further treatment.</p>
2545 <p>The boolean keyword argument 'pretty_print' enables formatted XML.</p>
2546 <p>The keyword argument 'method' selects the output method: 'xml',
2547 'html' or plain 'text'.</p>
2548 <p>You can prevent the tail text of the element from being serialised
2549 by passing the boolean <tt class="rst-docutils literal">with_tail</tt> option. This has no impact
2550 on the tail text of children, which will always be serialised.</p>
2553 <div class="fields"> <p><strong>Deprecated:</strong>
2554 use <tt class="rst-docutils literal">tostring(el, <span class="pre">encoding='unicode')</span></tt> instead.
2556 </div></td></tr></table>
2558 <a name="use_global_python_log"></a>
2560 <table class="details" border="1" cellpadding="3"
2561 cellspacing="0" width="100%" bgcolor="white">
2563 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2564 <tr valign="top"><td>
2565 <h3 class="epydoc"><span class="sig"><span class="sig-name">use_global_python_log</span>(<span class="sig-arg">log</span>)</span>
2567 </td><td align="right" valign="top"
2572 <p>Replace the global error log by an etree.PyErrorLog that uses the
2573 standard Python logging package.</p>
2574 <p>Note that this disables access to the global error log from exceptions.
2575 Parsers, XSLT etc. will continue to provide their normal local error log.</p>
2576 <p>Note: prior to lxml 2.2, this changed the error log globally.
2577 Since lxml 2.2, the global error log is local to a thread and this
2578 function will only set the global error log of the current thread.</p>
2584 <!-- ==================== VARIABLES DETAILS ==================== -->
2585 <a name="section-VariablesDetails"></a>
2586 <table class="details" border="1" cellpadding="3"
2587 cellspacing="0" width="100%" bgcolor="white">
2588 <tr bgcolor="#70b0f0" class="table-header">
2589 <td colspan="2" class="table-header">
2590 <table border="0" cellpadding="0" cellspacing="0" width="100%">
2592 <td align="left"><span class="table-header">Variables Details</span></td>
2593 <td align="right" valign="top"
2594 ><span class="options">[<a href="#section-VariablesDetails"
2595 class="privatelink" onclick="toggle_private();"
2596 >hide private</a>]</span></td>
2602 <a name="__pyx_capi__"></a>
2603 <div class="private">
2604 <table class="details" border="1" cellpadding="3"
2605 cellspacing="0" width="100%" bgcolor="white">
2607 <h3 class="epydoc">__pyx_capi__</h3>
2613 <dd><table><tr><td><pre class="variable">
2614 <code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">adoptExternalDocument</code><code class="variable-quote">'</code><code class="variable-op">: </code><capsule object "struct LxmlElementTree *(xm<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
2615 lDoc *, PyObject *, int)" at 0x7f3a93c737b0><code class="variable-op">,</code>
2616 <code class="variable-quote">'</code><code class="variable-string">appendChild</code><code class="variable-quote">'</code><code class="variable-op">: </code><capsule object "void (struct LxmlElement *, struct Lx<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
2617 mlElement *)" at 0x7f3a93c73f90><code class="variable-op">,</code>
2618 <code class="variable-quote">'</code><code class="variable-string">appendChildToElement</code><code class="variable-quote">'</code><code class="variable-op">: </code><capsule object "int (struct LxmlElement *, s<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
2619 truct LxmlElement *)" at 0x7f3a93c73fc0><code class="variable-op">,</code>
2620 <code class="variable-quote">'</code><code class="variable-string">attributeValue</code><code class="variable-quote">'</code><code class="variable-op">: </code><capsule object "PyObject *(xmlNode *, xmlAttr *)" <span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
2621 at 0x7f3a93c73c60><code class="variable-op">,</code>
2622 <code class="variable-ellipsis">...</code>
2623 </pre></td></tr></table>
2628 <a name="__test__"></a>
2629 <div class="private">
2630 <table class="details" border="1" cellpadding="3"
2631 cellspacing="0" width="100%" bgcolor="white">
2633 <h3 class="epydoc">__test__</h3>
2639 <dd><table><tr><td><pre class="variable">
2640 <code class="variable-group">{</code><code class="variable-quote">u'</code><code class="variable-string">FunctionNamespace (line 207)</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">u'''</code><code class="variable-string">FunctionNamespace(ns_uri)</code>
2641 <code class="variable-string"></code>
2642 <code class="variable-string"> Retrieve the function namespace object associated with the given</code>
2643 <code class="variable-string"> URI.</code>
2644 <code class="variable-string"></code>
2645 <code class="variable-string"> Creates a new one if it does not yet exist. A function namespace</code>
2646 <code class="variable-string"> can only be used to register extension functions.</code>
2647 <code class="variable-string"></code>
2648 <code class="variable-ellipsis">...</code>
2649 </pre></td></tr></table>
2655 <!-- ==================== NAVIGATION BAR ==================== -->
2656 <table class="navbar" border="0" width="100%" cellpadding="0"
2657 bgcolor="#a0c0ff" cellspacing="0">
2658 <tr valign="middle">
2660 <th> <a
2661 href="lxml-module.html">Home</a> </th>
2664 <th> <a
2665 href="module-tree.html">Trees</a> </th>
2668 <th> <a
2669 href="identifier-index.html">Indices</a> </th>
2672 <th> <a
2673 href="help.html">Help</a> </th>
2675 <!-- Project homepage -->
2676 <th class="navbar" align="right" width="100%">
2677 <table border="0" cellpadding="0" cellspacing="0">
2678 <tr><th class="navbar" align="center"
2679 ><a class="navbar" target="_top" href="/">lxml API</a></th>
2683 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
2685 <td align="left" class="footer">
2686 Generated by Epydoc 3.0.1
2687 on Wed Jan 29 12:26:21 2020
2689 <td align="right" class="footer">
2690 <a target="mainFrame" href="http://epydoc.sourceforge.net"
2691 >http://epydoc.sourceforge.net</a>
2696 <script type="text/javascript">
2698 // Private objects are initially displayed (because if
2699 // javascript is turned off then we want them to be
2700 // visible); but by default, we want to hide them. So hide
2701 // them unless we have a cookie that says to show them.