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.html.formfill</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.html-module.html">Package html</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.html.formfill-module.html"
58 target="_top">no frames</a>]</span></td></tr>
63 <!-- ==================== MODULE DESCRIPTION ==================== -->
64 <h1 class="epydoc">Module formfill</h1><p class="nomargin-top"><span class="codelink"><a href="lxml.html.formfill-pysrc.html">source code</a></span></p>
65 <!-- ==================== CLASSES ==================== -->
66 <a name="section-Classes"></a>
67 <table class="summary" border="1" cellpadding="3"
68 cellspacing="0" width="100%" bgcolor="white">
69 <tr bgcolor="#70b0f0" class="table-header">
70 <td colspan="2" class="table-header">
71 <table border="0" cellpadding="0" cellspacing="0" width="100%">
73 <td align="left"><span class="table-header">Classes</span></td>
74 <td align="right" valign="top"
75 ><span class="options">[<a href="#section-Classes"
76 class="privatelink" onclick="toggle_private();"
77 >hide private</a>]</span></td>
83 <td width="15%" align="right" valign="top" class="summary">
84 <span class="summary-type"> </span>
85 </td><td class="summary">
86 <a href="lxml.html.formfill.FormNotFound-class.html" class="summary-name">FormNotFound</a><br />
87 Raised when no form can be found
91 <td width="15%" align="right" valign="top" class="summary">
92 <span class="summary-type"> </span>
93 </td><td class="summary">
94 <a href="lxml.html.formfill.DefaultErrorCreator-class.html" class="summary-name">DefaultErrorCreator</a>
98 <!-- ==================== FUNCTIONS ==================== -->
99 <a name="section-Functions"></a>
100 <table class="summary" border="1" cellpadding="3"
101 cellspacing="0" width="100%" bgcolor="white">
102 <tr bgcolor="#70b0f0" class="table-header">
103 <td colspan="2" class="table-header">
104 <table border="0" cellpadding="0" cellspacing="0" width="100%">
106 <td align="left"><span class="table-header">Functions</span></td>
107 <td align="right" valign="top"
108 ><span class="options">[<a href="#section-Functions"
109 class="privatelink" onclick="toggle_private();"
110 >hide private</a>]</span></td>
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 name="fill_form"></a><span class="summary-sig-name">fill_form</span>(<span class="summary-sig-arg">el</span>,
122 <span class="summary-sig-arg">values</span>,
123 <span class="summary-sig-arg">form_id</span>=<span class="summary-sig-default">None</span>,
124 <span class="summary-sig-arg">form_index</span>=<span class="summary-sig-default">None</span>)</span></td>
125 <td align="right" valign="top">
126 <span class="codelink"><a href="lxml.html.formfill-pysrc.html#fill_form">source code</a></span>
135 <td width="15%" align="right" valign="top" class="summary">
136 <span class="summary-type"> </span>
137 </td><td class="summary">
138 <table width="100%" cellpadding="0" cellspacing="0" border="0">
140 <td><span class="summary-sig"><a name="fill_form_html"></a><span class="summary-sig-name">fill_form_html</span>(<span class="summary-sig-arg">html</span>,
141 <span class="summary-sig-arg">values</span>,
142 <span class="summary-sig-arg">form_id</span>=<span class="summary-sig-default">None</span>,
143 <span class="summary-sig-arg">form_index</span>=<span class="summary-sig-default">None</span>)</span></td>
144 <td align="right" valign="top">
145 <span class="codelink"><a href="lxml.html.formfill-pysrc.html#fill_form_html">source code</a></span>
154 <td width="15%" align="right" valign="top" class="summary">
155 <span class="summary-type"> </span>
156 </td><td class="summary">
157 <table width="100%" cellpadding="0" cellspacing="0" border="0">
159 <td><span class="summary-sig"><a name="_fill_form"></a><span class="summary-sig-name">_fill_form</span>(<span class="summary-sig-arg">el</span>,
160 <span class="summary-sig-arg">values</span>)</span></td>
161 <td align="right" valign="top">
162 <span class="codelink"><a href="lxml.html.formfill-pysrc.html#_fill_form">source code</a></span>
171 <td width="15%" align="right" valign="top" class="summary">
172 <span class="summary-type"> </span>
173 </td><td class="summary">
174 <table width="100%" cellpadding="0" cellspacing="0" border="0">
176 <td><span class="summary-sig"><a name="_takes_multiple"></a><span class="summary-sig-name">_takes_multiple</span>(<span class="summary-sig-arg">input</span>)</span></td>
177 <td align="right" valign="top">
178 <span class="codelink"><a href="lxml.html.formfill-pysrc.html#_takes_multiple">source code</a></span>
187 <td width="15%" align="right" valign="top" class="summary">
188 <span class="summary-type"> </span>
189 </td><td class="summary">
190 <table width="100%" cellpadding="0" cellspacing="0" border="0">
192 <td><span class="summary-sig"><a name="_fill_multiple"></a><span class="summary-sig-name">_fill_multiple</span>(<span class="summary-sig-arg">input</span>,
193 <span class="summary-sig-arg">value</span>)</span></td>
194 <td align="right" valign="top">
195 <span class="codelink"><a href="lxml.html.formfill-pysrc.html#_fill_multiple">source code</a></span>
204 <td width="15%" align="right" valign="top" class="summary">
205 <span class="summary-type"> </span>
206 </td><td class="summary">
207 <table width="100%" cellpadding="0" cellspacing="0" border="0">
209 <td><span class="summary-sig"><a name="_check"></a><span class="summary-sig-name">_check</span>(<span class="summary-sig-arg">el</span>,
210 <span class="summary-sig-arg">check</span>)</span></td>
211 <td align="right" valign="top">
212 <span class="codelink"><a href="lxml.html.formfill-pysrc.html#_check">source code</a></span>
221 <td width="15%" align="right" valign="top" class="summary">
222 <span class="summary-type"> </span>
223 </td><td class="summary">
224 <table width="100%" cellpadding="0" cellspacing="0" border="0">
226 <td><span class="summary-sig"><a name="_select"></a><span class="summary-sig-name">_select</span>(<span class="summary-sig-arg">el</span>,
227 <span class="summary-sig-arg">select</span>)</span></td>
228 <td align="right" valign="top">
229 <span class="codelink"><a href="lxml.html.formfill-pysrc.html#_select">source code</a></span>
238 <td width="15%" align="right" valign="top" class="summary">
239 <span class="summary-type"> </span>
240 </td><td class="summary">
241 <table width="100%" cellpadding="0" cellspacing="0" border="0">
243 <td><span class="summary-sig"><a name="_fill_single"></a><span class="summary-sig-name">_fill_single</span>(<span class="summary-sig-arg">input</span>,
244 <span class="summary-sig-arg">value</span>)</span></td>
245 <td align="right" valign="top">
246 <span class="codelink"><a href="lxml.html.formfill-pysrc.html#_fill_single">source code</a></span>
255 <td width="15%" align="right" valign="top" class="summary">
256 <span class="summary-type"> </span>
257 </td><td class="summary">
258 <table width="100%" cellpadding="0" cellspacing="0" border="0">
260 <td><span class="summary-sig"><a name="_find_form"></a><span class="summary-sig-name">_find_form</span>(<span class="summary-sig-arg">el</span>,
261 <span class="summary-sig-arg">form_id</span>=<span class="summary-sig-default">None</span>,
262 <span class="summary-sig-arg">form_index</span>=<span class="summary-sig-default">None</span>)</span></td>
263 <td align="right" valign="top">
264 <span class="codelink"><a href="lxml.html.formfill-pysrc.html#_find_form">source code</a></span>
273 <td width="15%" align="right" valign="top" class="summary">
274 <span class="summary-type"> </span>
275 </td><td class="summary">
276 <table width="100%" cellpadding="0" cellspacing="0" border="0">
278 <td><span class="summary-sig"><a name="_find_form_ids"></a><span class="summary-sig-name">_find_form_ids</span>(<span class="summary-sig-arg">el</span>)</span></td>
279 <td align="right" valign="top">
280 <span class="codelink"><a href="lxml.html.formfill-pysrc.html#_find_form_ids">source code</a></span>
289 <td width="15%" align="right" valign="top" class="summary">
290 <span class="summary-type"> </span>
291 </td><td class="summary">
292 <table width="100%" cellpadding="0" cellspacing="0" border="0">
294 <td><span class="summary-sig"><a name="insert_errors"></a><span class="summary-sig-name">insert_errors</span>(<span class="summary-sig-arg">el</span>,
295 <span class="summary-sig-arg">errors</span>,
296 <span class="summary-sig-arg">form_id</span>=<span class="summary-sig-default">None</span>,
297 <span class="summary-sig-arg">form_index</span>=<span class="summary-sig-default">None</span>,
298 <span class="summary-sig-arg">error_class</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">error</code><code class="variable-quote">'</code></span>,
299 <span class="summary-sig-arg">error_creator</span>=<span class="summary-sig-default">default_error_creator</span>)</span></td>
300 <td align="right" valign="top">
301 <span class="codelink"><a href="lxml.html.formfill-pysrc.html#insert_errors">source code</a></span>
310 <td width="15%" align="right" valign="top" class="summary">
311 <span class="summary-type"> </span>
312 </td><td class="summary">
313 <table width="100%" cellpadding="0" cellspacing="0" border="0">
315 <td><span class="summary-sig"><a name="insert_errors_html"></a><span class="summary-sig-name">insert_errors_html</span>(<span class="summary-sig-arg">html</span>,
316 <span class="summary-sig-arg">values</span>,
317 <span class="summary-sig-arg">**kw</span>)</span></td>
318 <td align="right" valign="top">
319 <span class="codelink"><a href="lxml.html.formfill-pysrc.html#insert_errors_html">source code</a></span>
328 <td width="15%" align="right" valign="top" class="summary">
329 <span class="summary-type"> </span>
330 </td><td class="summary">
331 <table width="100%" cellpadding="0" cellspacing="0" border="0">
333 <td><span class="summary-sig"><a name="_insert_error"></a><span class="summary-sig-name">_insert_error</span>(<span class="summary-sig-arg">el</span>,
334 <span class="summary-sig-arg">error</span>,
335 <span class="summary-sig-arg">error_class</span>,
336 <span class="summary-sig-arg">error_creator</span>)</span></td>
337 <td align="right" valign="top">
338 <span class="codelink"><a href="lxml.html.formfill-pysrc.html#_insert_error">source code</a></span>
347 <td width="15%" align="right" valign="top" class="summary">
348 <span class="summary-type"> </span>
349 </td><td class="summary">
350 <table width="100%" cellpadding="0" cellspacing="0" border="0">
352 <td><span class="summary-sig"><a name="_add_class"></a><span class="summary-sig-name">_add_class</span>(<span class="summary-sig-arg">el</span>,
353 <span class="summary-sig-arg">class_name</span>)</span></td>
354 <td align="right" valign="top">
355 <span class="codelink"><a href="lxml.html.formfill-pysrc.html#_add_class">source code</a></span>
364 <td width="15%" align="right" valign="top" class="summary">
365 <span class="summary-type"> </span>
366 </td><td class="summary">
367 <table width="100%" cellpadding="0" cellspacing="0" border="0">
369 <td><span class="summary-sig"><a name="_find_elements_for_name"></a><span class="summary-sig-name">_find_elements_for_name</span>(<span class="summary-sig-arg">form</span>,
370 <span class="summary-sig-arg">name</span>,
371 <span class="summary-sig-arg">error</span>)</span></td>
372 <td align="right" valign="top">
373 <span class="codelink"><a href="lxml.html.formfill-pysrc.html#_find_elements_for_name">source code</a></span>
382 <!-- ==================== VARIABLES ==================== -->
383 <a name="section-Variables"></a>
384 <table class="summary" border="1" cellpadding="3"
385 cellspacing="0" width="100%" bgcolor="white">
386 <tr bgcolor="#70b0f0" class="table-header">
387 <td colspan="2" class="table-header">
388 <table border="0" cellpadding="0" cellspacing="0" width="100%">
390 <td align="left"><span class="table-header">Variables</span></td>
391 <td align="right" valign="top"
392 ><span class="options">[<a href="#section-Variables"
393 class="privatelink" onclick="toggle_private();"
394 >hide private</a>]</span></td>
400 <td width="15%" align="right" valign="top" class="summary">
401 <span class="summary-type"> </span>
402 </td><td class="summary">
403 <a href="lxml.html.formfill-module.html#_form_name_xpath" class="summary-name" onclick="show_private();">_form_name_xpath</a> = <code title="descendant-or-self::form[name=$name]|descendant-or-self::x:form[name=$\
404 name]">descendant-or-self::form[name=$name]|descen<code class="variable-ellipsis">...</code></code>
408 <td width="15%" align="right" valign="top" class="summary">
409 <span class="summary-type"> </span>
410 </td><td class="summary">
411 <a href="lxml.html.formfill-module.html#_input_xpath" class="summary-name" onclick="show_private();">_input_xpath</a> = <code title="descendant-or-self::input|descendant-or-self::select|descendant-or-sel\
412 f::textarea|descendant-or-self::x:input|descendant-or-self::x:select|d\
413 escendant-or-self::x:textarea">descendant-or-self::input|descendant-or-self::s<code class="variable-ellipsis">...</code></code>
417 <td width="15%" align="right" valign="top" class="summary">
418 <span class="summary-type"> </span>
419 </td><td class="summary">
420 <a name="_label_for_xpath"></a><span class="summary-name">_label_for_xpath</span> = <code title="//label[@for=$for_id]|//x:label[@for=$for_id]">//label[@for=$for_id]|//x:label[@for=$for_id]</code>
424 <td width="15%" align="right" valign="top" class="summary">
425 <span class="summary-type"> </span>
426 </td><td class="summary">
427 <a name="_name_xpath"></a><span class="summary-name">_name_xpath</span> = <code title="descendant-or-self::*[@name=$name]">descendant-or-self::*[@name=$name]</code>
431 <td width="15%" align="right" valign="top" class="summary">
432 <span class="summary-type"> </span>
433 </td><td class="summary">
434 <a name="default_error_creator"></a><span class="summary-name">default_error_creator</span> = <code title="default_error_creator">default_error_creator</code>
438 <td width="15%" align="right" valign="top" class="summary">
439 <span class="summary-type"> </span>
440 </td><td class="summary">
441 <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'lxml.html'"><code class="variable-quote">'</code><code class="variable-string">lxml.html</code><code class="variable-quote">'</code></code>
445 <td width="15%" align="right" valign="top" class="summary">
446 <span class="summary-type"> </span>
447 </td><td class="summary">
448 <a name="_tag"></a><span class="summary-name">_tag</span> = <code title="'x:textarea'"><code class="variable-quote">'</code><code class="variable-string">x:textarea</code><code class="variable-quote">'</code></code>
452 <!-- ==================== VARIABLES DETAILS ==================== -->
453 <a name="section-VariablesDetails"></a>
454 <table class="details" border="1" cellpadding="3"
455 cellspacing="0" width="100%" bgcolor="white">
456 <tr bgcolor="#70b0f0" class="table-header">
457 <td colspan="2" class="table-header">
458 <table border="0" cellpadding="0" cellspacing="0" width="100%">
460 <td align="left"><span class="table-header">Variables Details</span></td>
461 <td align="right" valign="top"
462 ><span class="options">[<a href="#section-VariablesDetails"
463 class="privatelink" onclick="toggle_private();"
464 >hide private</a>]</span></td>
470 <a name="_form_name_xpath"></a>
471 <div class="private">
472 <table class="details" border="1" cellpadding="3"
473 cellspacing="0" width="100%" bgcolor="white">
475 <h3 class="epydoc">_form_name_xpath</h3>
481 <dd><table><tr><td><pre class="variable">
482 descendant-or-self::form[name=$name]|descendant-or-self::x:form[name=$<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
484 </pre></td></tr></table>
489 <a name="_input_xpath"></a>
490 <div class="private">
491 <table class="details" border="1" cellpadding="3"
492 cellspacing="0" width="100%" bgcolor="white">
494 <h3 class="epydoc">_input_xpath</h3>
500 <dd><table><tr><td><pre class="variable">
501 descendant-or-self::input|descendant-or-self::select|descendant-or-sel<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
502 f::textarea|descendant-or-self::x:input|descendant-or-self::x:select|d<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
503 escendant-or-self::x:textarea
504 </pre></td></tr></table>
510 <!-- ==================== NAVIGATION BAR ==================== -->
511 <table class="navbar" border="0" width="100%" cellpadding="0"
512 bgcolor="#a0c0ff" cellspacing="0">
515 <th> <a
516 href="lxml-module.html">Home</a> </th>
519 <th> <a
520 href="module-tree.html">Trees</a> </th>
523 <th> <a
524 href="identifier-index.html">Indices</a> </th>
527 <th> <a
528 href="help.html">Help</a> </th>
530 <!-- Project homepage -->
531 <th class="navbar" align="right" width="100%">
532 <table border="0" cellpadding="0" cellspacing="0">
533 <tr><th class="navbar" align="center"
534 ><a class="navbar" target="_top" href="/">lxml API</a></th>
538 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
540 <td align="left" class="footer">
541 Generated by Epydoc 3.0.1 on Tue Jul 31 10:14:17 2012
543 <td align="right" class="footer">
544 <a target="mainFrame" href="http://epydoc.sourceforge.net"
545 >http://epydoc.sourceforge.net</a>
550 <script type="text/javascript">
552 // Private objects are initially displayed (because if
553 // javascript is turned off then we want them to be
554 // visible); but by default, we want to hide them. So hide
555 // them unless we have a cookie that says to show them.