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

Issue #21454: Fix asyncio.BaseEventLoop.connect_read_pipe doc 

The function sets the the pipe to non-blocking mode.
This commit is contained in:
Victor Stinner 2014-05-29 00:14:03 +02:00
parent 28d0ae48e9
commit a5b257af22
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Doc/library/asyncio-eventloop.rst
View File

@ -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>`.

6
Lib/asyncio/events.py
View File

@ -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