gh-91441: Clarify the docs of asyncio.loop.subprocess_exec() (#91442)

Clarify the docs of asyncio.loop.subprocess_exec()

Clarify the documentation of stdin, stdout and stderr arguments of
asyncio.loop.subprocess_exec().

Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
This commit is contained in:
July Tikhonov 2023-04-26 21:57:19 +03:00 committed by GitHub
parent d45225bd66
commit 37e37553b0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 9 deletions

View File

@ -1438,9 +1438,7 @@ async/await code consider using the high-level
* *stdin* can be any of these:
* a file-like object representing a pipe to be connected to the
subprocess's standard input stream using
:meth:`~loop.connect_write_pipe`
* a file-like object
* the :const:`subprocess.PIPE` constant (default) which will create a new
pipe and connect it,
* the value ``None`` which will make the subprocess inherit the file
@ -1450,9 +1448,7 @@ async/await code consider using the high-level
* *stdout* can be any of these:
* a file-like object representing a pipe to be connected to the
subprocess's standard output stream using
:meth:`~loop.connect_write_pipe`
* a file-like object
* the :const:`subprocess.PIPE` constant (default) which will create a new
pipe and connect it,
* the value ``None`` which will make the subprocess inherit the file
@ -1462,9 +1458,7 @@ async/await code consider using the high-level
* *stderr* can be any of these:
* a file-like object representing a pipe to be connected to the
subprocess's standard error stream using
:meth:`~loop.connect_write_pipe`
* a file-like object
* the :const:`subprocess.PIPE` constant (default) which will create a new
pipe and connect it,
* the value ``None`` which will make the subprocess inherit the file
@ -1483,6 +1477,11 @@ async/await code consider using the high-level
as text. :func:`bytes.decode` can be used to convert the bytes returned
from the stream to text.
If a file-like object passed as *stdin*, *stdout* or *stderr* represents a
pipe, then the other side of this pipe should be registered with
:meth:`~loop.connect_write_pipe` or :meth:`~loop.connect_read_pipe` for use
with the event loop.
See the constructor of the :class:`subprocess.Popen` class
for documentation on other arguments.