Kaydet (Commit) 4270a24d authored tarafından Victor Stinner's avatar Victor Stinner

asyncio doc: document BaseSubprocessTransport.close() method

Modify also the get_pipe_transport() doc to mention explicitly the supported
file descriptors.
üst e6f8c502
...@@ -207,10 +207,15 @@ BaseSubprocessTransport ...@@ -207,10 +207,15 @@ BaseSubprocessTransport
.. method:: get_pipe_transport(fd) .. method:: get_pipe_transport(fd)
Return the transport for the communication pipe corresponding to the Return the transport for the communication pipe corresponding to the
integer file descriptor *fd*. The return value can be a readable or integer file descriptor *fd*:
writable streaming transport, depending on the *fd*. If *fd* doesn't
correspond to a pipe belonging to this transport, :const:`None` is * ``0``: readable streaming transport of the standard input (*stdin*),
returned. or :const:`None` if the subprocess was not created with ``stdin=PIPE``
* ``1``: writable streaming transport of the standard output (*stdout*),
or :const:`None` if the subprocess was not created with ``stdout=PIPE``
* ``2``: writable streaming transport of the standard error (*stderr*),
or :const:`None` if the subprocess was not created with ``stderr=PIPE``
* other *fd*: :const:`None`
.. method:: get_returncode() .. method:: get_returncode()
...@@ -239,6 +244,12 @@ BaseSubprocessTransport ...@@ -239,6 +244,12 @@ BaseSubprocessTransport
On Windows, the Windows API function TerminateProcess() is called to On Windows, the Windows API function TerminateProcess() is called to
stop the subprocess. stop the subprocess.
.. method:: close()
Ask the subprocess to stop by calling the :meth:`terminate` method if the
subprocess hasn't returned yet, and close transports of all pipes
(*stdin*, *stdout* and *stderr*).
.. _asyncio-protocol: .. _asyncio-protocol:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment