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.ElementInclude</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> ::
46 Module ElementInclude
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.ElementInclude-module.html"
57 target="_top">no frames</a>]</span></td></tr>
62 <!-- ==================== MODULE DESCRIPTION ==================== -->
63 <h1 class="epydoc">Module ElementInclude</h1><p class="nomargin-top"><span class="codelink"><a href="lxml.ElementInclude-pysrc.html">source code</a></span></p>
64 <p>Limited XInclude support for the ElementTree package.</p>
65 <p>While lxml.etree has full support for XInclude (see
66 <code class="link">etree.ElementTree.xinclude()</code>), this module provides a simpler, pure
67 Python, ElementTree compatible implementation that supports a simple
68 form of custom URL resolvers.</p>
70 <!-- ==================== 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.ElementInclude.FatalIncludeError-class.html" class="summary-name">FatalIncludeError</a>
95 <td width="15%" align="right" valign="top" class="summary">
96 <span class="summary-type"> </span>
97 </td><td class="summary">
98 <a href="lxml.ElementInclude.LimitedRecursiveIncludeError-class.html" class="summary-name">LimitedRecursiveIncludeError</a>
102 <!-- ==================== FUNCTIONS ==================== -->
103 <a name="section-Functions"></a>
104 <table class="summary" border="1" cellpadding="3"
105 cellspacing="0" width="100%" bgcolor="white">
106 <tr bgcolor="#70b0f0" class="table-header">
107 <td colspan="2" class="table-header">
108 <table border="0" cellpadding="0" cellspacing="0" width="100%">
110 <td align="left"><span class="table-header">Functions</span></td>
111 <td align="right" valign="top"
112 ><span class="options">[<a href="#section-Functions"
113 class="privatelink" onclick="toggle_private();"
114 >hide private</a>]</span></td>
120 <td width="15%" align="right" valign="top" class="summary">
121 <span class="summary-type"> </span>
122 </td><td class="summary">
123 <table width="100%" cellpadding="0" cellspacing="0" border="0">
125 <td><span class="summary-sig"><a name="default_loader"></a><span class="summary-sig-name">default_loader</span>(<span class="summary-sig-arg">href</span>,
126 <span class="summary-sig-arg">parse</span>,
127 <span class="summary-sig-arg">encoding</span>=<span class="summary-sig-default">None</span>)</span></td>
128 <td align="right" valign="top">
129 <span class="codelink"><a href="lxml.ElementInclude-pysrc.html#default_loader">source code</a></span>
138 <td width="15%" align="right" valign="top" class="summary">
139 <span class="summary-type"> </span>
140 </td><td class="summary">
141 <table width="100%" cellpadding="0" cellspacing="0" border="0">
143 <td><span class="summary-sig"><a name="_lxml_default_loader"></a><span class="summary-sig-name">_lxml_default_loader</span>(<span class="summary-sig-arg">href</span>,
144 <span class="summary-sig-arg">parse</span>,
145 <span class="summary-sig-arg">encoding</span>=<span class="summary-sig-default">None</span>,
146 <span class="summary-sig-arg">parser</span>=<span class="summary-sig-default">None</span>)</span></td>
147 <td align="right" valign="top">
148 <span class="codelink"><a href="lxml.ElementInclude-pysrc.html#_lxml_default_loader">source code</a></span>
157 <td width="15%" align="right" valign="top" class="summary">
158 <span class="summary-type"> </span>
159 </td><td class="summary">
160 <table width="100%" cellpadding="0" cellspacing="0" border="0">
162 <td><span class="summary-sig"><a name="_wrap_et_loader"></a><span class="summary-sig-name">_wrap_et_loader</span>(<span class="summary-sig-arg">loader</span>)</span></td>
163 <td align="right" valign="top">
164 <span class="codelink"><a href="lxml.ElementInclude-pysrc.html#_wrap_et_loader">source code</a></span>
173 <td width="15%" align="right" valign="top" class="summary">
174 <span class="summary-type"> </span>
175 </td><td class="summary">
176 <table width="100%" cellpadding="0" cellspacing="0" border="0">
178 <td><span class="summary-sig"><a name="include"></a><span class="summary-sig-name">include</span>(<span class="summary-sig-arg">elem</span>,
179 <span class="summary-sig-arg">loader</span>=<span class="summary-sig-default">None</span>,
180 <span class="summary-sig-arg">base_url</span>=<span class="summary-sig-default">None</span>,
181 <span class="summary-sig-arg">max_depth</span>=<span class="summary-sig-default">6</span>)</span></td>
182 <td align="right" valign="top">
183 <span class="codelink"><a href="lxml.ElementInclude-pysrc.html#include">source code</a></span>
192 <td width="15%" align="right" valign="top" class="summary">
193 <span class="summary-type"> </span>
194 </td><td class="summary">
195 <table width="100%" cellpadding="0" cellspacing="0" border="0">
197 <td><span class="summary-sig"><a name="_include"></a><span class="summary-sig-name">_include</span>(<span class="summary-sig-arg">elem</span>,
198 <span class="summary-sig-arg">loader</span>=<span class="summary-sig-default">None</span>,
199 <span class="summary-sig-arg">base_url</span>=<span class="summary-sig-default">None</span>,
200 <span class="summary-sig-arg">max_depth</span>=<span class="summary-sig-default">6</span>,
201 <span class="summary-sig-arg">_parent_hrefs</span>=<span class="summary-sig-default">None</span>)</span></td>
202 <td align="right" valign="top">
203 <span class="codelink"><a href="lxml.ElementInclude-pysrc.html#_include">source code</a></span>
212 <!-- ==================== VARIABLES ==================== -->
213 <a name="section-Variables"></a>
214 <table class="summary" border="1" cellpadding="3"
215 cellspacing="0" width="100%" bgcolor="white">
216 <tr bgcolor="#70b0f0" class="table-header">
217 <td colspan="2" class="table-header">
218 <table border="0" cellpadding="0" cellspacing="0" width="100%">
220 <td align="left"><span class="table-header">Variables</span></td>
221 <td align="right" valign="top"
222 ><span class="options">[<a href="#section-Variables"
223 class="privatelink" onclick="toggle_private();"
224 >hide private</a>]</span></td>
230 <td width="15%" align="right" valign="top" class="summary">
231 <span class="summary-type"> </span>
232 </td><td class="summary">
233 <a name="XINCLUDE"></a><span class="summary-name">XINCLUDE</span> = <code title="'{http://www.w3.org/2001/XInclude}'"><code class="variable-quote">'</code><code class="variable-string">{http://www.w3.org/2001/XInclude}</code><code class="variable-quote">'</code></code>
237 <td width="15%" align="right" valign="top" class="summary">
238 <span class="summary-type"> </span>
239 </td><td class="summary">
240 <a name="XINCLUDE_INCLUDE"></a><span class="summary-name">XINCLUDE_INCLUDE</span> = <code title="'{http://www.w3.org/2001/XInclude}include'"><code class="variable-quote">'</code><code class="variable-string">{http://www.w3.org/2001/XInclude}include</code><code class="variable-quote">'</code></code>
244 <td width="15%" align="right" valign="top" class="summary">
245 <span class="summary-type"> </span>
246 </td><td class="summary">
247 <a name="XINCLUDE_FALLBACK"></a><span class="summary-name">XINCLUDE_FALLBACK</span> = <code title="'{http://www.w3.org/2001/XInclude}fallback'"><code class="variable-quote">'</code><code class="variable-string">{http://www.w3.org/2001/XInclude}fallback</code><code class="variable-quote">'</code></code>
251 <td width="15%" align="right" valign="top" class="summary">
252 <span class="summary-type"> </span>
253 </td><td class="summary">
254 <a name="XINCLUDE_ITER_TAG"></a><span class="summary-name">XINCLUDE_ITER_TAG</span> = <code title="'{http://www.w3.org/2001/XInclude}*'"><code class="variable-quote">'</code><code class="variable-string">{http://www.w3.org/2001/XInclude}*</code><code class="variable-quote">'</code></code>
258 <td width="15%" align="right" valign="top" class="summary">
259 <span class="summary-type"> </span>
260 </td><td class="summary">
261 <a name="DEFAULT_MAX_INCLUSION_DEPTH"></a><span class="summary-name">DEFAULT_MAX_INCLUSION_DEPTH</span> = <code title="6">6</code>
265 <td width="15%" align="right" valign="top" class="summary">
266 <span class="summary-type"> </span>
267 </td><td class="summary">
268 <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'lxml'"><code class="variable-quote">'</code><code class="variable-string">lxml</code><code class="variable-quote">'</code></code>
272 <!-- ==================== NAVIGATION BAR ==================== -->
273 <table class="navbar" border="0" width="100%" cellpadding="0"
274 bgcolor="#a0c0ff" cellspacing="0">
277 <th> <a
278 href="lxml-module.html">Home</a> </th>
281 <th> <a
282 href="module-tree.html">Trees</a> </th>
285 <th> <a
286 href="identifier-index.html">Indices</a> </th>
289 <th> <a
290 href="help.html">Help</a> </th>
292 <!-- Project homepage -->
293 <th class="navbar" align="right" width="100%">
294 <table border="0" cellpadding="0" cellspacing="0">
295 <tr><th class="navbar" align="center"
296 ><a class="navbar" target="_top" href="/">lxml API</a></th>
300 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
302 <td align="left" class="footer">
303 Generated by Epydoc 3.0.1
304 on Wed Jan 29 12:26:21 2020
306 <td align="right" class="footer">
307 <a target="mainFrame" href="http://epydoc.sourceforge.net"
308 >http://epydoc.sourceforge.net</a>
313 <script type="text/javascript">
315 // Private objects are initially displayed (because if
316 // javascript is turned off then we want them to be
317 // visible); but by default, we want to hide them. So hide
318 // them unless we have a cookie that says to show them.