diff options
author | Yury Selivanov <yselivanov@sprymix.com> | 2015-05-11 16:28:27 -0400 |
---|---|---|
committer | Yury Selivanov <yselivanov@sprymix.com> | 2015-05-11 16:28:27 -0400 |
commit | 4b1a6256c606200fc4ec644acca6998a1efb3ce0 (patch) | |
tree | 86bc107983cc7b60949e23c9ddd95014f6fb1f72 /Doc/library/asyncio-eventloop.rst | |
parent | 1dd82313ca61ef8deefee378ffea464a2b2aa523 (diff) | |
download | cpython-4b1a6256c606200fc4ec644acca6998a1efb3ce0.tar.gz |
docs/asyncio: Document set_task_factory/get_task_factory
Diffstat (limited to 'Doc/library/asyncio-eventloop.rst')
-rw-r--r-- | Doc/library/asyncio-eventloop.rst | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/Doc/library/asyncio-eventloop.rst b/Doc/library/asyncio-eventloop.rst index d27eb4bd82..e1a9da1409 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 -------------------- |