<!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.1. html.parser — Simple HTML and XHTML parser — Python v3.1.1 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: '3.1.1',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Python v3.1.1 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 v3.1.1 documentation" href="../index.html" />
<link rel="up" title="19. Structured Markup Processing Tools" href="markup.html" />
<link rel="next" title="19.2. html.entities — Definitions of HTML general entities" href="html.entities.html" />
<link rel="prev" title="19. Structured Markup Processing Tools" href="markup.html" />
<link rel="shortcut icon" type="image/png" href="../_static/py.png" />
</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="../modindex.html" title="Global Module Index"
accesskey="M">modules</a> |</li>
<li class="right" >
<a href="html.entities.html" title="19.2. html.entities — Definitions of HTML general entities"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="markup.html" title="19. Structured Markup Processing Tools"
accesskey="P">previous</a> |</li>
<li><img src="../_static/py.png" alt=""
style="vertical-align: middle; margin-top: -1px"/></li>
<li><a href="../index.html">Python v3.1.1 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-html.parser">
<h1>19.1. <tt class="xref docutils literal"><span class="pre">html.parser</span></tt> — Simple HTML and XHTML parser<a class="headerlink" href="#module-html.parser" title="Permalink to this headline">¶</a></h1>
<p id="index-319">This module defines a class <a title="html.parser.HTMLParser" class="reference internal" href="#html.parser.HTMLParser"><tt class="xref docutils literal"><span class="pre">HTMLParser</span></tt></a> which serves as the basis for
parsing text files formatted in HTML (HyperText Mark-up Language) and XHTML.</p>
<dl class="class">
<dt id="html.parser.HTMLParser">
<em class="property">
class </em><tt class="descclassname">html.parser.</tt><tt class="descname">HTMLParser</tt><a class="headerlink" href="#html.parser.HTMLParser" title="Permalink to this definition">¶</a></dt>
<dd><p>The <a title="html.parser.HTMLParser" class="reference internal" href="#html.parser.HTMLParser"><tt class="xref docutils literal"><span class="pre">HTMLParser</span></tt></a> class is instantiated without arguments.</p>
<p>An <a title="html.parser.HTMLParser" class="reference internal" href="#html.parser.HTMLParser"><tt class="xref docutils literal"><span class="pre">HTMLParser</span></tt></a> instance is fed HTML data and calls handler functions when tags
begin and end. The <a title="html.parser.HTMLParser" class="reference internal" href="#html.parser.HTMLParser"><tt class="xref docutils literal"><span class="pre">HTMLParser</span></tt></a> class is meant to be overridden by the
user to provide a desired behavior.</p>
<p>This parser does not check that end tags match start tags or call the end-tag
handler for elements which are closed implicitly by closing an outer element.</p>
</dd></dl>
<p>An exception is defined as well:</p>
<dl class="exception">
<dt id="html.parser.HTMLParseError">
<em class="property">
exception </em><tt class="descclassname">html.parser.</tt><tt class="descname">HTMLParseError</tt><a class="headerlink" href="#html.parser.HTMLParseError" title="Permalink to this definition">¶</a></dt>
<dd>Exception raised by the <a title="html.parser.HTMLParser" class="reference internal" href="#html.parser.HTMLParser"><tt class="xref docutils literal"><span class="pre">HTMLParser</span></tt></a> class when it encounters an error
while parsing. This exception provides three attributes: <tt class="xref docutils literal"><span class="pre">msg</span></tt> is a brief
message explaining the error, <tt class="xref docutils literal"><span class="pre">lineno</span></tt> is the number of the line on which
the broken construct was detected, and <tt class="xref docutils literal"><span class="pre">offset</span></tt> is the number of
characters into the line at which the construct starts.</dd></dl>
<p><a title="html.parser.HTMLParser" class="reference internal" href="#html.parser.HTMLParser"><tt class="xref docutils literal"><span class="pre">HTMLParser</span></tt></a> instances have the following methods:</p>
<dl class="method">
<dt id="html.parser.HTMLParser.reset">
<tt class="descclassname">HTMLParser.</tt><tt class="descname">reset</tt><big>(</big><big>)</big><a class="headerlink" href="#html.parser.HTMLParser.reset" title="Permalink to this definition">¶</a></dt>
<dd>Reset the instance. Loses all unprocessed data. This is called implicitly at
instantiation time.</dd></dl>
<dl class="method">
<dt id="html.parser.HTMLParser.feed">
<tt class="descclassname">HTMLParser.</tt><tt class="descname">feed</tt><big>(</big><em>data</em><big>)</big><a class="headerlink" href="#html.parser.HTMLParser.feed" title="Permalink to this definition">¶</a></dt>
<dd>Feed some text to the parser. It is processed insofar as it consists of
complete elements; incomplete data is buffered until more data is fed or
<a title="html.parser.HTMLParser.close" class="reference internal" href="#html.parser.HTMLParser.close"><tt class="xref docutils literal"><span class="pre">close()</span></tt></a> is called.</dd></dl>
<dl class="method">
<dt id="html.parser.HTMLParser.close">
<tt class="descclassname">HTMLParser.</tt><tt class="descname">close</tt><big>(</big><big>)</big><a class="headerlink" href="#html.parser.HTMLParser.close" title="Permalink to this definition">¶</a></dt>
<dd>Force processing of all buffered data as if it were followed by an end-of-file
mark. This method may be redefined by a derived class to define additional
processing at the end of the input, but the redefined version should always call
the <a title="html.parser.HTMLParser" class="reference internal" href="#html.parser.HTMLParser"><tt class="xref docutils literal"><span class="pre">HTMLParser</span></tt></a> base class method <a title="html.parser.HTMLParser.close" class="reference internal" href="#html.parser.HTMLParser.close"><tt class="xref docutils literal"><span class="pre">close()</span></tt></a>.</dd></dl>
<dl class="method">
<dt id="html.parser.HTMLParser.getpos">
<tt class="descclassname">HTMLParser.</tt><tt class="descname">getpos</tt><big>(</big><big>)</big><a class="headerlink" href="#html.parser.HTMLParser.getpos" title="Permalink to this definition">¶</a></dt>
<dd>Return current line number and offset.</dd></dl>
<dl class="method">
<dt id="html.parser.HTMLParser.get_starttag_text">
<tt class="descclassname">HTMLParser.</tt><tt class="descname">get_starttag_text</tt><big>(</big><big>)</big><a class="headerlink" href="#html.parser.HTMLParser.get_starttag_text" title="Permalink to this definition">¶</a></dt>
<dd>Return the text of the most recently opened start tag. This should not normally
be needed for structured processing, but may be useful in dealing with HTML “as
deployed” or for re-generating input with minimal changes (whitespace between
attributes can be preserved, etc.).</dd></dl>
<dl class="method">
<dt id="html.parser.HTMLParser.handle_starttag">
<tt class="descclassname">HTMLParser.</tt><tt class="descname">handle_starttag</tt><big>(</big><em>tag</em>, <em>attrs</em><big>)</big><a class="headerlink" href="#html.parser.HTMLParser.handle_starttag" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is called to handle the start of a tag. It is intended to be
overridden by a derived class; the base class implementation does nothing.</p>
<p>The <em>tag</em> argument is the name of the tag converted to lower case. The <em>attrs</em>
argument is a list of <tt class="docutils literal"><span class="pre">(name,</span> <span class="pre">value)</span></tt> pairs containing the attributes found
inside the tag’s <tt class="docutils literal"><span class="pre"><></span></tt> brackets. The <em>name</em> will be translated to lower case,
and quotes in the <em>value</em> have been removed, and character and entity references
have been replaced. For instance, for the tag <tt class="docutils literal"><span class="pre"><A</span>
<span class="pre">HREF="http://www.cwi.nl/"></span></tt>, this method would be called as
<tt class="docutils literal"><span class="pre">handle_starttag('a',</span> <span class="pre">[('href',</span> <span class="pre">'http://www.cwi.nl/')])</span></tt>.</p>
<p>All entity references from <a title="Definitions of HTML general entities." class="reference external" href="html.entities.html#module-html.entities"><tt class="xref docutils literal"><span class="pre">html.entities</span></tt></a> are replaced in the attribute
values.</p>
</dd></dl>
<dl class="method">
<dt id="html.parser.HTMLParser.handle_startendtag">
<tt class="descclassname">HTMLParser.</tt><tt class="descname">handle_startendtag</tt><big>(</big><em>tag</em>, <em>attrs</em><big>)</big><a class="headerlink" href="#html.parser.HTMLParser.handle_startendtag" title="Permalink to this definition">¶</a></dt>
<dd>Similar to <a title="html.parser.HTMLParser.handle_starttag" class="reference internal" href="#html.parser.HTMLParser.handle_starttag"><tt class="xref docutils literal"><span class="pre">handle_starttag()</span></tt></a>, but called when the parser encounters an
XHTML-style empty tag (<tt class="docutils literal"><span class="pre"><a</span> <span class="pre">.../></span></tt>). This method may be overridden by
subclasses which require this particular lexical information; the default
implementation simple calls <a title="html.parser.HTMLParser.handle_starttag" class="reference internal" href="#html.parser.HTMLParser.handle_starttag"><tt class="xref docutils literal"><span class="pre">handle_starttag()</span></tt></a> and <a title="html.parser.HTMLParser.handle_endtag" class="reference internal" href="#html.parser.HTMLParser.handle_endtag"><tt class="xref docutils literal"><span class="pre">handle_endtag()</span></tt></a>.</dd></dl>
<dl class="method">
<dt id="html.parser.HTMLParser.handle_endtag">
<tt class="descclassname">HTMLParser.</tt><tt class="descname">handle_endtag</tt><big>(</big><em>tag</em><big>)</big><a class="headerlink" href="#html.parser.HTMLParser.handle_endtag" title="Permalink to this definition">¶</a></dt>
<dd>This method is called to handle the end tag of an element. It is intended to be
overridden by a derived class; the base class implementation does nothing. The
<em>tag</em> argument is the name of the tag converted to lower case.</dd></dl>
<dl class="method">
<dt id="html.parser.HTMLParser.handle_data">
<tt class="descclassname">HTMLParser.</tt><tt class="descname">handle_data</tt><big>(</big><em>data</em><big>)</big><a class="headerlink" href="#html.parser.HTMLParser.handle_data" title="Permalink to this definition">¶</a></dt>
<dd>This method is called to process arbitrary data. It is intended to be
overridden by a derived class; the base class implementation does nothing.</dd></dl>
<dl class="method">
<dt id="html.parser.HTMLParser.handle_charref">
<tt class="descclassname">HTMLParser.</tt><tt class="descname">handle_charref</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#html.parser.HTMLParser.handle_charref" title="Permalink to this definition">¶</a></dt>
<dd>This method is called to process a character reference of the form <tt class="docutils literal"><span class="pre">&#ref;</span></tt>.
It is intended to be overridden by a derived class; the base class
implementation does nothing.</dd></dl>
<dl class="method">
<dt id="html.parser.HTMLParser.handle_entityref">
<tt class="descclassname">HTMLParser.</tt><tt class="descname">handle_entityref</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#html.parser.HTMLParser.handle_entityref" title="Permalink to this definition">¶</a></dt>
<dd>This method is called to process a general entity reference of the form
<tt class="docutils literal"><span class="pre">&name;</span></tt> where <em>name</em> is an general entity reference. It is intended to be
overridden by a derived class; the base class implementation does nothing.</dd></dl>
<dl class="method">
<dt id="html.parser.HTMLParser.handle_comment">
<tt class="descclassname">HTMLParser.</tt><tt class="descname">handle_comment</tt><big>(</big><em>data</em><big>)</big><a class="headerlink" href="#html.parser.HTMLParser.handle_comment" title="Permalink to this definition">¶</a></dt>
<dd>This method is called when a comment is encountered. The <em>comment</em> argument is
a string containing the text between the <tt class="docutils literal"><span class="pre">--</span></tt> and <tt class="docutils literal"><span class="pre">--</span></tt> delimiters, but not
the delimiters themselves. For example, the comment <tt class="docutils literal"><span class="pre"><!--text--></span></tt> will cause
this method to be called with the argument <tt class="docutils literal"><span class="pre">'text'</span></tt>. It is intended to be
overridden by a derived class; the base class implementation does nothing.</dd></dl>
<dl class="method">
<dt id="html.parser.HTMLParser.handle_decl">
<tt class="descclassname">HTMLParser.</tt><tt class="descname">handle_decl</tt><big>(</big><em>decl</em><big>)</big><a class="headerlink" href="#html.parser.HTMLParser.handle_decl" title="Permalink to this definition">¶</a></dt>
<dd>Method called when an SGML declaration is read by the parser. The <em>decl</em>
parameter will be the entire contents of the declaration inside the <tt class="docutils literal"><span class="pre"><!</span></tt>...<tt class="docutils literal"><span class="pre">></span></tt> markup. It is intended to be overridden by a derived class; the base
class implementation does nothing.</dd></dl>
<dl class="method">
<dt id="html.parser.HTMLParser.handle_pi">
<tt class="descclassname">HTMLParser.</tt><tt class="descname">handle_pi</tt><big>(</big><em>data</em><big>)</big><a class="headerlink" href="#html.parser.HTMLParser.handle_pi" title="Permalink to this definition">¶</a></dt>
<dd><p>Method called when a processing instruction is encountered. The <em>data</em>
parameter will contain the entire processing instruction. For example, for the
processing instruction <tt class="docutils literal"><span class="pre"><?proc</span> <span class="pre">color='red'></span></tt>, this method would be called as
<tt class="docutils literal"><span class="pre">handle_pi("proc</span> <span class="pre">color='red'")</span></tt>. It is intended to be overridden by a derived
class; the base class implementation does nothing.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The <a title="html.parser.HTMLParser" class="reference internal" href="#html.parser.HTMLParser"><tt class="xref docutils literal"><span class="pre">HTMLParser</span></tt></a> class uses the SGML syntactic rules for processing
instructions. An XHTML processing instruction using the trailing <tt class="docutils literal"><span class="pre">'?'</span></tt> will
cause the <tt class="docutils literal"><span class="pre">'?'</span></tt> to be included in <em>data</em>.</p>
</div>
</dd></dl>
<div class="section" id="example-html-parser-application">
<span id="htmlparser-example"></span><h2>19.1.1. Example HTML Parser Application<a class="headerlink" href="#example-html-parser-application" title="Permalink to this headline">¶</a></h2>
<p>As a basic example, below is a very basic HTML parser that uses the
<a title="html.parser.HTMLParser" class="reference internal" href="#html.parser.HTMLParser"><tt class="xref docutils literal"><span class="pre">HTMLParser</span></tt></a> class to print out tags as they are encountered:</p>
<div class="highlight-python3"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">html.parser</span> <span class="kn">import</span> <span class="n">HTMLParser</span>
<span class="go">>>></span>
<span class="gp">>>> </span><span class="k">class</span> <span class="nc">MyHTMLParser</span><span class="p">(</span><span class="n">HTMLParser</span><span class="p">):</span>
<span class="gp">... </span> <span class="k">def</span> <span class="nf">handle_starttag</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">tag</span><span class="p">,</span> <span class="n">attrs</span><span class="p">):</span>
<span class="gp">... </span> <span class="k">print</span><span class="p">(</span><span class="s">"Encountered a {} start tag"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">tag</span><span class="p">))</span>
<span class="gp">... </span> <span class="k">def</span> <span class="nf">handle_endtag</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">tag</span><span class="p">):</span>
<span class="gp">... </span> <span class="k">print</span><span class="p">(</span><span class="s">"Encountered a {} end tag"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">tag</span><span class="p">))</span>
<span class="gp">...</span>
<span class="gp">>>> </span><span class="n">page</span> <span class="o">=</span> <span class="s">"""<html><h1>Title</h1><p>I'm a paragraph!</p></html>"""</span>
<span class="go">>>></span>
<span class="gp">>>> </span><span class="n">myparser</span> <span class="o">=</span> <span class="n">MyHTMLParser</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">myparser</span><span class="o">.</span><span class="n">feed</span><span class="p">(</span><span class="n">page</span><span class="p">)</span>
<span class="go">Encountered a html start tag</span>
<span class="go">Encountered a h1 start tag</span>
<span class="go">Encountered a h1 end tag</span>
<span class="go">Encountered a p start tag</span>
<span class="go">Encountered a p end tag</span>
<span class="go">Encountered a html end tag</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference external" href="">19.1. <tt class="docutils literal"><span class="pre">html.parser</span></tt> — Simple HTML and XHTML parser</a><ul>
<li><a class="reference external" href="#example-html-parser-application">19.1.1. Example HTML Parser Application</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="markup.html"
title="previous chapter">19. Structured Markup Processing Tools</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="html.entities.html"
title="next chapter">19.2. <tt class="docutils literal docutils literal"><span class="pre">html.entities</span></tt> — Definitions of HTML general entities</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/library/html.parser.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" size="18" />
<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="../modindex.html" title="Global Module Index"
>modules</a> |</li>
<li class="right" >
<a href="html.entities.html" title="19.2. html.entities — Definitions of HTML general entities"
>next</a> |</li>
<li class="right" >
<a href="markup.html" title="19. Structured Markup Processing Tools"
>previous</a> |</li>
<li><img src="../_static/py.png" alt=""
style="vertical-align: middle; margin-top: -1px"/></li>
<li><a href="../index.html">Python v3.1.1 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-2009, 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 Aug 16, 2009.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.2.
</div>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
e870e6598e1c7e3918555a3d0ba5f3d4
>
files
>
653
