openstack
/
deb-python-falcon
Code Issues Proposed changes

doc(FAQ): How to access form params (#1045)

This commit is contained in:
Kurt Griffiths 2017-05-08 08:55:45 -06:00 committed by John Vrbanac
parent 67ca1ad679
commit 403170fbb4
1 changed files with 16 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/user/faq.rst
View File

@ -176,7 +176,20 @@ attribute. For example:
api.req_options.keep_blank_qs_values = True
How can I access POSTed form params?
------------------------------------
By default, Falcon does not consume request bodies. However, setting
the :attr:`~RequestOptions.auto_parse_form_urlencoded` to ``True``
will cause the framework to consume the request body when the
content type is `application/x-www-form-urlencoded`, making
the form parameters accessible via :attr:`~.Request.params`,
:meth:`~.Request.get_param`, etc.
.. If Falcon is designed for building web APIs, why does it support forms?
.. ----
.. Doesn't support files, allows same code to handle both...
.. code:: python
api.req_options.auto_parse_form_urlencoded = True
Alternatively, POSTed form parameters may be read directly from
:attr:`~.Request.stream` and parsed via
:meth:`falcon.uri.parse_query_string` or
`urllib.parse.parse_qs() <https://docs.python.org/3.6/library/urllib.parse.html#urllib.parse.parse_qs>`_.