New doc: clickdata in Formrequest.from_response

Documentation about:
 * clickdata parameter in Formrequest.from_response
 * nr attribute in clickdata dict
 * default behaviour when clickdata is None
This commit is contained in:
Julia Medina 2014-03-12 06:43:50 -03:00
parent 5bbc20f5dd
commit e29ab4d112
1 changed files with 8 additions and 1 deletions

View File

@ -266,7 +266,7 @@ fields with form data from :class:`Response` objects.
The :class:`FormRequest` objects support the following class method in
addition to the standard :class:`Request` methods:
.. classmethod:: FormRequest.from_response(response, [formname=None, formnumber=0, formdata=None, formxpath=None, dont_click=False, ...])
.. classmethod:: FormRequest.from_response(response, [formname=None, formnumber=0, formdata=None, formxpath=None, clickdata=None, dont_click=False, ...])
Returns a new :class:`FormRequest` object with its form field values
pre-populated with those found in the HTML ``<form>`` element contained
@ -303,6 +303,13 @@ fields with form data from :class:`Response` objects.
overridden by the one passed in this parameter.
:type formdata: dict
:param clickdata: attributes to lookup the control clicked. If it's not
given, the form data will be submitted simulating a click on the
first clickable element. In addition to xml attributes, the control
can be identified by its index relative to other submittable inputs
inside the form, via the ``nr`` attribute.
:type clickdata: dict
:param dont_click: If True, the form data will be submitted without
clicking in any element.
:type dont_click: boolean