4 <html class="writer-html5" lang="en" >
8 <meta name="viewport" content="width=device-width, initial-scale=1.0">
10 <title>lxml.ElementInclude module — lxml documentation</title>
14 <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
15 <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
24 <script src="_static/js/html5shiv.min.js"></script>
28 <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
29 <script src="_static/jquery.js"></script>
30 <script src="_static/underscore.js"></script>
31 <script src="_static/doctools.js"></script>
32 <script src="_static/language_data.js"></script>
34 <script type="text/javascript" src="_static/js/theme.js"></script>
37 <link rel="index" title="Index" href="genindex.html" />
38 <link rel="search" title="Search" href="search.html" />
39 <link rel="next" title="lxml._elementpath module" href="lxml._elementpath.html" />
40 <link rel="prev" title="lxml.isoschematron package" href="lxml.isoschematron.html" />
43 <body class="wy-body-for-nav">
46 <div class="wy-grid-for-nav">
48 <nav data-toggle="wy-nav-shift" class="wy-nav-side">
49 <div class="wy-side-scroll">
50 <div class="wy-side-nav-search" >
54 <a href="index.html" class="icon icon-home" alt="Documentation Home"> lxml
59 <img src="_static/python-xml.png" class="logo" alt="Logo"/>
74 <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
75 <input type="text" name="q" placeholder="Search docs" />
76 <input type="hidden" name="check_keywords" value="yes" />
77 <input type="hidden" name="area" value="default" />
85 <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
93 <li class="toctree-l1 current"><a class="reference internal" href="lxml.html">lxml package</a><ul class="current">
94 <li class="toctree-l2"><a class="reference internal" href="lxml.html.html">lxml.html package</a><ul>
95 <li class="toctree-l3"><a class="reference internal" href="lxml.html.ElementSoup.html">lxml.html.ElementSoup module</a></li>
96 <li class="toctree-l3"><a class="reference internal" href="lxml.html._diffcommand.html">lxml.html._diffcommand module</a></li>
97 <li class="toctree-l3"><a class="reference internal" href="lxml.html._setmixin.html">lxml.html._setmixin module</a></li>
98 <li class="toctree-l3"><a class="reference internal" href="lxml.html.builder.html">lxml.html.builder module</a></li>
99 <li class="toctree-l3"><a class="reference internal" href="lxml.html.clean.html">lxml.html.clean module</a></li>
100 <li class="toctree-l3"><a class="reference internal" href="lxml.html.defs.html">lxml.html.defs module</a></li>
101 <li class="toctree-l3"><a class="reference internal" href="lxml.html.diff.html">lxml.html.diff module</a></li>
102 <li class="toctree-l3"><a class="reference internal" href="lxml.html.formfill.html">lxml.html.formfill module</a></li>
103 <li class="toctree-l3"><a class="reference internal" href="lxml.html.html5parser.html">lxml.html.html5parser module</a></li>
104 <li class="toctree-l3"><a class="reference internal" href="lxml.html.soupparser.html">lxml.html.soupparser module</a></li>
107 <li class="toctree-l2"><a class="reference internal" href="lxml.isoschematron.html">lxml.isoschematron package</a></li>
108 <li class="toctree-l2 current"><a class="current reference internal" href="#">lxml.ElementInclude module</a></li>
109 <li class="toctree-l2"><a class="reference internal" href="lxml._elementpath.html">lxml._elementpath module</a></li>
110 <li class="toctree-l2"><a class="reference internal" href="lxml.builder.html">lxml.builder module</a></li>
111 <li class="toctree-l2"><a class="reference internal" href="lxml.cssselect.html">lxml.cssselect module</a></li>
112 <li class="toctree-l2"><a class="reference internal" href="lxml.doctestcompare.html">lxml.doctestcompare module</a></li>
113 <li class="toctree-l2"><a class="reference internal" href="lxml.etree.html">lxml.etree module</a></li>
114 <li class="toctree-l2"><a class="reference internal" href="lxml.objectify.html">lxml.objectify module</a></li>
115 <li class="toctree-l2"><a class="reference internal" href="lxml.sax.html">lxml.sax module</a></li>
127 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
130 <nav class="wy-nav-top" aria-label="top navigation">
132 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
133 <a href="index.html">lxml</a>
138 <div class="wy-nav-content">
140 <div class="rst-content">
158 <div role="navigation" aria-label="breadcrumbs navigation">
160 <ul class="wy-breadcrumbs">
162 <li><a href="index.html" class="icon icon-home"></a> »</li>
164 <li><a href="lxml.html">lxml package</a> »</li>
166 <li>lxml.ElementInclude module</li>
169 <li class="wy-breadcrumbs-aside">
172 <a href="_sources/lxml.ElementInclude.rst.txt" rel="nofollow"> View page source</a>
182 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
183 <div itemprop="articleBody">
185 <div class="section" id="module-lxml.ElementInclude">
186 <span id="lxml-elementinclude-module"></span><h1>lxml.ElementInclude module<a class="headerlink" href="#module-lxml.ElementInclude" title="Permalink to this headline">¶</a></h1>
187 <p>Limited XInclude support for the ElementTree package.</p>
188 <p>While lxml.etree has full support for XInclude (see
189 <cite>etree.ElementTree.xinclude()</cite>), this module provides a simpler, pure
190 Python, ElementTree compatible implementation that supports a simple
191 form of custom URL resolvers.</p>
192 <dl class="py exception">
193 <dt id="lxml.ElementInclude.FatalIncludeError">
194 <em class="property">exception </em><code class="sig-prename descclassname">lxml.ElementInclude.</code><code class="sig-name descname">FatalIncludeError</code><a class="reference internal" href="_modules/lxml/ElementInclude.html#FatalIncludeError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#lxml.ElementInclude.FatalIncludeError" title="Permalink to this definition">¶</a></dt>
195 <dd><p>Bases: <a class="reference internal" href="lxml.etree.html#lxml.etree.LxmlSyntaxError" title="lxml.etree.LxmlSyntaxError"><code class="xref py py-class docutils literal notranslate"><span class="pre">lxml.etree.LxmlSyntaxError</span></code></a></p>
198 <dl class="py exception">
199 <dt id="lxml.ElementInclude.LimitedRecursiveIncludeError">
200 <em class="property">exception </em><code class="sig-prename descclassname">lxml.ElementInclude.</code><code class="sig-name descname">LimitedRecursiveIncludeError</code><a class="reference internal" href="_modules/lxml/ElementInclude.html#LimitedRecursiveIncludeError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#lxml.ElementInclude.LimitedRecursiveIncludeError" title="Permalink to this definition">¶</a></dt>
201 <dd><p>Bases: <a class="reference internal" href="#lxml.ElementInclude.FatalIncludeError" title="lxml.ElementInclude.FatalIncludeError"><code class="xref py py-class docutils literal notranslate"><span class="pre">lxml.ElementInclude.FatalIncludeError</span></code></a></p>
204 <dl class="py function">
205 <dt id="lxml.ElementInclude._include">
206 <code class="sig-prename descclassname">lxml.ElementInclude.</code><code class="sig-name descname">_include</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">elem</span></em>, <em class="sig-param"><span class="n">loader</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">base_url</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">max_depth</span><span class="o">=</span><span class="default_value">6</span></em>, <em class="sig-param"><span class="n">_parent_hrefs</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/lxml/ElementInclude.html#_include"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#lxml.ElementInclude._include" title="Permalink to this definition">¶</a></dt>
209 <dl class="py function">
210 <dt id="lxml.ElementInclude._lxml_default_loader">
211 <code class="sig-prename descclassname">lxml.ElementInclude.</code><code class="sig-name descname">_lxml_default_loader</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">href</span></em>, <em class="sig-param"><span class="n">parse</span></em>, <em class="sig-param"><span class="n">encoding</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">parser</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/lxml/ElementInclude.html#_lxml_default_loader"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#lxml.ElementInclude._lxml_default_loader" title="Permalink to this definition">¶</a></dt>
214 <dl class="py function">
215 <dt id="lxml.ElementInclude._wrap_et_loader">
216 <code class="sig-prename descclassname">lxml.ElementInclude.</code><code class="sig-name descname">_wrap_et_loader</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">loader</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/lxml/ElementInclude.html#_wrap_et_loader"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#lxml.ElementInclude._wrap_et_loader" title="Permalink to this definition">¶</a></dt>
219 <dl class="py function">
220 <dt id="lxml.ElementInclude.default_loader">
221 <code class="sig-prename descclassname">lxml.ElementInclude.</code><code class="sig-name descname">default_loader</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">href</span></em>, <em class="sig-param"><span class="n">parse</span></em>, <em class="sig-param"><span class="n">encoding</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/lxml/ElementInclude.html#default_loader"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#lxml.ElementInclude.default_loader" title="Permalink to this definition">¶</a></dt>
224 <dl class="py function">
225 <dt id="lxml.ElementInclude.include">
226 <code class="sig-prename descclassname">lxml.ElementInclude.</code><code class="sig-name descname">include</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">elem</span></em>, <em class="sig-param"><span class="n">loader</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">base_url</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">max_depth</span><span class="o">=</span><span class="default_value">6</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/lxml/ElementInclude.html#include"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#lxml.ElementInclude.include" title="Permalink to this definition">¶</a></dt>
237 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
239 <a href="lxml._elementpath.html" class="btn btn-neutral float-right" title="lxml._elementpath module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
242 <a href="lxml.isoschematron.html" class="btn btn-neutral float-left" title="lxml.isoschematron package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
249 <div role="contentinfo">
252 © Copyright 2020, lxml dev team
259 Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
261 <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
263 provided by <a href="https://readthedocs.org">Read the Docs</a>.
275 <script type="text/javascript">
277 SphinxRtdTheme.Navigation.enable(true);