From: Yury Selivanov Date: Mon, 11 May 2015 20:28:27 +0000 (-0400) Subject: docs/asyncio: Document set_task_factory/get_task_factory X-Git-Tag: v3.5.0b1~205^2~1 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=71854618973f112b54a620cc565cf0bda8e1508a;p=thirdparty%2FPython%2Fcpython.git docs/asyncio: Document set_task_factory/get_task_factory --- diff --git a/Doc/library/asyncio-eventloop.rst b/Doc/library/asyncio-eventloop.rst index d27eb4bd8289..e1a9da14098b 100644 --- a/Doc/library/asyncio-eventloop.rst +++ b/Doc/library/asyncio-eventloop.rst @@ -181,6 +181,26 @@ Coroutines .. versionadded:: 3.4.2 +.. method:: BaseEventLoop.set_task_factory(factory) + + Set a task factory that will be used by + :meth:`BaseEventLoop.create_task`. + + If *factory* is ``None`` the default task factory will be set. + + If *factory* is a *callable*, it should have a signature matching + ``(loop, coro)``, where *loop* will be a reference to the active + event loop, *coro* will be a coroutine object. The callable + must return an :class:`asyncio.Future` compatible object. + + .. versionadded:: 3.4.4 + +.. method:: BaseEventLoop.get_task_factory() + + Return a task factory, or ``None`` if the default one is in use. + + .. versionadded:: 3.4.4 + Creating connections --------------------