Repository navigation
Commit 81ab0e8
authored
[doc] Make subprocess.wait documentation more precise (#98700)
[doc] Make subprocess.wait doc more precise
An active loop is only used when the `timeout` parameter is used on
POSIX.
When no timeout is used, the code calls `os.waitpid` internally (which puts
the process on a sleep status). On Windows, the internal Windows API
call accepts a timeout parameter, so that is delegated to the OS.1 parent 985679f commit 81ab0e8
1 file changed
Lines changed: 4 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -791,9 +791,10 @@ Instances of the :class:`Popen` class have the following methods: | |||
| 791 | 791 | ||
| 792 | 792 | .. note:: | |
| 793 | 793 | ||
| 794 | - The function is implemented using a busy loop (non-blocking call and | ||
| 795 | - short sleeps). Use the :mod:`asyncio` module for an asynchronous wait: | ||
| 796 | - see :class:`asyncio.create_subprocess_exec`. | ||
| 794 | + When the ``timeout`` parameter is not ``None``, then (on POSIX) the | ||
| 795 | + function is implemented using a busy loop (non-blocking call and short | ||
| 796 | + sleeps). Use the :mod:`asyncio` module for an asynchronous wait: see | ||
| 797 | + :class:`asyncio.create_subprocess_exec`. | ||
| 797 | 798 | ||
| 798 | 799 | .. versionchanged:: 3.3 | |
| 799 | 800 | *timeout* was added. | |
0 commit comments