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="str-class.html" class="summary-name" onclick="show_private();">basestring</a><br />
87 str(object='') -> string
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.FormNotFound-class.html" class="summary-name">FormNotFound</a><br />
95 Raised when no form can be found
99 <td width="15%" align="right" valign="top" class="summary">
100 <span class="summary-type"> </span>
101 </td><td class="summary">
102 <a href="lxml.html.formfill.DefaultErrorCreator-class.html" class="summary-name">DefaultErrorCreator</a>
106 <!-- ==================== FUNCTIONS ==================== -->
107 <a name="section-Functions"></a>
108 <table class="summary" border="1" cellpadding="3"
109 cellspacing="0" width="100%" bgcolor="white">
110 <tr bgcolor="#70b0f0" class="table-header">
111 <td colspan="2" class="table-header">
112 <table border="0" cellpadding="0" cellspacing="0" width="100%">
114 <td align="left"><span class="table-header">Functions</span></td>
115 <td align="right" valign="top"
116 ><span class="options">[<a href="#section-Functions"
117 class="privatelink" onclick="toggle_private();"
118 >hide private</a>]</span></td>
124 <td width="15%" align="right" valign="top" class="summary">
125 <span class="summary-type"> </span>
126 </td><td class="summary">
127 <table width="100%" cellpadding="0" cellspacing="0" border="0">
129 <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>,
130 <span class="summary-sig-arg">values</span>,
131 <span class="summary-sig-arg">form_id</span>=<span class="summary-sig-default">None</span>,
132 <span class="summary-sig-arg">form_index</span>=<span class="summary-sig-default">None</span>)</span></td>
133 <td align="right" valign="top">
134 <span class="codelink"><a href="lxml.html.formfill-pysrc.html#fill_form">source code</a></span>
143 <td width="15%" align="right" valign="top" class="summary">
144 <span class="summary-type"> </span>
145 </td><td class="summary">
146 <table width="100%" cellpadding="0" cellspacing="0" border="0">
148 <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>,
149 <span class="summary-sig-arg">values</span>,
150 <span class="summary-sig-arg">form_id</span>=<span class="summary-sig-default">None</span>,
151 <span class="summary-sig-arg">form_index</span>=<span class="summary-sig-default">None</span>)</span></td>
152 <td align="right" valign="top">
153 <span class="codelink"><a href="lxml.html.formfill-pysrc.html#fill_form_html">source code</a></span>
162 <td width="15%" align="right" valign="top" class="summary">
163 <span class="summary-type"> </span>
164 </td><td class="summary">
165 <table width="100%" cellpadding="0" cellspacing="0" border="0">
167 <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>,
168 <span class="summary-sig-arg">values</span>)</span></td>
169 <td align="right" valign="top">
170 <span class="codelink"><a href="lxml.html.formfill-pysrc.html#_fill_form">source code</a></span>
179 <td width="15%" align="right" valign="top" class="summary">
180 <span class="summary-type"> </span>
181 </td><td class="summary">
182 <table width="100%" cellpadding="0" cellspacing="0" border="0">
184 <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>
185 <td align="right" valign="top">
186 <span class="codelink"><a href="lxml.html.formfill-pysrc.html#_takes_multiple">source code</a></span>
195 <td width="15%" align="right" valign="top" class="summary">
196 <span class="summary-type"> </span>
197 </td><td class="summary">
198 <table width="100%" cellpadding="0" cellspacing="0" border="0">
200 <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>,
201 <span class="summary-sig-arg">value</span>)</span></td>
202 <td align="right" valign="top">
203 <span class="codelink"><a href="lxml.html.formfill-pysrc.html#_fill_multiple">source code</a></span>
212 <td width="15%" align="right" valign="top" class="summary">
213 <span class="summary-type"> </span>
214 </td><td class="summary">
215 <table width="100%" cellpadding="0" cellspacing="0" border="0">
217 <td><span class="summary-sig"><a name="_check"></a><span class="summary-sig-name">_check</span>(<span class="summary-sig-arg">el</span>,
218 <span class="summary-sig-arg">check</span>)</span></td>
219 <td align="right" valign="top">
220 <span class="codelink"><a href="lxml.html.formfill-pysrc.html#_check">source code</a></span>
229 <td width="15%" align="right" valign="top" class="summary">
230 <span class="summary-type"> </span>
231 </td><td class="summary">
232 <table width="100%" cellpadding="0" cellspacing="0" border="0">
234 <td><span class="summary-sig"><a name="_select"></a><span class="summary-sig-name">_select</span>(<span class="summary-sig-arg">el</span>,
235 <span class="summary-sig-arg">select</span>)</span></td>
236 <td align="right" valign="top">
237 <span class="codelink"><a href="lxml.html.formfill-pysrc.html#_select">source code</a></span>
246 <td width="15%" align="right" valign="top" class="summary">
247 <span class="summary-type"> </span>
248 </td><td class="summary">
249 <table width="100%" cellpadding="0" cellspacing="0" border="0">
251 <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>,
252 <span class="summary-sig-arg">value</span>)</span></td>
253 <td align="right" valign="top">
254 <span class="codelink"><a href="lxml.html.formfill-pysrc.html#_fill_single">source code</a></span>
263 <td width="15%" align="right" valign="top" class="summary">
264 <span class="summary-type"> </span>
265 </td><td class="summary">
266 <table width="100%" cellpadding="0" cellspacing="0" border="0">
268 <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>,
269 <span class="summary-sig-arg">form_id</span>=<span class="summary-sig-default">None</span>,
270 <span class="summary-sig-arg">form_index</span>=<span class="summary-sig-default">None</span>)</span></td>
271 <td align="right" valign="top">
272 <span class="codelink"><a href="lxml.html.formfill-pysrc.html#_find_form">source code</a></span>
281 <td width="15%" align="right" valign="top" class="summary">
282 <span class="summary-type"> </span>
283 </td><td class="summary">
284 <table width="100%" cellpadding="0" cellspacing="0" border="0">
286 <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>
287 <td align="right" valign="top">
288 <span class="codelink"><a href="lxml.html.formfill-pysrc.html#_find_form_ids">source code</a></span>
297 <td width="15%" align="right" valign="top" class="summary">
298 <span class="summary-type"> </span>
299 </td><td class="summary">
300 <table width="100%" cellpadding="0" cellspacing="0" border="0">
302 <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>,
303 <span class="summary-sig-arg">errors</span>,
304 <span class="summary-sig-arg">form_id</span>=<span class="summary-sig-default">None</span>,
305 <span class="summary-sig-arg">form_index</span>=<span class="summary-sig-default">None</span>,
306 <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>,
307 <span class="summary-sig-arg">error_creator</span>=<span class="summary-sig-default"><lxml.html.formfill.DefaultErrorCreator object></span>)</span></td>
308 <td align="right" valign="top">
309 <span class="codelink"><a href="lxml.html.formfill-pysrc.html#insert_errors">source code</a></span>
318 <td width="15%" align="right" valign="top" class="summary">
319 <span class="summary-type"> </span>
320 </td><td class="summary">
321 <table width="100%" cellpadding="0" cellspacing="0" border="0">
323 <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>,
324 <span class="summary-sig-arg">values</span>,
325 <span class="summary-sig-arg">**kw</span>)</span></td>
326 <td align="right" valign="top">
327 <span class="codelink"><a href="lxml.html.formfill-pysrc.html#insert_errors_html">source code</a></span>
336 <td width="15%" align="right" valign="top" class="summary">
337 <span class="summary-type"> </span>
338 </td><td class="summary">
339 <table width="100%" cellpadding="0" cellspacing="0" border="0">
341 <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>,
342 <span class="summary-sig-arg">error</span>,
343 <span class="summary-sig-arg">error_class</span>,
344 <span class="summary-sig-arg">error_creator</span>)</span></td>
345 <td align="right" valign="top">
346 <span class="codelink"><a href="lxml.html.formfill-pysrc.html#_insert_error">source code</a></span>
355 <td width="15%" align="right" valign="top" class="summary">
356 <span class="summary-type"> </span>
357 </td><td class="summary">
358 <table width="100%" cellpadding="0" cellspacing="0" border="0">
360 <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>,
361 <span class="summary-sig-arg">class_name</span>)</span></td>
362 <td align="right" valign="top">
363 <span class="codelink"><a href="lxml.html.formfill-pysrc.html#_add_class">source code</a></span>
372 <td width="15%" align="right" valign="top" class="summary">
373 <span class="summary-type"> </span>
374 </td><td class="summary">
375 <table width="100%" cellpadding="0" cellspacing="0" border="0">
377 <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>,
378 <span class="summary-sig-arg">name</span>,
379 <span class="summary-sig-arg">error</span>)</span></td>
380 <td align="right" valign="top">
381 <span class="codelink"><a href="lxml.html.formfill-pysrc.html#_find_elements_for_name">source code</a></span>
390 <!-- ==================== VARIABLES ==================== -->
391 <a name="section-Variables"></a>
392 <table class="summary" border="1" cellpadding="3"
393 cellspacing="0" width="100%" bgcolor="white">
394 <tr bgcolor="#70b0f0" class="table-header">
395 <td colspan="2" class="table-header">
396 <table border="0" cellpadding="0" cellspacing="0" width="100%">
398 <td align="left"><span class="table-header">Variables</span></td>
399 <td align="right" valign="top"
400 ><span class="options">[<a href="#section-Variables"
401 class="privatelink" onclick="toggle_private();"
402 >hide private</a>]</span></td>
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#_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=$\
412 name]">descendant-or-self::form[name=$name]|descen<code class="variable-ellipsis">...</code></code>
416 <td width="15%" align="right" valign="top" class="summary">
417 <span class="summary-type"> </span>
418 </td><td class="summary">
419 <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\
420 f::textarea|descendant-or-self::x:input|descendant-or-self::x:select|d\
421 escendant-or-self::x:textarea">descendant-or-self::input|descendant-or-self::s<code class="variable-ellipsis">...</code></code>
425 <td width="15%" align="right" valign="top" class="summary">
426 <span class="summary-type"> </span>
427 </td><td class="summary">
428 <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>
432 <td width="15%" align="right" valign="top" class="summary">
433 <span class="summary-type"> </span>
434 </td><td class="summary">
435 <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>
439 <td width="15%" align="right" valign="top" class="summary">
440 <span class="summary-type"> </span>
441 </td><td class="summary">
442 <a href="lxml.html.formfill-module.html#default_error_creator" class="summary-name" onclick="show_private();">default_error_creator</a> = <code title="<lxml.html.formfill.DefaultErrorCreator object>"><lxml.html.formfill.DefaultErrorCreato<code class="variable-ellipsis">...</code></code>
446 <td width="15%" align="right" valign="top" class="summary">
447 <span class="summary-type"> </span>
448 </td><td class="summary">
449 <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>
453 <td width="15%" align="right" valign="top" class="summary">
454 <span class="summary-type"> </span>
455 </td><td class="summary">
456 <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>
460 <!-- ==================== VARIABLES DETAILS ==================== -->
461 <a name="section-VariablesDetails"></a>
462 <table class="details" border="1" cellpadding="3"
463 cellspacing="0" width="100%" bgcolor="white">
464 <tr bgcolor="#70b0f0" class="table-header">
465 <td colspan="2" class="table-header">
466 <table border="0" cellpadding="0" cellspacing="0" width="100%">
468 <td align="left"><span class="table-header">Variables Details</span></td>
469 <td align="right" valign="top"
470 ><span class="options">[<a href="#section-VariablesDetails"
471 class="privatelink" onclick="toggle_private();"
472 >hide private</a>]</span></td>
478 <a name="_form_name_xpath"></a>
479 <div class="private">
480 <table class="details" border="1" cellpadding="3"
481 cellspacing="0" width="100%" bgcolor="white">
483 <h3 class="epydoc">_form_name_xpath</h3>
489 <dd><table><tr><td><pre class="variable">
490 descendant-or-self::form[name=$name]|descendant-or-self::x:form[name=$<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
492 </pre></td></tr></table>
497 <a name="_input_xpath"></a>
498 <div class="private">
499 <table class="details" border="1" cellpadding="3"
500 cellspacing="0" width="100%" bgcolor="white">
502 <h3 class="epydoc">_input_xpath</h3>
508 <dd><table><tr><td><pre class="variable">
509 descendant-or-self::input|descendant-or-self::select|descendant-or-sel<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
510 f::textarea|descendant-or-self::x:input|descendant-or-self::x:select|d<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
511 escendant-or-self::x:textarea
512 </pre></td></tr></table>
517 <a name="default_error_creator"></a>
518 <div class="private">
519 <table class="details" border="1" cellpadding="3"
520 cellspacing="0" width="100%" bgcolor="white">
522 <h3 class="epydoc">default_error_creator</h3>
528 <dd><table><tr><td><pre class="variable">
529 <lxml.html.formfill.DefaultErrorCreator object>
530 </pre></td></tr></table>
536 <!-- ==================== NAVIGATION BAR ==================== -->
537 <table class="navbar" border="0" width="100%" cellpadding="0"
538 bgcolor="#a0c0ff" cellspacing="0">
541 <th> <a
542 href="lxml-module.html">Home</a> </th>
545 <th> <a
546 href="module-tree.html">Trees</a> </th>
549 <th> <a
550 href="identifier-index.html">Indices</a> </th>
553 <th> <a
554 href="help.html">Help</a> </th>
556 <!-- Project homepage -->
557 <th class="navbar" align="right" width="100%">
558 <table border="0" cellpadding="0" cellspacing="0">
559 <tr><th class="navbar" align="center"
560 ><a class="navbar" target="_top" href="/">lxml API</a></th>
564 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
566 <td align="left" class="footer">
567 Generated by Epydoc 3.0.1
568 on Wed Jan 29 12:26:21 2020
570 <td align="right" class="footer">
571 <a target="mainFrame" href="http://epydoc.sourceforge.net"
572 >http://epydoc.sourceforge.net</a>
577 <script type="text/javascript">
579 // Private objects are initially displayed (because if
580 // javascript is turned off then we want them to be
581 // visible); but by default, we want to hide them. So hide
582 // them unless we have a cookie that says to show them.