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.Resolver</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 <a href="lxml.etree-module.html">Module etree</a> ::
51 <table cellpadding="0" cellspacing="0">
52 <!-- hide/show private -->
53 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
54 onclick="toggle_private();">hide private</a>]</span></td></tr>
55 <tr><td align="right"><span class="options"
56 >[<a href="frames.html" target="_top">frames</a
57 >] | <a href="lxml.etree.Resolver-class.html"
58 target="_top">no frames</a>]</span></td></tr>
63 <!-- ==================== CLASS DESCRIPTION ==================== -->
64 <h1 class="epydoc">Class Resolver</h1><p class="nomargin-top"></p>
65 <pre class="base-tree">
68 <strong class="uidshort">Resolver</strong>
71 <dl><dt>Known Subclasses:</dt>
73 <ul class="subclass-list">
74 <li><a href="lxml.tests.test_xmlschema.ETreeXMLSchemaResolversTestCase.simple_resolver-class.html">tests.test_xmlschema.ETreeXMLSchemaResolversTestCase.simple_resolver</a></li> </ul>
78 This is the base class of all resolvers.
80 <!-- ==================== INSTANCE METHODS ==================== -->
81 <a name="section-InstanceMethods"></a>
82 <table class="summary" border="1" cellpadding="3"
83 cellspacing="0" width="100%" bgcolor="white">
84 <tr bgcolor="#70b0f0" class="table-header">
85 <td colspan="2" class="table-header">
86 <table border="0" cellpadding="0" cellspacing="0" width="100%">
88 <td align="left"><span class="table-header">Instance Methods</span></td>
89 <td align="right" valign="top"
90 ><span class="options">[<a href="#section-InstanceMethods"
91 class="privatelink" onclick="toggle_private();"
92 >hide private</a>]</span></td>
98 <td width="15%" align="right" valign="top" class="summary">
99 <span class="summary-type">a new object with type S, a subtype of T</span>
100 </td><td class="summary">
101 <table width="100%" cellpadding="0" cellspacing="0" border="0">
103 <td><span class="summary-sig"><a href="lxml.etree.Resolver-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
104 <span class="summary-sig-arg">S</span>,
105 <span class="summary-sig-arg">...</span>)</span></td>
106 <td align="right" valign="top">
116 <td width="15%" align="right" valign="top" class="summary">
117 <span class="summary-type"> </span>
118 </td><td class="summary">
119 <table width="100%" cellpadding="0" cellspacing="0" border="0">
121 <td><span class="summary-sig"><a href="lxml.etree.Resolver-class.html#resolve" class="summary-sig-name">resolve</a>(<span class="summary-sig-arg">self</span>,
122 <span class="summary-sig-arg">system_url</span>,
123 <span class="summary-sig-arg">public_id</span>,
124 <span class="summary-sig-arg">context</span>)</span><br />
125 Override this method to resolve an external source by
126 <tt class="rst-docutils literal">system_url</tt> and <tt class="rst-docutils literal">public_id</tt>. The third argument is an
127 opaque context object.</td>
128 <td align="right" valign="top">
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 href="lxml.etree.Resolver-class.html#resolve_empty" class="summary-sig-name">resolve_empty</a>(<span class="summary-sig-arg">self</span>,
144 <span class="summary-sig-arg">context</span>)</span><br />
145 Return an empty input document.</td>
146 <td align="right" valign="top">
156 <td width="15%" align="right" valign="top" class="summary">
157 <span class="summary-type"> </span>
158 </td><td class="summary">
159 <table width="100%" cellpadding="0" cellspacing="0" border="0">
161 <td><span class="summary-sig"><a href="lxml.etree.Resolver-class.html#resolve_file" class="summary-sig-name">resolve_file</a>(<span class="summary-sig-arg">self</span>,
162 <span class="summary-sig-arg">f</span>,
163 <span class="summary-sig-arg">context</span>,
164 <span class="summary-sig-arg">base_url</span>=<span class="summary-sig-default">None</span>,
165 <span class="summary-sig-arg">close</span>=<span class="summary-sig-default">True</span>)</span><br />
166 Return an open file-like object as input document.</td>
167 <td align="right" valign="top">
177 <td width="15%" align="right" valign="top" class="summary">
178 <span class="summary-type"> </span>
179 </td><td class="summary">
180 <table width="100%" cellpadding="0" cellspacing="0" border="0">
182 <td><span class="summary-sig"><a href="lxml.etree.Resolver-class.html#resolve_filename" class="summary-sig-name">resolve_filename</a>(<span class="summary-sig-arg">self</span>,
183 <span class="summary-sig-arg">filename</span>,
184 <span class="summary-sig-arg">context</span>)</span><br />
185 Return the name of a parsable file as input document.</td>
186 <td align="right" valign="top">
196 <td width="15%" align="right" valign="top" class="summary">
197 <span class="summary-type"> </span>
198 </td><td class="summary">
199 <table width="100%" cellpadding="0" cellspacing="0" border="0">
201 <td><span class="summary-sig"><a href="lxml.etree.Resolver-class.html#resolve_string" class="summary-sig-name">resolve_string</a>(<span class="summary-sig-arg">self</span>,
202 <span class="summary-sig-arg">string</span>,
203 <span class="summary-sig-arg">context</span>,
204 <span class="summary-sig-arg">base_url</span>=<span class="summary-sig-default">None</span>)</span><br />
205 Return a parsable string as input document.</td>
206 <td align="right" valign="top">
216 <td colspan="2" class="summary">
217 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
218 <code>__delattr__</code>,
219 <code>__format__</code>,
220 <code>__getattribute__</code>,
221 <code>__hash__</code>,
222 <code>__init__</code>,
223 <code>__reduce__</code>,
224 <code>__reduce_ex__</code>,
225 <code>__repr__</code>,
226 <code>__setattr__</code>,
227 <code>__sizeof__</code>,
228 <code>__str__</code>,
229 <code>__subclasshook__</code>
234 <!-- ==================== PROPERTIES ==================== -->
235 <a name="section-Properties"></a>
236 <table class="summary" border="1" cellpadding="3"
237 cellspacing="0" width="100%" bgcolor="white">
238 <tr bgcolor="#70b0f0" class="table-header">
239 <td colspan="2" class="table-header">
240 <table border="0" cellpadding="0" cellspacing="0" width="100%">
242 <td align="left"><span class="table-header">Properties</span></td>
243 <td align="right" valign="top"
244 ><span class="options">[<a href="#section-Properties"
245 class="privatelink" onclick="toggle_private();"
246 >hide private</a>]</span></td>
252 <td colspan="2" class="summary">
253 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
254 <code>__class__</code>
259 <!-- ==================== METHOD DETAILS ==================== -->
260 <a name="section-MethodDetails"></a>
261 <table class="details" border="1" cellpadding="3"
262 cellspacing="0" width="100%" bgcolor="white">
263 <tr bgcolor="#70b0f0" class="table-header">
264 <td colspan="2" class="table-header">
265 <table border="0" cellpadding="0" cellspacing="0" width="100%">
267 <td align="left"><span class="table-header">Method Details</span></td>
268 <td align="right" valign="top"
269 ><span class="options">[<a href="#section-MethodDetails"
270 class="privatelink" onclick="toggle_private();"
271 >hide private</a>]</span></td>
277 <a name="__new__"></a>
279 <table class="details" border="1" cellpadding="3"
280 cellspacing="0" width="100%" bgcolor="white">
282 <table width="100%" cellpadding="0" cellspacing="0" border="0">
283 <tr valign="top"><td>
284 <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
285 <span class="sig-arg">S</span>,
286 <span class="sig-arg">...</span>)</span>
288 </td><td align="right" valign="top"
295 <dt>Returns: a new object with type S, a subtype of T</dt>
302 <a name="resolve"></a>
304 <table class="details" border="1" cellpadding="3"
305 cellspacing="0" width="100%" bgcolor="white">
307 <table width="100%" cellpadding="0" cellspacing="0" border="0">
308 <tr valign="top"><td>
309 <h3 class="epydoc"><span class="sig"><span class="sig-name">resolve</span>(<span class="sig-arg">self</span>,
310 <span class="sig-arg">system_url</span>,
311 <span class="sig-arg">public_id</span>,
312 <span class="sig-arg">context</span>)</span>
314 </td><td align="right" valign="top"
319 <p>Override this method to resolve an external source by
320 <tt class="rst-rst-docutils literal rst-docutils literal">system_url</tt> and <tt class="rst-rst-docutils literal rst-docutils literal">public_id</tt>. The third argument is an
321 opaque context object.</p>
322 <p>Return the result of one of the <tt class="rst-docutils literal"><span class="pre">resolve_*()</span></tt> methods.</p>
327 <a name="resolve_empty"></a>
329 <table class="details" border="1" cellpadding="3"
330 cellspacing="0" width="100%" bgcolor="white">
332 <table width="100%" cellpadding="0" cellspacing="0" border="0">
333 <tr valign="top"><td>
334 <h3 class="epydoc"><span class="sig"><span class="sig-name">resolve_empty</span>(<span class="sig-arg">self</span>,
335 <span class="sig-arg">context</span>)</span>
337 </td><td align="right" valign="top"
342 <p>Return an empty input document.</p>
343 <p>Pass context as parameter.</p>
348 <a name="resolve_file"></a>
350 <table class="details" border="1" cellpadding="3"
351 cellspacing="0" width="100%" bgcolor="white">
353 <table width="100%" cellpadding="0" cellspacing="0" border="0">
354 <tr valign="top"><td>
355 <h3 class="epydoc"><span class="sig"><span class="sig-name">resolve_file</span>(<span class="sig-arg">self</span>,
356 <span class="sig-arg">f</span>,
357 <span class="sig-arg">context</span>,
358 <span class="sig-arg">base_url</span>=<span class="sig-default">None</span>,
359 <span class="sig-arg">close</span>=<span class="sig-default">True</span>)</span>
361 </td><td align="right" valign="top"
366 <p>Return an open file-like object as input document.</p>
367 <p>Pass open file and context as parameters. You can pass the
368 base URL or filename of the file through the <tt class="rst-docutils literal">base_url</tt>
369 keyword argument. If the <tt class="rst-docutils literal">close</tt> flag is True (the
370 default), the file will be closed after reading.</p>
371 <p>Note that using <tt class="rst-docutils literal">.resolve_filename()</tt> is more efficient,
372 especially in threaded environments.</p>
377 <a name="resolve_filename"></a>
379 <table class="details" border="1" cellpadding="3"
380 cellspacing="0" width="100%" bgcolor="white">
382 <table width="100%" cellpadding="0" cellspacing="0" border="0">
383 <tr valign="top"><td>
384 <h3 class="epydoc"><span class="sig"><span class="sig-name">resolve_filename</span>(<span class="sig-arg">self</span>,
385 <span class="sig-arg">filename</span>,
386 <span class="sig-arg">context</span>)</span>
388 </td><td align="right" valign="top"
393 <p>Return the name of a parsable file as input document.</p>
394 <p>Pass filename and context as parameters. You can also pass a
395 URL with an HTTP, FTP or file target.</p>
400 <a name="resolve_string"></a>
402 <table class="details" border="1" cellpadding="3"
403 cellspacing="0" width="100%" bgcolor="white">
405 <table width="100%" cellpadding="0" cellspacing="0" border="0">
406 <tr valign="top"><td>
407 <h3 class="epydoc"><span class="sig"><span class="sig-name">resolve_string</span>(<span class="sig-arg">self</span>,
408 <span class="sig-arg">string</span>,
409 <span class="sig-arg">context</span>,
410 <span class="sig-arg">base_url</span>=<span class="sig-default">None</span>)</span>
412 </td><td align="right" valign="top"
417 <p>Return a parsable string as input document.</p>
418 <p>Pass data string and context as parameters. You can pass the
419 source URL or filename through the <tt class="rst-docutils literal">base_url</tt> keyword
426 <!-- ==================== NAVIGATION BAR ==================== -->
427 <table class="navbar" border="0" width="100%" cellpadding="0"
428 bgcolor="#a0c0ff" cellspacing="0">
431 <th> <a
432 href="lxml-module.html">Home</a> </th>
435 <th> <a
436 href="module-tree.html">Trees</a> </th>
439 <th> <a
440 href="identifier-index.html">Indices</a> </th>
443 <th> <a
444 href="help.html">Help</a> </th>
446 <!-- Project homepage -->
447 <th class="navbar" align="right" width="100%">
448 <table border="0" cellpadding="0" cellspacing="0">
449 <tr><th class="navbar" align="center"
450 ><a class="navbar" target="_top" href="/">lxml API</a></th>
454 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
456 <td align="left" class="footer">
457 Generated by Epydoc 3.0.1 on Tue Jul 31 10:14:18 2012
459 <td align="right" class="footer">
460 <a target="mainFrame" href="http://epydoc.sourceforge.net"
461 >http://epydoc.sourceforge.net</a>
466 <script type="text/javascript">
468 // Private objects are initially displayed (because if
469 // javascript is turned off then we want them to be
470 // visible); but by default, we want to hide them. So hide
471 // them unless we have a cookie that says to show them.