Edit File: xml.sax.utils.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>19.13. xml.sax.saxutils — SAX Utilities — Python 2.7.5 documentation</title> <link rel="stylesheet" href="../_static/default.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '../', VERSION: '2.7.5', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true }; </script> <script type="text/javascript" src="../_static/jquery.js"></script> <script type="text/javascript" src="../_static/underscore.js"></script> <script type="text/javascript" src="../_static/doctools.js"></script> <script type="text/javascript" src="../_static/sidebar.js"></script> <link rel="search" type="application/opensearchdescription+xml" title="Search within Python 2.7.5 documentation" href="../_static/opensearch.xml"/> <link rel="author" title="About these documents" href="../about.html" /> <link rel="copyright" title="Copyright" href="../copyright.html" /> <link rel="top" title="Python 2.7.5 documentation" href="../index.html" /> <link rel="up" title="19. Structured Markup Processing Tools" href="markup.html" /> <link rel="next" title="19.14. xml.sax.xmlreader — Interface for XML parsers" href="xml.sax.reader.html" /> <link rel="prev" title="19.12. xml.sax.handler — Base classes for SAX handlers" href="xml.sax.handler.html" /> <link rel="shortcut icon" type="image/png" href="../_static/py.png" /> <script type="text/javascript" src="../_static/copybutton.js"></script> </head> <body> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="xml.sax.reader.html" title="19.14. xml.sax.xmlreader — Interface for XML parsers" accesskey="N">next</a> |</li> <li class="right" > <a href="xml.sax.handler.html" title="19.12. xml.sax.handler — Base classes for SAX handlers" accesskey="P">previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="http://www.python.org/">Python</a> »</li> <li> <a href="../index.html">Python 2.7.5 documentation</a> » </li> <li><a href="index.html" >The Python Standard Library</a> »</li> <li><a href="markup.html" accesskey="U">19. Structured Markup Processing Tools</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="module-xml.sax.saxutils"> <span id="xml-sax-saxutils-sax-utilities"></span><h1>19.13. <a class="reference internal" href="#module-xml.sax.saxutils" title="xml.sax.saxutils: Convenience functions and classes for use with SAX."><tt class="xref py py-mod docutils literal"><span class="pre">xml.sax.saxutils</span></tt></a> — SAX Utilities<a class="headerlink" href="#module-xml.sax.saxutils" title="Permalink to this headline">¶</a></h1> <p class="versionadded"> <span class="versionmodified">New in version 2.0.</span></p> <p>The module <a class="reference internal" href="#module-xml.sax.saxutils" title="xml.sax.saxutils: Convenience functions and classes for use with SAX."><tt class="xref py py-mod docutils literal"><span class="pre">xml.sax.saxutils</span></tt></a> contains a number of classes and functions that are commonly useful when creating SAX applications, either in direct use, or as base classes.</p> <dl class="function"> <dt id="xml.sax.saxutils.escape"> <tt class="descclassname">xml.sax.saxutils.</tt><tt class="descname">escape</tt><big>(</big><em>data</em><span class="optional">[</span>, <em>entities</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#xml.sax.saxutils.escape" title="Permalink to this definition">¶</a></dt> <dd><p>Escape <tt class="docutils literal"><span class="pre">'&'</span></tt>, <tt class="docutils literal"><span class="pre">'<'</span></tt>, and <tt class="docutils literal"><span class="pre">'>'</span></tt> in a string of data.</p> <p>You can escape other strings of data by passing a dictionary as the optional <em>entities</em> parameter. The keys and values must all be strings; each key will be replaced with its corresponding value. The characters <tt class="docutils literal"><span class="pre">'&'</span></tt>, <tt class="docutils literal"><span class="pre">'<'</span></tt> and <tt class="docutils literal"><span class="pre">'>'</span></tt> are always escaped, even if <em>entities</em> is provided.</p> </dd></dl> <dl class="function"> <dt id="xml.sax.saxutils.unescape"> <tt class="descclassname">xml.sax.saxutils.</tt><tt class="descname">unescape</tt><big>(</big><em>data</em><span class="optional">[</span>, <em>entities</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#xml.sax.saxutils.unescape" title="Permalink to this definition">¶</a></dt> <dd><p>Unescape <tt class="docutils literal"><span class="pre">'&amp;'</span></tt>, <tt class="docutils literal"><span class="pre">'&lt;'</span></tt>, and <tt class="docutils literal"><span class="pre">'&gt;'</span></tt> in a string of data.</p> <p>You can unescape other strings of data by passing a dictionary as the optional <em>entities</em> parameter. The keys and values must all be strings; each key will be replaced with its corresponding value. <tt class="docutils literal"><span class="pre">'&amp'</span></tt>, <tt class="docutils literal"><span class="pre">'&lt;'</span></tt>, and <tt class="docutils literal"><span class="pre">'&gt;'</span></tt> are always unescaped, even if <em>entities</em> is provided.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.3.</span></p> </dd></dl> <dl class="function"> <dt id="xml.sax.saxutils.quoteattr"> <tt class="descclassname">xml.sax.saxutils.</tt><tt class="descname">quoteattr</tt><big>(</big><em>data</em><span class="optional">[</span>, <em>entities</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#xml.sax.saxutils.quoteattr" title="Permalink to this definition">¶</a></dt> <dd><p>Similar to <a class="reference internal" href="#xml.sax.saxutils.escape" title="xml.sax.saxutils.escape"><tt class="xref py py-func docutils literal"><span class="pre">escape()</span></tt></a>, but also prepares <em>data</em> to be used as an attribute value. The return value is a quoted version of <em>data</em> with any additional required replacements. <a class="reference internal" href="#xml.sax.saxutils.quoteattr" title="xml.sax.saxutils.quoteattr"><tt class="xref py py-func docutils literal"><span class="pre">quoteattr()</span></tt></a> will select a quote character based on the content of <em>data</em>, attempting to avoid encoding any quote characters in the string. If both single- and double-quote characters are already in <em>data</em>, the double-quote characters will be encoded and <em>data</em> will be wrapped in double-quotes. The resulting string can be used directly as an attribute value:</p> <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="k">print</span> <span class="s">"<element attr=</span><span class="si">%s</span><span class="s">>"</span> <span class="o">%</span> <span class="n">quoteattr</span><span class="p">(</span><span class="s">"ab ' cd </span><span class="se">\"</span><span class="s"> ef"</span><span class="p">)</span> <span class="go"><element attr="ab ' cd &quot; ef"></span> </pre></div> </div> <p>This function is useful when generating attribute values for HTML or any SGML using the reference concrete syntax.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.2.</span></p> </dd></dl> <dl class="class"> <dt id="xml.sax.saxutils.XMLGenerator"> <em class="property">class </em><tt class="descclassname">xml.sax.saxutils.</tt><tt class="descname">XMLGenerator</tt><big>(</big><span class="optional">[</span><em>out</em><span class="optional">[</span>, <em>encoding</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#xml.sax.saxutils.XMLGenerator" title="Permalink to this definition">¶</a></dt> <dd><p>This class implements the <tt class="xref py py-class docutils literal"><span class="pre">ContentHandler</span></tt> interface by writing SAX events back into an XML document. In other words, using an <a class="reference internal" href="#xml.sax.saxutils.XMLGenerator" title="xml.sax.saxutils.XMLGenerator"><tt class="xref py py-class docutils literal"><span class="pre">XMLGenerator</span></tt></a> as the content handler will reproduce the original document being parsed. <em>out</em> should be a file-like object which will default to <em>sys.stdout</em>. <em>encoding</em> is the encoding of the output stream which defaults to <tt class="docutils literal"><span class="pre">'iso-8859-1'</span></tt>.</p> </dd></dl> <dl class="class"> <dt id="xml.sax.saxutils.XMLFilterBase"> <em class="property">class </em><tt class="descclassname">xml.sax.saxutils.</tt><tt class="descname">XMLFilterBase</tt><big>(</big><em>base</em><big>)</big><a class="headerlink" href="#xml.sax.saxutils.XMLFilterBase" title="Permalink to this definition">¶</a></dt> <dd><p>This class is designed to sit between an <tt class="xref py py-class docutils literal"><span class="pre">XMLReader</span></tt> and the client application’s event handlers. By default, it does nothing but pass requests up to the reader and events on to the handlers unmodified, but subclasses can override specific methods to modify the event stream or the configuration requests as they pass through.</p> </dd></dl> <dl class="function"> <dt id="xml.sax.saxutils.prepare_input_source"> <tt class="descclassname">xml.sax.saxutils.</tt><tt class="descname">prepare_input_source</tt><big>(</big><em>source</em><span class="optional">[</span>, <em>base</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#xml.sax.saxutils.prepare_input_source" title="Permalink to this definition">¶</a></dt> <dd><p>This function takes an input source and an optional base URL and returns a fully resolved <tt class="xref py py-class docutils literal"><span class="pre">InputSource</span></tt> object ready for reading. The input source can be given as a string, a file-like object, or an <tt class="xref py py-class docutils literal"><span class="pre">InputSource</span></tt> object; parsers will use this function to implement the polymorphic <em>source</em> argument to their <tt class="xref py py-meth docutils literal"><span class="pre">parse()</span></tt> method.</p> </dd></dl> </div> </div> </div> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <h4>Previous topic</h4> <p class="topless"><a href="xml.sax.handler.html" title="previous chapter">19.12. <tt class="docutils literal"><span class="pre">xml.sax.handler</span></tt> — Base classes for SAX handlers</a></p> <h4>Next topic</h4> <p class="topless"><a href="xml.sax.reader.html" title="next chapter">19.14. <tt class="docutils literal"><span class="pre">xml.sax.xmlreader</span></tt> — Interface for XML parsers</a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../bugs.html">Report a Bug</a></li> <li><a href="../_sources/library/xml.sax.utils.txt" rel="nofollow">Show Source</a></li> </ul> <div id="searchbox" style="display: none"> <h3>Quick search</h3> <form class="search" action="../search.html" method="get"> <input type="text" name="q" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> <p class="searchtip" style="font-size: 90%"> Enter search terms or a module, class or function name. </p> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="clearer"></div> </div> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="xml.sax.reader.html" title="19.14. xml.sax.xmlreader — Interface for XML parsers" >next</a> |</li> <li class="right" > <a href="xml.sax.handler.html" title="19.12. xml.sax.handler — Base classes for SAX handlers" >previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="http://www.python.org/">Python</a> »</li> <li> <a href="../index.html">Python 2.7.5 documentation</a> » </li> <li><a href="index.html" >The Python Standard Library</a> »</li> <li><a href="markup.html" >19. Structured Markup Processing Tools</a> »</li> </ul> </div> <div class="footer"> © <a href="../copyright.html">Copyright</a> 1990-2020, Python Software Foundation. <br /> The Python Software Foundation is a non-profit corporation. <a href="http://www.python.org/psf/donations/">Please donate.</a> <br /> Last updated on Oct 13, 2020. <a href="../bugs.html">Found a bug</a>? <br /> Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. </div> </body> </html>