Skip to content

[doc] Make subprocess.wait documentation more precise #98700

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 16, 2023

Conversation

luispedro
Copy link
Contributor

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.

@bedevere-bot bedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Oct 26, 2022
@ghost
Copy link

ghost commented Oct 26, 2022

All commit authors signed the Contributor License Agreement.
CLA signed

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.
@luispedro luispedro force-pushed the better_subprocess_wait_docs branch from 5d8d00a to f2a3313 Compare November 16, 2023 05:08
@gpshead gpshead added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Nov 16, 2023
@gpshead gpshead merged commit 81ab0e8 into python:main Nov 16, 2023
@miss-islington-app
Copy link

Thanks @luispedro for the PR, and @gpshead for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 16, 2023
[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.
(cherry picked from commit 81ab0e8)

Co-authored-by: Luis Pedro Coelho <luis@luispedro.org>
@bedevere-app
Copy link

bedevere-app bot commented Nov 16, 2023

GH-112153 is a backport of this pull request to the 3.12 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 16, 2023
[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.
(cherry picked from commit 81ab0e8)

Co-authored-by: Luis Pedro Coelho <luis@luispedro.org>
@bedevere-app bedevere-app bot removed the needs backport to 3.12 only security fixes label Nov 16, 2023
@bedevere-app
Copy link

bedevere-app bot commented Nov 16, 2023

GH-112154 is a backport of this pull request to the 3.11 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.11 only security fixes label Nov 16, 2023
willingc pushed a commit that referenced this pull request Dec 13, 2023
… (#112154)

[doc] Make subprocess.wait documentation more precise (GH-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.
(cherry picked from commit 81ab0e8)

Co-authored-by: Luis Pedro Coelho <luis@luispedro.org>
serhiy-storchaka pushed a commit that referenced this pull request Dec 25, 2023
… (GH-112153)

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.
(cherry picked from commit 81ab0e8)

Co-authored-by: Luis Pedro Coelho <luis@luispedro.org>
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
[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.
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
[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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants