Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

asyncio: update the doc 

* dev: mention that the logging must be configured at DEBUG level
* streams: drain() has no more a strange return value, it's just
  a standard coroutine
This commit is contained in:
Victor Stinner 2014-08-25 17:04:12 +02:00
parent 8e16351545
commit d71dcbb043
2 changed files with 15 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Doc/library/asyncio-dev.rst
View File

@ -15,7 +15,15 @@ Debug mode of asyncio
--------------------- ---------------------
To enable the debug mode globally, set the environment variable To enable the debug mode globally, set the environment variable
:envvar:`PYTHONASYNCIODEBUG` to ``1``. Examples of effects of the debug mode: :envvar:`PYTHONASYNCIODEBUG` to ``1``. To see debug traces, set the log level
of the :ref:`asyncio logger <asyncio-logger>` to :py:data:`logging.DEBUG`. The
simplest configuration is::
import logging
# ...
logging.basicConfig(level=logging.DEBUG)
Examples of effects of the debug mode:
* Log :ref:`coroutines defined but never "yielded from" * Log :ref:`coroutines defined but never "yielded from"
<asyncio-coroutine-not-scheduled>` <asyncio-coroutine-not-scheduled>`

13
Doc/library/asyncio-stream.rst
View File

@ -172,17 +172,16 @@ StreamWriter
Wait until the write buffer of the underlying transport is flushed. Wait until the write buffer of the underlying transport is flushed.
This method has an unusual return value. The intended use is to write:: The intended use is to write::
w.write(data) w.write(data)
yield from w.drain() yield from w.drain()
When there's nothing to wait for, :meth:`drain()` returns ``()``, and the When the transport buffer is full (the protocol is paused), block until
yield-from continues immediately. When the transport buffer is full (the the buffer is (partially) drained and the protocol is resumed. When there
protocol is paused), :meth:`drain` creates and returns a is nothing to wait for, the yield-from continues immediately.
:class:`Future` and the yield-from will block until
that Future is completed, which will happen when the buffer is This method is a :ref:`coroutine <coroutine>`.
(partially) drained and the protocol is resumed.
.. method:: get_extra_info(name, default=None) .. method:: get_extra_info(name, default=None)