<?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.etree.Resolver</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> <a href="lxml-module.html">Home</a> </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"> <a href="lxml-module.html">Package lxml</a> :: <a href="lxml.etree-module.html">Module etree</a> :: Class Resolver </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.etree.Resolver-class.html" target="_top">no frames</a>]</span></td></tr> </table> </td> </tr> </table> <!-- ==================== CLASS DESCRIPTION ==================== --> <h1 class="epydoc">Class Resolver</h1><p class="nomargin-top"></p> <pre class="base-tree"> object --+ | <strong class="uidshort">Resolver</strong> </pre> <dl><dt>Known Subclasses:</dt> <dd> <ul class="subclass-list"> <li><a href="lxml.tests.test_xmlschema.ETreeXMLSchemaResolversTestCase.simple_resolver-class.html">tests.test_xmlschema.ETreeXMLSchemaResolversTestCase.simple_resolver</a></li> </ul> </dd></dl> <hr /> This is the base class of all resolvers. <!-- ==================== INSTANCE METHODS ==================== --> <a name="section-InstanceMethods"></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">Instance Methods</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-InstanceMethods" 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">a new object with type S, a subtype of T</span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <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>, <span class="summary-sig-arg">S</span>, <span class="summary-sig-arg">...</span>)</span></td> <td align="right" valign="top"> </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 href="lxml.etree.Resolver-class.html#resolve" class="summary-sig-name">resolve</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">system_url</span>, <span class="summary-sig-arg">public_id</span>, <span class="summary-sig-arg">context</span>)</span><br /> Override this method to resolve an external source by <tt class="rst-docutils literal">system_url</tt> and <tt class="rst-docutils literal">public_id</tt>. The third argument is an opaque context object.</td> <td align="right" valign="top"> </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 href="lxml.etree.Resolver-class.html#resolve_empty" class="summary-sig-name">resolve_empty</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">context</span>)</span><br /> Return an empty input document.</td> <td align="right" valign="top"> </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 href="lxml.etree.Resolver-class.html#resolve_file" class="summary-sig-name">resolve_file</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">f</span>, <span class="summary-sig-arg">context</span>, <span class="summary-sig-arg">base_url</span>=<span class="summary-sig-default">None</span>, <span class="summary-sig-arg">close</span>=<span class="summary-sig-default">True</span>)</span><br /> Return an open file-like object as input document.</td> <td align="right" valign="top"> </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 href="lxml.etree.Resolver-class.html#resolve_filename" class="summary-sig-name">resolve_filename</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">filename</span>, <span class="summary-sig-arg">context</span>)</span><br /> Return the name of a parsable file as input document.</td> <td align="right" valign="top"> </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 href="lxml.etree.Resolver-class.html#resolve_string" class="summary-sig-name">resolve_string</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">string</span>, <span class="summary-sig-arg">context</span>, <span class="summary-sig-arg">base_url</span>=<span class="summary-sig-default">None</span>)</span><br /> Return a parsable string as input document.</td> <td align="right" valign="top"> </td> </tr> </table> </td> </tr> <tr> <td colspan="2" class="summary"> <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: <code>__delattr__</code>, <code>__format__</code>, <code>__getattribute__</code>, <code>__hash__</code>, <code>__init__</code>, <code>__reduce__</code>, <code>__reduce_ex__</code>, <code>__repr__</code>, <code>__setattr__</code>, <code>__sizeof__</code>, <code>__str__</code>, <code>__subclasshook__</code> </p> </td> </tr> </table> <!-- ==================== PROPERTIES ==================== --> <a name="section-Properties"></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">Properties</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-Properties" class="privatelink" onclick="toggle_private();" >hide private</a>]</span></td> </tr> </table> </td> </tr> <tr> <td colspan="2" class="summary"> <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: <code>__class__</code> </p> </td> </tr> </table> <!-- ==================== METHOD DETAILS ==================== --> <a name="section-MethodDetails"></a> <table class="details" 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">Method Details</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-MethodDetails" class="privatelink" onclick="toggle_private();" >hide private</a>]</span></td> </tr> </table> </td> </tr> </table> <a name="__new__"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>, <span class="sig-arg">S</span>, <span class="sig-arg">...</span>)</span> </h3> </td><td align="right" valign="top" > </td> </tr></table> <dl class="fields"> <dt>Returns: a new object with type S, a subtype of T</dt> <dt>Overrides: object.__new__ </dt> </dl> </td></tr></table> </div> <a name="resolve"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">resolve</span>(<span class="sig-arg">self</span>, <span class="sig-arg">system_url</span>, <span class="sig-arg">public_id</span>, <span class="sig-arg">context</span>)</span> </h3> </td><td align="right" valign="top" > </td> </tr></table> <p>Override this method to resolve an external source by <tt class="rst-docutils literal">system_url</tt> and <tt class="rst-docutils literal">public_id</tt>. The third argument is an opaque context object.</p> <p>Return the result of one of the <tt class="rst-docutils literal"><span class="pre">resolve_*()</span></tt> methods.</p> <dl class="fields"> </dl> </td></tr></table> </div> <a name="resolve_empty"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">resolve_empty</span>(<span class="sig-arg">self</span>, <span class="sig-arg">context</span>)</span> </h3> </td><td align="right" valign="top" > </td> </tr></table> <p>Return an empty input document.</p> <p>Pass context as parameter.</p> <dl class="fields"> </dl> </td></tr></table> </div> <a name="resolve_file"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">resolve_file</span>(<span class="sig-arg">self</span>, <span class="sig-arg">f</span>, <span class="sig-arg">context</span>, <span class="sig-arg">base_url</span>=<span class="sig-default">None</span>, <span class="sig-arg">close</span>=<span class="sig-default">True</span>)</span> </h3> </td><td align="right" valign="top" > </td> </tr></table> <p>Return an open file-like object as input document.</p> <p>Pass open file and context as parameters. You can pass the base URL or filename of the file through the <tt class="rst-docutils literal">base_url</tt> keyword argument. If the <tt class="rst-docutils literal">close</tt> flag is True (the default), the file will be closed after reading.</p> <p>Note that using <tt class="rst-docutils literal">.resolve_filename()</tt> is more efficient, especially in threaded environments.</p> <dl class="fields"> </dl> </td></tr></table> </div> <a name="resolve_filename"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">resolve_filename</span>(<span class="sig-arg">self</span>, <span class="sig-arg">filename</span>, <span class="sig-arg">context</span>)</span> </h3> </td><td align="right" valign="top" > </td> </tr></table> <p>Return the name of a parsable file as input document.</p> <p>Pass filename and context as parameters. You can also pass a URL with an HTTP, FTP or file target.</p> <dl class="fields"> </dl> </td></tr></table> </div> <a name="resolve_string"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">resolve_string</span>(<span class="sig-arg">self</span>, <span class="sig-arg">string</span>, <span class="sig-arg">context</span>, <span class="sig-arg">base_url</span>=<span class="sig-default">None</span>)</span> </h3> </td><td align="right" valign="top" > </td> </tr></table> <p>Return a parsable string as input document.</p> <p>Pass data string and context as parameters. You can pass the source URL or filename through the <tt class="rst-docutils literal">base_url</tt> keyword argument.</p> <dl class="fields"> </dl> </td></tr></table> </div> <br /> <!-- ==================== NAVIGATION BAR ==================== --> <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> <tr valign="middle"> <!-- Home link --> <th> <a href="lxml-module.html">Home</a> </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 Sun Sep 9 15:24:18 2018 </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>