openstack/deb-python-falcon
Code Issues Proposed changes

doc(testing.client): Document file_wrapper kwarg for simulate_get (#883)

Browse Source 
A developer wishing to test high-performance file transmission may wish
to pass a mock for wsgi.file_wrapper to simulate_get(). This kwarg is
not documented for other simulate_*() functions since they are unlikely
to use it.
This commit is contained in:
Kurt Griffiths
2016-08-31 11:57:16 -06:00
committed by John Vrbanac
parent 4c21a48551
commit 7d6106ba7b
1 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
falcon/testing/client.py
View File

@@ -157,7 +157,9 @@ def simulate_request(app, method='GET', path='/', query_string=None,
it will be encoded as UTF-8 in the request.
file_wrapper (callable): Callable that returns an iterable,
to be used as the value for *wsgi.file_wrapper* in the
environ (default: ``None``).
environ (default: ``None``). This can be used to test
high-performance file transmission when `resp.stream` is
set to a file-like object.
Returns:
:py:class:`~.Result`: The result of the request
@@ -233,6 +235,11 @@ def simulate_get(app, path, **kwargs):
`params`.
headers (dict): Additional headers to include in the request
(default: ``None``)
file_wrapper (callable): Callable that returns an iterable,
to be used as the value for *wsgi.file_wrapper* in the
environ (default: ``None``). This can be used to test
high-performance file transmission when `resp.stream` is
set to a file-like object.
"""
return simulate_request(app, 'GET', path, **kwargs)