1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
Form handling
=============
..
>>> from webtest.debugapp import make_debug_app
>>> from webtest.app import TestApp
>>> app = make_debug_app({},
... form='docs/form.html',
... show_form=True)
>>> app = TestApp(app)
Getting a form
--------------
If you have a single html form in your page, just use the ``.form`` attribute:
.. code-block:: python
>>> res = app.get('/form.html')
>>> form = res.form
If you have more then one html form in your page use the ``.forms`` property and
access via the form index:
.. code-block:: python
>>> form = res.forms[0]
Or the form id:
.. code-block:: python
>>> form = res.forms['myform']
You can check form attributes:
.. code-block:: python
>>> print(form.id)
myform
>>> print(form.action)
/form-submit
>>> print(form.method)
POST
Filling a form
--------------
You can fill out and submit forms from your tests. Fields are a dict like
object:
.. code-block:: python
>>> # dict of fields
>>> form.fields.items() #doctest: +SKIP
[(u'text', [<Text name="text">]), ..., (u'submit', [<Submit name="submit">])]
You can check the current value:
.. code-block:: python
>>> print(form['text'].value)
Foo
Then you fill it in fields:
.. code-block:: python
>>> form['text'] = 'Bar'
>>> # When names don't point to a single field:
>>> form.set('text', 'Bar', index=0)
Field types
------------
Input and textarea fields
*************************
.. code-block:: python
>>> print(form['textarea'].value)
Some text
>>> form['textarea'] = 'Some other text'
You can force the value of an hidden field::
>>> form['hidden'].force_value('2')
Select fields
*************
Simple select:
.. code-block:: python
>>> print(form['select'].value)
option2
>>> form['select'] = 'option1'
Select multiple:
.. code-block:: python
>>> print(form['multiple'].value) # doctest: +SKIP
['option2', 'option3']
>>> form['multiple'] = ['option1']
You can select an option by its text with ``.select()``:
.. code-block:: python
>>> form['select'].select(text="Option 2")
>>> print(form['select'].value)
option2
For select multiple use ``.select_multiple()``:
.. code-block:: python
>>> form['multiple'].select_multiple(texts=["Option 1", "Option 2"])
>>> print(form['multiple'].value) # doctest: +SKIP
['option1', 'option2']
Select fields can only be set to valid values (i.e., values in an ``<option>``)
but you can also use ``.force_value()`` to enter values not present in an
option.
.. code-block:: python
>>> form['select'].force_value(['optionX'])
>>> form['multiple'].force_value(['optionX'])
:class:`~webtest.forms.Checkbox`
*********************************
You can check if the checkbox is checked and is value:
.. code-block:: python
>>> print(form['checkbox'].checked)
False
>>> print(form['checkbox'].value)
None
You can change the status with the value::
>>> form['checkbox'] = True
Or with the checked attribute::
>>> form['checkbox'].checked =True
If the checkbox is checked then you'll get the value::
>>> print(form['checkbox'].checked)
True
>>> print(form['checkbox'].value)
checkbox 1
If the checkbox has no value then it will be 'on' if you checked it::
>>> print(form['checkbox2'].value)
None
>>> form['checkbox2'].checked = True
>>> print(form['checkbox2'].value)
on
If there are multiple checkboxes of the same name, you can assign a list to
that name to check all the checkboxes whose value is present in the list::
>>> form['checkboxes'] = ['a', 'c']
>>> print(form.get('checkboxes', index=0).value)
a
>>> print(form.get('checkboxes', index=1).value)
None
>>> print(form.get('checkboxes', index=2).value)
c
Radio
*****
.. code-block:: python
>>> print(form['radio'].value)
Radio 2
>>> form['radio'] = 'Radio 1'
File
****
You can deal with file upload by using the Upload class:
.. code-block:: python
>>> from webtest import Upload
>>> form['file'] = Upload('README.rst')
>>> form['file'] = Upload('README.rst', b'data')
>>> form['file'] = Upload('README.rst', b'data', 'text/x-rst')
Submit a form
--------------
Then you can submit the form:
.. code-block:: python
>>> # Submit with no particular submit button pressed:
>>> res = form.submit()
>>> # Or submit a button:
>>> res = form.submit('submit')
>>> print(res)
Response: 200 OK
Content-Type: text/plain
text=Bar
...
submit=Submit
You can also select a specific submit button by its index:
.. code-block:: python
>>> res = form.submit('submit', index=1)
>>> print(res)
Response: 200 OK
Content-Type: text/plain
...
submit=Submit 2
And you can select it by its value:
.. code-block:: python
>>> res = form.submit('submit', value="Submit 2")
>>> print(res)
Response: 200 OK
Content-Type: text/plain
...
submit=Submit 2
|
