summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVictor Stinner <victor.stinner@gmail.com>2014-05-28 22:14:03 (GMT)
committerVictor Stinner <victor.stinner@gmail.com>2014-05-28 22:14:03 (GMT)
commita5b257af22976b9fdeb1907f8d0c50ef9b97facb (patch)
treed22202ffa7107e37b0347832b149eb9e95e5de34
parent28d0ae48e91bc08062b6c996b79fb148b8cf0303 (diff)
downloadcpython-a5b257af22976b9fdeb1907f8d0c50ef9b97facb.zip
cpython-a5b257af22976b9fdeb1907f8d0c50ef9b97facb.tar.gz
cpython-a5b257af22976b9fdeb1907f8d0c50ef9b97facb.tar.bz2
Issue #21454: Fix asyncio.BaseEventLoop.connect_read_pipe doc
The function sets the the pipe to non-blocking mode.
-rw-r--r--Doc/library/asyncio-eventloop.rst6
-rw-r--r--Lib/asyncio/events.py6
2 files changed, 6 insertions, 6 deletions
diff --git a/Doc/library/asyncio-eventloop.rst b/Doc/library/asyncio-eventloop.rst
index 835266f..b961260 100644
--- a/Doc/library/asyncio-eventloop.rst
+++ b/Doc/library/asyncio-eventloop.rst
@@ -455,11 +455,11 @@ Connect pipes
.. method:: BaseEventLoop.connect_read_pipe(protocol_factory, pipe)
- Register read pipe in eventloop.
+ Register read pipe in eventloop. Set the *pipe* to non-blocking mode.
*protocol_factory* should instantiate object with :class:`Protocol`
- interface. pipe is file-like object already switched to nonblocking.
- Return pair (transport, protocol), where transport support
+ interface. *pipe* is a :term:`file-like object <file object>`.
+ Return pair ``(transport, protocol)``, where *transport* supports the
:class:`ReadTransport` interface.
This method is a :ref:`coroutine <coroutine>`.
diff --git a/Lib/asyncio/events.py b/Lib/asyncio/events.py
index 31592d1..f0ad568 100644
--- a/Lib/asyncio/events.py
+++ b/Lib/asyncio/events.py
@@ -257,11 +257,11 @@ class AbstractEventLoop:
# Pipes and subprocesses.
def connect_read_pipe(self, protocol_factory, pipe):
- """Register read pipe in event loop.
+ """Register read pipe in event loop. Set the pipe to non-blocking mode.
protocol_factory should instantiate object with Protocol interface.
- pipe is file-like object already switched to nonblocking.
- Return pair (transport, protocol), where transport support
+ pipe is a file-like object.
+ Return pair (transport, protocol), where transport supports the
ReadTransport interface."""
# The reason to accept file-like object instead of just file descriptor
# is: we need to own pipe and close it at transport finishing