<?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.html</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="http://codespeak.net/lxml/">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> ::
Package html
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="lxml.html-module.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== PACKAGE DESCRIPTION ==================== -->
<h1 class="epydoc">Package html</h1><p class="nomargin-top"><span class="codelink"><a href="lxml.html-pysrc.html">source code</a></span></p>
The <tt class="rst-rst-rst-docutils literal rst-rst-docutils literal rst-docutils literal"><span class="pre">lxml.html</span></tt> tool set for HTML handling.
<!-- ==================== SUBMODULES ==================== -->
<a name="section-Submodules"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Submodules</span></td>
</tr>
<tr><td class="summary">
<ul class="nomargin">
<li> <strong class="uidlink"><a href="lxml.html.ElementSoup-module.html">lxml.html.ElementSoup</a></strong>: <em class="summary">Legacy interface to the BeautifulSoup HTML parser.</em> </li>
<li class="private"> <strong class="uidlink">lxml.html._dictmixin</strong> </li>
<li class="private"> <strong class="uidlink">lxml.html._setmixin</strong> </li>
<li> <strong class="uidlink"><a href="lxml.html.builder-module.html">lxml.html.builder</a></strong>: <em class="summary">A set of HTML generator tags for building HTML documents.</em> </li>
<li> <strong class="uidlink"><a href="lxml.html.clean-module.html">lxml.html.clean</a></strong>: <em class="summary">A cleanup tool for HTML.</em> </li>
<li> <strong class="uidlink"><a href="lxml.html.defs-module.html">lxml.html.defs</a></strong> </li>
<li> <strong class="uidlink"><a href="lxml.html.diff-module.html">lxml.html.diff</a></strong> </li>
<li> <strong class="uidlink"><a href="lxml.html.formfill-module.html">lxml.html.formfill</a></strong> </li>
<li> <strong class="uidlink"><a href="lxml.html.soupparser-module.html">lxml.html.soupparser</a></strong>: <em class="summary">External interface to the BeautifulSoup HTML parser.</em> </li>
<li> <strong class="uidlink"><a href="lxml.html.usedoctest-module.html">lxml.html.usedoctest</a></strong>: <em class="summary">Doctest module for HTML comparison.</em> </li>
</ul></td></tr>
</table>
<br />
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Functions</span></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 name="document_fromstring"></a><span class="summary-sig-name">document_fromstring</span>(<span class="summary-sig-arg">html</span>,
<span class="summary-sig-arg">**kw</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="lxml.html-pysrc.html#document_fromstring">source code</a></span>
</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.html-module.html#fragments_fromstring" class="summary-sig-name">fragments_fromstring</a>(<span class="summary-sig-arg">html</span>,
<span class="summary-sig-arg">no_leading_text</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">base_url</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">**kw</span>)</span><br />
Parses several HTML elements, returning a list of elements.</td>
<td align="right" valign="top">
<span class="codelink"><a href="lxml.html-pysrc.html#fragments_fromstring">source code</a></span>
</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.html-module.html#fragment_fromstring" class="summary-sig-name">fragment_fromstring</a>(<span class="summary-sig-arg">html</span>,
<span class="summary-sig-arg">create_parent</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">base_url</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">**kw</span>)</span><br />
Parses a single HTML element; it is an error if there is more than
one element, or if anything but whitespace precedes or follows the
element.</td>
<td align="right" valign="top">
<span class="codelink"><a href="lxml.html-pysrc.html#fragment_fromstring">source code</a></span>
</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.html-module.html#fromstring" class="summary-sig-name">fromstring</a>(<span class="summary-sig-arg">html</span>,
<span class="summary-sig-arg">base_url</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">**kw</span>)</span><br />
Parse the html, returning a single element/document.</td>
<td align="right" valign="top">
<span class="codelink"><a href="lxml.html-pysrc.html#fromstring">source code</a></span>
</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.html-module.html#submit_form" class="summary-sig-name">submit_form</a>(<span class="summary-sig-arg">form</span>,
<span class="summary-sig-arg">extra_values</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">open_http</span>=<span class="summary-sig-default">None</span>)</span><br />
Helper function to submit a form.</td>
<td align="right" valign="top">
<span class="codelink"><a href="lxml.html-pysrc.html#submit_form">source code</a></span>
</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.html-module.html#tostring" class="summary-sig-name">tostring</a>(<span class="summary-sig-arg">doc</span>,
<span class="summary-sig-arg">pretty_print</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">include_meta_content_type</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">encoding</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">method</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">html</code><code class="variable-quote">'</code></span>)</span><br />
Return an HTML string representation of the document.</td>
<td align="right" valign="top">
<span class="codelink"><a href="lxml.html-pysrc.html#tostring">source code</a></span>
</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 name="open_in_browser"></a><span class="summary-sig-name">open_in_browser</span>(<span class="summary-sig-arg">doc</span>)</span><br />
Open the HTML document in a web browser (saving it to a temporary
file to open it).</td>
<td align="right" valign="top">
<span class="codelink"><a href="lxml.html-pysrc.html#open_in_browser">source code</a></span>
</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 name="Element"></a><span class="summary-sig-name">Element</span>(<span class="summary-sig-arg">*args</span>,
<span class="summary-sig-arg">**kw</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="lxml.html-pysrc.html#Element">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Variables</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="find_rel_links"></a><span class="summary-name">find_rel_links</span> = <code title="_MethodFunc('find_rel_links', copy= False)">_MethodFunc('find_rel_links', copy= False)</code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="find_class"></a><span class="summary-name">find_class</span> = <code title="_MethodFunc('find_class', copy= False)">_MethodFunc('find_class', copy= False)</code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="lxml.html-module.html#make_links_absolute" class="summary-name">make_links_absolute</a> = <code title="_MethodFunc('make_links_absolute', copy= True)">_MethodFunc('make_links_absolute', copy=<code class="variable-ellipsis">...</code></code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="resolve_base_href"></a><span class="summary-name">resolve_base_href</span> = <code title="_MethodFunc('resolve_base_href', copy= True)">_MethodFunc('resolve_base_href', copy= True)</code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="iterlinks"></a><span class="summary-name">iterlinks</span> = <code title="_MethodFunc('iterlinks', copy= False)">_MethodFunc('iterlinks', copy= False)</code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="rewrite_links"></a><span class="summary-name">rewrite_links</span> = <code title="_MethodFunc('rewrite_links', copy= True)">_MethodFunc('rewrite_links', copy= True)</code>
</td>
</tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Function Details</span></td>
</tr>
</table>
<a name="fragments_fromstring"></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">fragments_fromstring</span>(<span class="sig-arg">html</span>,
<span class="sig-arg">no_leading_text</span>=<span class="sig-default">False</span>,
<span class="sig-arg">base_url</span>=<span class="sig-default">None</span>,
<span class="sig-arg">**kw</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="lxml.html-pysrc.html#fragments_fromstring">source code</a></span>
</td>
</tr></table>
<p>Parses several HTML elements, returning a list of elements.</p>
<p>The first item in the list may be a string (though leading
whitespace is removed). If no_leading_text is true, then it will
be an error if there is leading text, and it will always be a list
of only elements.</p>
<p>base_url will set the document's base_url attribute (and the tree's docinfo.URL)</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="fragment_fromstring"></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">fragment_fromstring</span>(<span class="sig-arg">html</span>,
<span class="sig-arg">create_parent</span>=<span class="sig-default">False</span>,
<span class="sig-arg">base_url</span>=<span class="sig-default">None</span>,
<span class="sig-arg">**kw</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="lxml.html-pysrc.html#fragment_fromstring">source code</a></span>
</td>
</tr></table>
<p>Parses a single HTML element; it is an error if there is more than
one element, or if anything but whitespace precedes or follows the
element.</p>
<p>If create_parent is true (or is a tag name) then a parent node
will be created to encapsulate the HTML in a single element.</p>
<p>base_url will set the document's base_url attribute (and the tree's docinfo.URL)</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="fromstring"></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">fromstring</span>(<span class="sig-arg">html</span>,
<span class="sig-arg">base_url</span>=<span class="sig-default">None</span>,
<span class="sig-arg">**kw</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="lxml.html-pysrc.html#fromstring">source code</a></span>
</td>
</tr></table>
<p>Parse the html, returning a single element/document.</p>
<p>This tries to minimally parse the chunk of text, without knowing if it
is a fragment or a document.</p>
<p>base_url will set the document's base_url attribute (and the tree's docinfo.URL)</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="submit_form"></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">submit_form</span>(<span class="sig-arg">form</span>,
<span class="sig-arg">extra_values</span>=<span class="sig-default">None</span>,
<span class="sig-arg">open_http</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="lxml.html-pysrc.html#submit_form">source code</a></span>
</td>
</tr></table>
<p>Helper function to submit a form. Returns a file-like object, as from
<tt class="rst-docutils literal"><span class="pre">urllib.urlopen()</span></tt>. This object also has a <tt class="rst-docutils literal"><span class="pre">.geturl()</span></tt> function,
which shows the URL if there were any redirects.</p>
<p>You can use this like:</p>
<pre class="rst-literal-block">
form = doc.forms[0]
form.inputs['foo'].value = 'bar' # etc
response = form.submit()
doc = parse(response)
doc.make_links_absolute(response.geturl())
</pre>
<p>To change the HTTP requester, pass a function as <tt class="rst-docutils literal"><span class="pre">open_http</span></tt> keyword
argument that opens the URL for you. The function must have the following
signature:</p>
<pre class="rst-literal-block">
open_http(method, URL, values)
</pre>
<p>The action is one of 'GET' or 'POST', the URL is the target URL as a
string, and the values are a sequence of <tt class="rst-docutils literal"><span class="pre">(name,</span> <span class="pre">value)</span></tt> tuples with the
form data.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="tostring"></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">tostring</span>(<span class="sig-arg">doc</span>,
<span class="sig-arg">pretty_print</span>=<span class="sig-default">False</span>,
<span class="sig-arg">include_meta_content_type</span>=<span class="sig-default">False</span>,
<span class="sig-arg">encoding</span>=<span class="sig-default">None</span>,
<span class="sig-arg">method</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">html</code><code class="variable-quote">'</code></span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="lxml.html-pysrc.html#tostring">source code</a></span>
</td>
</tr></table>
<p>Return an HTML string representation of the document.</p>
<p>Note: if include_meta_content_type is true this will create a
<tt class="rst-docutils literal"><span class="pre"><meta</span> <span class="pre">http-equiv="Content-Type"</span> <span class="pre">...></span></tt> tag in the head;
regardless of the value of include_meta_content_type any existing
<tt class="rst-docutils literal"><span class="pre"><meta</span> <span class="pre">http-equiv="Content-Type"</span> <span class="pre">...></span></tt> tag will be removed</p>
<p>The <tt class="rst-docutils literal"><span class="pre">encoding</span></tt> argument controls the output encoding (defauts to
ASCII, with &#...; character references for any characters outside
of ASCII).</p>
<p>The <tt class="rst-docutils literal"><span class="pre">method</span></tt> argument defines the output method. It defaults to
'html', but can also be 'xml' for xhtml output, or 'text' to
serialise to plain text without markup. Note that you can pass
the builtin <tt class="rst-docutils literal"><span class="pre">unicode</span></tt> type as <tt class="rst-docutils literal"><span class="pre">encoding</span></tt> argument to serialise
to a unicode string.</p>
<p>Example:</p>
<pre class="rst-literal-block">
>>> from lxml import html
>>> root = html.fragment_fromstring('<p>Hello<br>world!</p>')
>>> html.tostring(root)
'<p>Hello<br>world!</p>'
>>> html.tostring(root, method='html')
'<p>Hello<br>world!</p>'
>>> html.tostring(root, method='xml')
'<p>Hello<br/>world!</p>'
>>> html.tostring(root, method='text')
'Helloworld!'
>>> html.tostring(root, method='text', encoding=unicode)
u'Helloworld!'
</pre>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== VARIABLES DETAILS ==================== -->
<a name="section-VariablesDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Variables Details</span></td>
</tr>
</table>
<a name="make_links_absolute"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">make_links_absolute</h3>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
_MethodFunc('make_links_absolute', copy= True)
</pre></td></tr></table>
</dd>
</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="http://codespeak.net/lxml/">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 on Fri Dec 12 22:40:29 2008
</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>
