[Python-checkins] cpython (3.4): Issue #22063: Fix asyncio documentation of socket and pipe operations regarding

victor.stinner python-checkins at python.org
Tue Aug 26 01:02:38 CEST 2014


http://hg.python.org/cpython/rev/b94da2b69d13
changeset:   92240:b94da2b69d13
branch:      3.4
parent:      92238:4c0966b7dbe1
user:        Victor Stinner <victor.stinner at gmail.com>
date:        Tue Aug 26 01:01:59 2014 +0200
summary:
  Issue #22063: Fix asyncio documentation of socket and pipe operations regarding
to non-blocking mode. The non-blocking mode does not matter when using a
ProactorEventLoop, only for SelectorEventLoop.

files:
  Doc/library/asyncio-eventloop.rst |  19 ++++++++++++++-----
  1 files changed, 14 insertions(+), 5 deletions(-)


diff --git a/Doc/library/asyncio-eventloop.rst b/Doc/library/asyncio-eventloop.rst
--- a/Doc/library/asyncio-eventloop.rst
+++ b/Doc/library/asyncio-eventloop.rst
@@ -336,7 +336,8 @@
    representing the data received.  The maximum amount of data to be received
    at once is specified by *nbytes*.
 
-   The socket *sock* must be non-blocking.
+   With :class:`SelectorEventLoop` event loop, the socket *sock* must be
+   non-blocking.
 
    This method is a :ref:`coroutine <coroutine>`.
 
@@ -352,7 +353,8 @@
    an exception is raised, and there is no way to determine how much data, if
    any, was successfully processed by the receiving end of the connection.
 
-   The socket *sock* must be non-blocking.
+   With :class:`SelectorEventLoop` event loop, the socket *sock* must be
+   non-blocking.
 
    This method is a :ref:`coroutine <coroutine>`.
 
@@ -370,7 +372,8 @@
    :py:data:`~socket.AF_INET` and :py:data:`~socket.AF_INET6` address families.
    Use :meth:`getaddrinfo` to resolve the hostname asynchronously.
 
-   The socket *sock* must be non-blocking.
+   With :class:`SelectorEventLoop` event loop, the socket *sock* must be
+   non-blocking.
 
    This method is a :ref:`coroutine <coroutine>`.
 
@@ -418,13 +421,16 @@
 
 .. method:: BaseEventLoop.connect_read_pipe(protocol_factory, pipe)
 
-   Register read pipe in eventloop. Set the *pipe* to non-blocking mode.
+   Register read pipe in eventloop.
 
    *protocol_factory* should instantiate object with :class:`Protocol`
    interface.  *pipe* is a :term:`file-like object <file object>`.
    Return pair ``(transport, protocol)``, where *transport* supports the
    :class:`ReadTransport` interface.
 
+   With :class:`SelectorEventLoop` event loop, the *pipe* is set to
+   non-blocking mode.
+
    This method is a :ref:`coroutine <coroutine>`.
 
 .. method:: BaseEventLoop.connect_write_pipe(protocol_factory, pipe)
@@ -432,10 +438,13 @@
    Register write pipe in eventloop.
 
    *protocol_factory* should instantiate object with :class:`BaseProtocol`
-   interface.  Pipe is file-like object already switched to nonblocking.
+   interface. *pipe* is file-like object.
    Return pair (transport, protocol), where transport support
    :class:`WriteTransport` interface.
 
+   With :class:`SelectorEventLoop` event loop, the *pipe* is set to
+   non-blocking mode.
+
    This method is a :ref:`coroutine <coroutine>`.
 
 .. seealso::

-- 
Repository URL: http://hg.python.org/cpython


More information about the Python-checkins mailing list