Skip to content

gh-128342: Specify timeout unit in subprocess docstrings #128343

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.

Sign up for GitHub

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 3 commits into from
Dec 30, 2024
Merged

gh-128342: Specify timeout unit in subprocess docstrings #128343

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1bb1429
Specify timeout unit in subprocess docstrings
n-l-i Dec 30, 2024
35ef5f7
simplify wording
gpshead Dec 30, 2024
6713cfa
simplify wording
gpshead Dec 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions Lib/subprocess.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -386,7 +386,7 @@ def _text_encoding():

def call(*popenargs, timeout=None, **kwargs):
"""Run command with arguments. Wait for command to complete or
timeout, then return the returncode attribute.
for timeout seconds, then return the returncode attribute.

The arguments are the same as for the Popen constructor. Example:

Expand Down Expand Up @@ -523,8 +523,8 @@ def run(*popenargs,
in the returncode attribute, and output & stderr attributes if those streams
were captured.

If timeout is given, and the process takes too long, a TimeoutExpired
exception will be raised.
If timeout (seconds) is given and the process takes too long,
a TimeoutExpired exception will be raised.

There is an optional argument "input", allowing you to
pass bytes or a string to the subprocess's stdin. If you use this argument
Expand Down
Loading