Rooba
/
tornado
mirror of https://github.com/tornadoweb/tornado.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

testing: Fix incorrect docs for gen_test 

Pointed out in #1154
This commit is contained in:
Ben Darnell 2017-06-11 12:10:19 -04:00
parent 3a25d7a9c3
commit 0e5c9a36f4
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
tornado/testing.py
View File

@ -458,7 +458,7 @@ def gen_test(func=None, timeout=None):
class MyTest(AsyncHTTPTestCase): class MyTest(AsyncHTTPTestCase):
@gen_test @gen_test
def test_something(self): def test_something(self):
response = yield gen.Task(self.fetch('/')) response = yield self.http_client.fetch(self.get_url('/'))
By default, ``@gen_test`` times out after 5 seconds. The timeout may be By default, ``@gen_test`` times out after 5 seconds. The timeout may be
overridden globally with the ``ASYNC_TEST_TIMEOUT`` environment variable, overridden globally with the ``ASYNC_TEST_TIMEOUT`` environment variable,
@ -467,7 +467,11 @@ def gen_test(func=None, timeout=None):
class MyTest(AsyncHTTPTestCase): class MyTest(AsyncHTTPTestCase):
@gen_test(timeout=10) @gen_test(timeout=10)
def test_something_slow(self): def test_something_slow(self):
response = yield gen.Task(self.fetch('/')) response = yield self.http_client.fetch(self.get_url('/'))
Note that ``@gen_test`` is incompatible with `AsyncTestCase.stop`,
`AsyncTestCase.wait`, and `AsyncHTTPTestCase.fetch`. Use ``yield
self.http_client.fetch(self.get_url())`` as shown above instead.
.. versionadded:: 3.1 .. versionadded:: 3.1
The ``timeout`` argument and ``ASYNC_TEST_TIMEOUT`` environment The ``timeout`` argument and ``ASYNC_TEST_TIMEOUT`` environment
@ -476,6 +480,7 @@ def gen_test(func=None, timeout=None):
.. versionchanged:: 4.0 .. versionchanged:: 4.0
The wrapper now passes along ``*args, **kwargs`` so it can be used The wrapper now passes along ``*args, **kwargs`` so it can be used
on functions with arguments. on functions with arguments.
""" """
if timeout is None: if timeout is None:
timeout = get_async_test_timeout() timeout = get_async_test_timeout()