1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
|
<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>lxml</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th bgcolor="#70b0f0" class="navbar-select"
> Home </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="/">lxml API</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
Package lxml
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="lxml-module.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== PACKAGE DESCRIPTION ==================== -->
<h1 class="epydoc">Package lxml</h1><p class="nomargin-top"><span class="codelink"><a href="lxml-pysrc.html">source code</a></span></p>
<!-- ==================== SUBMODULES ==================== -->
<a name="section-Submodules"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Submodules</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Submodules"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr><td class="summary">
<ul class="nomargin">
<li> <strong class="uidlink"><a href="lxml.ElementInclude-module.html">lxml.ElementInclude</a></strong>: <em class="summary">Limited XInclude support for the ElementTree package.</em> </li>
<li class="private"> <strong class="uidlink">lxml._elementpath</strong> </li>
<li> <strong class="uidlink"><a href="lxml.builder-module.html">lxml.builder</a></strong>: <em class="summary">The <tt class="rst-rst-docutils literal rst-docutils literal">E</tt> Element factory for generating XML documents.</em> </li>
<li> <strong class="uidlink"><a href="lxml.cssselect-module.html">lxml.cssselect</a></strong>: <em class="summary">CSS Selectors based on XPath.</em> </li>
<li> <strong class="uidlink"><a href="lxml.doctestcompare-module.html">lxml.doctestcompare</a></strong>: <em class="summary">lxml-based doctest output comparison.</em> </li>
<li> <strong class="uidlink"><a href="lxml.etree-module.html">lxml.etree</a></strong>: <em class="summary">The <tt class="rst-rst-docutils literal rst-docutils literal">lxml.etree</tt> module implements the extended ElementTree API for XML.</em> </li>
<li> <strong class="uidlink"><a href="lxml.html-module.html">lxml.html</a></strong>: <em class="summary">The <tt class="rst-rst-docutils literal rst-docutils literal">lxml.html</tt> tool set for HTML handling.</em>
<ul>
<li> <strong class="uidlink"><a href="lxml.html.ElementSoup-module.html">lxml.html.ElementSoup</a></strong>: <em class="summary">Legacy interface to the BeautifulSoup HTML parser.</em> </li>
<li> <strong class="uidlink"><a href="lxml.html.builder-module.html">lxml.html.builder</a></strong>: <em class="summary">A set of HTML generator tags for building HTML documents.</em> </li>
<li> <strong class="uidlink"><a href="lxml.html.clean-module.html">lxml.html.clean</a></strong>: <em class="summary">A cleanup tool for HTML.</em> </li>
<li> <strong class="uidlink"><a href="lxml.html.defs-module.html">lxml.html.defs</a></strong> </li>
<li> <strong class="uidlink"><a href="lxml.html.diff-module.html">lxml.html.diff</a></strong> </li>
<li> <strong class="uidlink"><a href="lxml.html.formfill-module.html">lxml.html.formfill</a></strong> </li>
<li> <strong class="uidlink"><a href="lxml.html.html5parser-module.html">lxml.html.html5parser</a></strong>: <em class="summary">An interface to html5lib that mimics the lxml.html interface.</em> </li>
<li> <strong class="uidlink"><a href="lxml.html.soupparser-module.html">lxml.html.soupparser</a></strong>: <em class="summary">External interface to the BeautifulSoup HTML parser.</em> </li>
</ul>
</li>
<li> <strong class="uidlink"><a href="lxml.includes-module.html">lxml.includes</a></strong> </li>
<li> <strong class="uidlink"><a href="lxml.isoschematron-module.html">lxml.isoschematron</a></strong>: <em class="summary">The <tt class="rst-rst-docutils literal rst-docutils literal">lxml.isoschematron</tt> package implements ISO Schematron support on top
of the pure-xslt 'skeleton' implementation.</em> </li>
<li> <strong class="uidlink"><a href="lxml.objectify-module.html">lxml.objectify</a></strong>: <em class="summary">The <tt class="rst-rst-docutils literal rst-docutils literal">lxml.objectify</tt> module implements a Python object API for XML.
It is based on <a href="lxml.etree-module.html" class="link">lxml.etree</a>.</em> </li>
<li> <strong class="uidlink"><a href="lxml.pyclasslookup-module.html">lxml.pyclasslookup</a></strong> </li>
<li> <strong class="uidlink"><a href="lxml.sax-module.html">lxml.sax</a></strong>: <em class="summary">SAX-based adapter to copy trees from/to the Python standard library.</em> </li>
<li> <strong class="uidlink"><a href="lxml.tests-module.html">lxml.tests</a></strong>: <em class="summary">The lxml test suite for lxml, ElementTree and cElementTree.</em>
<ul>
<li> <strong class="uidlink"><a href="lxml.tests.common_imports-module.html">lxml.tests.common_imports</a></strong> </li>
<li> <strong class="uidlink"><a href="lxml.tests.dummy_http_server-module.html">lxml.tests.dummy_http_server</a></strong>: <em class="summary">Simple HTTP request dumper for tests in Python 2.5+.</em> </li>
<li> <strong class="uidlink"><a href="lxml.tests.selftest-module.html">lxml.tests.selftest</a></strong> </li>
<li> <strong class="uidlink"><a href="lxml.tests.selftest2-module.html">lxml.tests.selftest2</a></strong> </li>
<li> <strong class="uidlink"><a href="lxml.tests.test_builder-module.html">lxml.tests.test_builder</a></strong> </li>
<li> <strong class="uidlink"><a href="lxml.tests.test_classlookup-module.html">lxml.tests.test_classlookup</a></strong>: <em class="summary">Tests for different Element class lookup mechanisms.</em> </li>
<li> <strong class="uidlink"><a href="lxml.tests.test_css-module.html">lxml.tests.test_css</a></strong> </li>
<li> <strong class="uidlink"><a href="lxml.tests.test_doctestcompare-module.html">lxml.tests.test_doctestcompare</a></strong> </li>
<li> <strong class="uidlink"><a href="lxml.tests.test_dtd-module.html">lxml.tests.test_dtd</a></strong>: <em class="summary">Test cases related to DTD parsing and validation</em> </li>
<li> <strong class="uidlink"><a href="lxml.tests.test_elementpath-module.html">lxml.tests.test_elementpath</a></strong>: <em class="summary">Tests for the ElementPath implementation.</em> </li>
<li> <strong class="uidlink"><a href="lxml.tests.test_elementtree-module.html">lxml.tests.test_elementtree</a></strong>: <em class="summary">Tests for the ElementTree API</em> </li>
<li> <strong class="uidlink"><a href="lxml.tests.test_errors-module.html">lxml.tests.test_errors</a></strong> </li>
<li> <strong class="uidlink"><a href="lxml.tests.test_etree-module.html">lxml.tests.test_etree</a></strong>: <em class="summary">Tests specific to the extended etree API</em> </li>
<li> <strong class="uidlink"><a href="lxml.tests.test_htmlparser-module.html">lxml.tests.test_htmlparser</a></strong>: <em class="summary">HTML parser test cases for etree</em> </li>
<li> <strong class="uidlink"><a href="lxml.tests.test_http_io-module.html">lxml.tests.test_http_io</a></strong>: <em class="summary">Web IO test cases that need Python 2.5+ (wsgiref)</em> </li>
<li> <strong class="uidlink"><a href="lxml.tests.test_incremental_xmlfile-module.html">lxml.tests.test_incremental_xmlfile</a></strong>: <em class="summary">Tests for the incremental XML serialisation API.</em> </li>
<li> <strong class="uidlink"><a href="lxml.tests.test_io-module.html">lxml.tests.test_io</a></strong>: <em class="summary">IO test cases that apply to both etree and ElementTree</em> </li>
<li> <strong class="uidlink"><a href="lxml.tests.test_isoschematron-module.html">lxml.tests.test_isoschematron</a></strong>: <em class="summary">Test cases related to ISO-Schematron parsing and validation</em> </li>
<li> <strong class="uidlink"><a href="lxml.tests.test_nsclasses-module.html">lxml.tests.test_nsclasses</a></strong>: <em class="summary">Test cases related to namespace implementation classes and the
namespace registry mechanism</em> </li>
<li> <strong class="uidlink"><a href="lxml.tests.test_objectify-module.html">lxml.tests.test_objectify</a></strong>: <em class="summary">Tests specific to the lxml.objectify API</em> </li>
<li> <strong class="uidlink"><a href="lxml.tests.test_pyclasslookup-module.html">lxml.tests.test_pyclasslookup</a></strong>: <em class="summary">Tests specific to the Python based class lookup.</em> </li>
<li> <strong class="uidlink"><a href="lxml.tests.test_relaxng-module.html">lxml.tests.test_relaxng</a></strong>: <em class="summary">Test cases related to RelaxNG parsing and validation</em> </li>
<li> <strong class="uidlink"><a href="lxml.tests.test_sax-module.html">lxml.tests.test_sax</a></strong>: <em class="summary">Test cases related to SAX I/O</em> </li>
<li> <strong class="uidlink"><a href="lxml.tests.test_schematron-module.html">lxml.tests.test_schematron</a></strong>: <em class="summary">Test cases related to Schematron parsing and validation</em> </li>
<li> <strong class="uidlink"><a href="lxml.tests.test_threading-module.html">lxml.tests.test_threading</a></strong>: <em class="summary">Tests for thread usage in lxml.etree.</em> </li>
<li> <strong class="uidlink"><a href="lxml.tests.test_unicode-module.html">lxml.tests.test_unicode</a></strong> </li>
<li> <strong class="uidlink"><a href="lxml.tests.test_xmlschema-module.html">lxml.tests.test_xmlschema</a></strong>: <em class="summary">Test cases related to XML Schema parsing and validation</em> </li>
<li> <strong class="uidlink"><a href="lxml.tests.test_xpathevaluator-module.html">lxml.tests.test_xpathevaluator</a></strong>: <em class="summary">Test cases related to XPath evaluation and the XPath class</em> </li>
<li> <strong class="uidlink"><a href="lxml.tests.test_xslt-module.html">lxml.tests.test_xslt</a></strong>: <em class="summary">Test cases related to XSLT processing</em> </li>
</ul>
</li>
<li> <strong class="uidlink"><a href="lxml.usedoctest-module.html">lxml.usedoctest</a></strong>: <em class="summary">Doctest module for XML comparison.</em> </li>
</ul></td></tr>
</table>
<br />
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Functions</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Functions"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="get_include"></a><span class="summary-sig-name">get_include</span>()</span><br />
Returns a list of header include paths (for lxml itself, libxml2
and libxslt) needed to compile C code against lxml if it was built
with statically linked libraries.</td>
<td align="right" valign="top">
<span class="codelink"><a href="lxml-pysrc.html#get_include">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Variables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="__package__"></a><span class="summary-name">__package__</span> = <code title="None">None</code><br />
hash(x)
</td>
</tr>
</table>
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th bgcolor="#70b0f0" class="navbar-select"
> Home </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="/">lxml API</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1
on Fri Dec 23 19:00:53 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
|
